Registrierungspflichtiger Artikel

Verständnis für die Prozesse einer Anwendung schaffen 11 Baustellen der Software-Dokumentation

Von Mirco Lang

Anbieter zum Thema

Gute Software ist der Grundbaustein für den Erfolg – aber Nutzer müssen sie auch verstehen können. Ein kleines Framework für interne Richtlinien, direkt aus der Praxis.

Ein ordentliches Nutzerhandbuch ist erfolgskritisch und die Dokumentation als Projekt durchaus komplex.
Ein ordentliches Nutzerhandbuch ist erfolgskritisch und die Dokumentation als Projekt durchaus komplex.

Dokumentation von Software findet zum einen auf Quellcode-Ebene statt – das ungeliebte Spielfeld von Entwicklern selbst, gerne auch automatisiert. Zum anderen wird auf Produkt-Ebene dokumentiert, um die es hier auch gehen soll – also das gute alte Handbuch, das Manual, die Bedienungsanleitung.

Das Internet birst nur so vor lauter Artikeln mit Ratschlägen und Best Practices rund um die Entwicklung von Software, von etablierten Workflows über ein stabiles Tooling bis hin zu Aspekten der Zusammenarbeit, internen Standards und so weiter. Beim Thema Dokumentation sieht es da schon nicht ganz so umtriebig aus.