Docs-as-Code für die Technische Dokumentation

von Uta Lange , Fabian Klopfer , Frank Ralf am 05. May 2022

Stellen Sie sich vor, Sie schreiben und aktualisieren technische Dokumentation mit den gleichen Werkzeugen, die Softwareentwickler:innen für Quellcode benutzen: einem Texteditor, einer IDE (integrierte Entwicklungsumgebung) und in einem einfachen Textformat.

Klingt utopisch? Ist es aber nicht. Der Docs-as-Code-Ansatz bietet viele Vorteile für Technische Redakteur:innen und Entwickler:innen gleichermaßen, da beide mit den gleichen Tools an den Inhalten arbeiten. Im Wissensartikel erfahren Sie, wie Sie die Inhalte einer Dokumentation mit der Docs-as-Code-Methode erstellen. Wir stellen die drei am häufigsten verwendeten Auszeichnungssprachen Markdown, AsciiDoc und reStructuredText vor und erläutern, wie Sie die Inhalte veröffentlichen.

Lesen Sie den vollständigen Artikel "Docs-as-code for technical documentation" auf Englisch.

Neuen Kommentar hinzufügen

Ihre E-Mail-Adresse wird nicht veröffentlicht.

Das könnte Sie auch interessieren

Neuer Wissensartikel über Docs-as-Code für die Technische Dokumentation

05. May 2022

Docs-as-Code bietet für Technische Redakteur:innen ebenso wie Softwareentwickler:innen viele Vorteile, da beide mit den gleichen Tools und Workflows an Inhalten arbeiten können. In unserem aktuellen Wissensartikel beschäftigen wir uns mit Docs-as-Code zum Erstellen von Technischer Dokumentation. mehr...