Dokumentation auf Knopfdruck

Das leidige Thema der Dokumentationen. Jeder weiß, dass sie sehr wichtig sind, aber kaum jemand hat so richtig Lust daran mitzuarbeiten. Insbesondere unter Entwicklern ist die Haltung stark vertreten, dass Dokumentationen beziehungsweise die Tätigkeit des Dokumentierens lästige Randbeschäftigungen sind.

Ein Disclaimer vorneweg: In diesem Artikel geht es primär um technische Dokumentationen. Also Dokumente, die eher technische Dinge beschreiben und weniger die Nutzersicht, was Aufgabe eines klassischen Handbuchs ist. Wir reden an dieser Stelle also über eine Dokumentation, die zum Beispiel Inhalte zu Technologien, Architekturen, APIs oder ähnliches beinhaltet. Grundsätzlich lässt sich mit den in diesem Artikel beschriebenen Möglichkeiten auch ein Handbuch erstellen, damit der Artikel aber nicht zu komplex und noch umfangreicher wird, klammern wir Handbücher einmal aus.