Technische Dokumentation mit Asciidoc

Dokumentation mit Asciidoc ist wartungsarm und stressfrei. Die Toolchain ist robust und liefert jedes Ausgabeformat, sei es HTML als auch PDF. Als einfache Formatierungssprache sind alle für ein technisches Dokument benötigten Strukturelemente bereits vordefiniert. Darüber hinaus kann Asciidoc individuell angepasst und erweitert werden.

Was ist Asciidoc?

Asciidoc ist eine vereinfachte Auszeichnungssprache, mit der Dokumente in unterschiedlichen Formaten veröffentlicht werden können. Es wurde als Schnittstelle zum Docbook-Format entwickelt, welches auf XML beruht. Asciidoc ist kompatibel mit Docbook, jedoch weniger sperrig. Es ist wesentlich einfacher zu lesen und zu schreiben als Dokumente im XML-Format.

Was ist Docbook?

Docbook ist ein häufig verwendeter, auf XML beruhender Dokumentstandard, um technische Dokumente zu erstellen. Jedes Strukturelement des Dokuments ist dabei vordefiniert, was eine einheitliche, konsistente Dokumentation gewährleistet. Darüber hinaus besitzt Docbook eine Toolchain um Dokumente in verschiedene Ausgabeformate zu übersetzen.

Warum Asciidoc?

Asciidoc ist einfach. Asciidoc ist Text.

Dokumente in Asciidoc verzichten auf Formatierung, denn Asciidoc ist einfach Text.

Asciidoc ist anwenderfreundlich.

Dokumente in Asciidoc können leichter gelesen und geschrieben werden als etwa in XML verfasste Dokumente.

Asciidoc trennt Text, Layout und Daten.

Dokumente in Asciidoc bleiben stets auf dem aktuellen Stand, denn Tabellen, Listen oder Diagramme können direkt aus den Daten erstellt werden.

Asciidoc ist frei verfügbar und offen zugänglich.

Asciidoc ist eine offene Schnittstelle, die frei verfügbar ist. Dadurch ergeben sich weniger Kompatibilitätprobleme als bei proprietären Formaten.

Asiidoc lässt sich anpassen und erweitern

Asciidoc kann den eigenen Bedürfnissen angepasst und erweitert werden.