Technische Dokumentation in der Praxis: Leben und schreiben lassen
Aus Tickets, Quellcode und Expertenwissen entsteht Dokumentation. So läuft der Prozess vom Entwurf bis zur Anleitung.
Ein Handbuch entsteht nicht, indem jemand am Ende eines Projekts alles aufschreibt. Die Informationen liegen verteilt in Tickets, Designentwürfen, Supportanfragen, Quelltexten und im Wissen der Entwickler. Daraus eine vollständige, verständliche und rechtssichere Dokumentation zu erstellen, ist ein eigener Entwicklungsprozess.
In den vorherigen Teilen der Serie ging es darum, warum technische Dokumentation wichtig ist, und wer sie erstellt. Jetzt wird es praktisch: Wir verfolgen Schritt für Schritt, wie aus verstreutem Wissen eine Anleitung oder Onlinehilfe entsteht – von der ersten Planung bis zur Pflege über den gesamten Produktlebenszyklus.