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 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

Technische Dokumentation – deswegen ist sie wichtig und so wird sie erstellt

von parson am 20. August 2024

Für Anbieter und Nutzende von technischen Geräten, Prozessen oder Systemen ist Technische Dokumentation unverzichtbar. Doch was versteht man unter Technischer Dokumentation genau? Wann braucht man Technische Dokumentation und wann ist sie sogar vorgeschrieben? Wie können Sie als Hersteller effizient qualitativ hochwertige Technische Dokumentation anbieten? Antworten auf diese Fragen finden Sie in diesem Artikel. mehr...