Das Wissensportal für IT-Professionals. Entdecke die Tiefe und Breite unseres IT-Contents in exklusiven Themenchannels und Magazinmarken.

SIGS DATACOM GmbH

Lindlaustraße 2c, 53842 Troisdorf

Tel: +49 (0)2241/2341-100

kundenservice@sigs-datacom.de

Auszeichnungssprachen in der Softwaredokumentation

Der großen Bedeutung von Softwaredokumentation kann heute mit zeitgemäßeren Umgebungen als Word oder Confluence begegnet werden. Dabei spielen Auszeichnungssprachen eine zentrale Rolle. Dieser Artikel zeigt auf, was vereinfachte Auszeichnungssprachen genau sind, welche Vorteile sie bieten und wie Unternehmen aus der Vielzahl der heute zur Verfügung stehenden Sprachen eine möglichst universell einsetzbare finden. Mit ihr ergeben sich Möglichkeiten, die jedes Unternehmenswiki in den Schatten stellen.

Dokumente in vereinfachten Auszeichnungssprachen lassen sich mit jedem beliebigen Texteditor erstellen und bearbeiten. Ihre schlichte Syntax ist für Mensch und Maschine gleichermaßen gut lesbar. Die Rohdokumente lassen sich wie Programmcode unter Versionsverwaltung stellen, und eine Build-Pipeline kann dann die formatierten Dokumente generieren, verlinken, exportieren und deployen. Ein solches Vorgehen wird gemeinhin als Docs as Code bezeichnet: Dokumentations-„Code“ wird genauso behandelt wie …