Dokumentationsformate
Dokumentationsformate bezeichnet die Formen, in denen technische oder betriebliche Dokumentation erstellt, gespeichert und veröffentlicht wird. Sie umfassen Auszeichnungssprachen, Markup- oder Strukturformate sowie Publishing-Formate, die je nach Zielgruppe und Ausgabemedium eingesetzt werden. Die Wahl eines Formats beeinflusst Struktur, Wiederverwendbarkeit, Lokalisierung, Barrierefreiheit und die Zusammenarbeit von Autorinnen und Autoren sowie Übersetzerinnen.
Zu den gängigsten Kategorien gehören:
- Markup- und Strukturformate wie DocBook, DITA und TEI, die Inhalte in einer strukturierten Hierarchie modellieren, sowie
- API- und Softwaredokumentation, die spezialisierte Formate oder Semantik nutzen, etwa OpenAPI/Swagger, RAML oder strukturierte Kommentarsysteme wie
- Publishing- und Ausgabedateien wie HTML, PDF, ePub oder CHM, die sich für unterschiedliche Vertriebskanäle eignen.
- Daten- und Austauschformate wie XML, JSON oder YAML, die Informationen zwischen Systemen transportieren.
- Wissens- und Help-Formate wie MediaWiki-Markup oder DokuWiki, die in Knowledge Bases verwendet werden.
Für den Praxisgebrauch verbinden viele Organisationen mehrere Formate über Content-Management- oder Dokumentations-Toolchains. Zu den wesentlichen Anforderungen