FOCUS ON: Linux

Lessons Learned: Dokumentation

Listen Later

Von vielen vernachlässigt, aber sehr wichtig: Dokumentation. Zusammen mit Gina Häußge (Maintainerin des OctoPrint-Projekts) und Tanja Roth (Project Manager Technical Documentation bei SUSE) besprechen wir Arten der Dokumentation, Technical Writing und zahlreiche Tools, die das Pflegen von Dokumentationen erleichtern.

Intro

  • Ginas Webseite: https://foosel.net
  • OctoPrint-Webseite: https://octoprint.org/
  • Gina im OctoPrint-Interview in FOL #88: https://focusonlinux.podigee.io/88-octoprint
  • Tanjas LinkedIn Profil: https://www.linkedin.com/in/tanja-roth/
  • Weitere Profile von Tanja:
    • https://opensource.com/users/taroth
    • https://www.suse.com/c/the-brains-behind-the-books-tanja-roth/
    • https://tcworldconference.tekom.de/conference-program/speakers/speaker/roth-tanja
    • Buchtipp: "Technisches Schreiben", Peter Rechenberg
    • DOCUMENTATION-1256 - How to Write Technical Documentation that Actually Works (SUSECON 2024): https://youtu.be/VgYsPmKXJ_E

      • Tools

      • Sphinx: https://www.sphinx-doc.org/
      • reStructuredText: https://docutils.sourceforge.io/rst.html
      • mkDocs: https://www.mkdocs.org/
      • DocBook: https://docbook.org/
      • AsciiDoc: https://asciidoc.org/
      • DAPS (DocBook Authoring and Publishing Suite): https://github.com/openSUSE/daps
      • Doc-Kit (zum Initialisieren und Aktualisieren von DAPS-basierter Dokumentation): https://github.com/openSUSE/doc-kit
      • Editieren der SUSE-Dokumentation mit dem VSCode Editor:
        • https://github.com/openSUSE/suse-vscode-doc
      • SUSE Vale Styleguide Extension für den VSCode Editor:
        • https://github.com/openSUSE/vscode-suse-vale-styleguide
      • Uyuni-Dokumentation: https://github.com/uyuni-project/uyuni-docs
      • SUSE Dokumentationsportal: https://documentation.suse.com
      • Read the docs: https://about.readthedocs.com/
      • OctoPrint-Dokumentation:
        • https://docs.octoprint.org (page)
        • https://github.com/OctoPrint/docs.octoprint.org (repository inkl. Build Automation)
        • Plausible: https://plausible.io/
        • Matomo: https://matomo.org/
          • ...more
          View all episodesView all episodes
          Download on the App Store
          FOCUS ON: LinuxBy SVA System Vertrieb Alexander GmbH

          More shows like FOCUS ON: Linux

          View all
          Computer und Kommunikation by Deutschlandfunk

          Computer und Kommunikation

          10 Listeners

          Bits und so by Undsoversum GmbH

          Bits und so

          23 Listeners

          Freak Show by Metaebene Personal Media - Tim Pritlove

          Freak Show

          10 Listeners

          Logbuch:Netzpolitik by Metaebene Personal Media - Tim Pritlove

          Logbuch:Netzpolitik

          6 Listeners

          c’t uplink - der IT-Podcast aus Nerdistan by c’t Magazin

          c’t uplink - der IT-Podcast aus Nerdistan

          6 Listeners

          Schleifenquadrat. Der Apple-Podcast von Mac Life. by Mac Life

          Schleifenquadrat. Der Apple-Podcast von Mac Life.

          2 Listeners

          Apfelfunk by Malte Kirchner & Jean-Claude Frick

          Apfelfunk

          9 Listeners

          heiseshow by heise online

          heiseshow

          2 Listeners

          Hotel Matze by Matze Hielscher & Mit Vergnügen

          Hotel Matze

          154 Listeners

          UKW by Metaebene Personal Media - Tim Pritlove

          UKW

          1 Listeners

          kurz informiert by heise online by heise online

          kurz informiert by heise online

          2 Listeners

          Mac & i - der Apple-Podcast by Mac & i

          Mac & i - der Apple-Podcast

          0 Listeners

          GNU/Linux.ch by GNU/Linux.ch

          GNU/Linux.ch

          1 Listeners

          Bit-Rauschen: Der Prozessor-Podcast von c’t by c't Magazin

          Bit-Rauschen: Der Prozessor-Podcast von c’t

          1 Listeners

          Passwort - der Podcast von heise security by Dr. Christopher Kunz, Sylvester Tremmel

          Passwort - der Podcast von heise security

          3 Listeners