Praxis

Asciidoctor

Ascii­doc ist eine ver­ein­fachte Aus­zeich­nungs­spra­che, die dazu dient, Texte ein­fach zu schrei­ben und op­tisch an­spre­chend zu ge­stal­ten. Mit dem Ascii­doc­tor kann eine Ascii­doc-Datei für die Ver­öffent­lichung in eine HTML- oder PDF-Datei um­ge­wan­delt wer­den.

Ascii­doc mit Ascii­doc­tor hat folgende Vorteile:

  • Die Syntax ist leicht er­lern­bar.
  • Quell­text ist un­ver­arbei­tet gut les­bar.
  • Ver­sio­nen sind ver­gleich­bar.
  • Dia­gram­me kön­nen ein­ge­bettet wer­den.
  • Viele Edi­toren bie­ten eine Pre­view.

Ascii­doc ist für tech­nische Doku­men­tation gut ge­eig­net. Der Text kann mit je­dem Edi­tor er­stellt wer­den ist auch un­for­matiert gut les­bar. Anders als andere Mark­down-Dia­lek­te gibt es bei Ascii­doc keine Vari­anten mit unter­schied­licher Syn­tax oder beson­deren Fähig­kei­ten. Es gibt nur eine ein­zige Spezi­fi­kation für Ascii­doc.

Durch Er­weiterun­gen von Ascii­doc­tor kön­nen im Text ver­schie­dene Ar­ten von Dia­gram­men ein­gebet­tet wer­den. Mit Plant­UML ste­hen prak­tisch alle Dia­gramm­arten der UML, Gantt-Diagramme, Mind­maps oder Wire­frames zur Ver­fügung.