Docs-as-Code für die Technische Dokumentation

von Uta Lange , Fabian Klopfer , Frank Ralf am 05. Mai 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 (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, 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.

Das könnte Sie auch interessieren

Technische Dokumentation: Erstellung, Anwendung, Qualitätssicherung

von parson am 14. August 2025

In diesem Überblick erfahren Sie, wozu Technische Dokumentation benötigt wird und worauf Sie beim Erstellen von Technischer Dokumentation achten müssen. Welche Systeme und Tools benötigt man für Technische Dokumentation und welche gesetzlichen Anforderungen gibt es? Erfahren Sie außerdem, wie Ihr Unternehmen qualitativ hochwertige Technische Dokumentation effizient erstellen kann. weiterlesen