Metainformationen zur Seite
Für wen dokumentieren?
Die konkrete Ausgestaltung einer Dokumentation richtet sich immer nach der jeweiligen Zielgruppe. Dies betrifft bspw. den Detaillierungsgrad, die Inhalte, die gewählte Sprache. So erscheint relativ logisch, dass sich Source-Code-Dokumentation, Nutzerdokumentation und Management-Dokumente stark unterscheiden. Die nachfolgende Tabelle leitete aus den Zielstellungen aus dem Abschnitt Warum dokumentieren? die jeweils angesprochene Zielgruppe ab.
Ziele | Zielgruppe | Stufe |
---|---|---|
Nachvollziehbarkeit von (Design-) Entscheidungen | Kundenvertreter | 1 |
Interne Wissenssicherung, nicht-funktionale Anforderungen, Nachvollziehbarkeit von (Design-) Entscheidungen | Interne Entwickler | 1 |
Kommunikationsunterstützung vor allem in verteilten Umgebungen, Gesamtbild ermöglichen, Übergaben von der Entwicklung zur Wartung | 2 | |
Verbesserung der Projektergebnisse (Qualität, Kosten, Laufzeit) | 2/3 | |
Wissenstransfer bei Outsourcing | Externe Entwickler | 3 |
Einbeziehung von verteilten Stakeholdern in die Kommunikation | Interne und/oder externe Stakeholder | 3 |