Metainformationen zur Seite
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
| — |
methode:wieviel [2016/07/26 16:53] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ====== Wieviel dokumentieren? ====== | ||
| + | |||
| + | Verfechter agiler Methoden betonen oft, dass „gerade genug“ dokumentiert werden sollte, wobei leider offen bleibt, wieviel gerade genug bedeutet. Um diese Maß beurteilen zu können, sollen die nachfolgenden Anregungen helfen: | ||
| + | * **Langlebigkeit**: Prinzipiell sollten möglichst langlebige Informationen festgehalten werden. Informationen bei denen bereits während der Dokumentation fest steht, dass sie sich kurzfristig ändern werden, sollten außen vor gelassen werden oder aber als temporär gültig – ggf. mit Überarbeitungsmarkierung und Erinnerungsdatum versehen – gekennzeichnet werden. | ||
| + | * **Verständlichkeit**: Die Detaillierungstiefe der Dokumentation sollte sich an [[methode:warum|Zweck]] und Verständnislevel der [[methode:wen|Zielgruppe]] orientieren. | ||
| + | * **Vollständigkeit**: Dokumente sollten alles relevante Wissen für künftige Entwickler und Nutzer bereitstellen. | ||
| + | * **Beispiele**: Erläuternde Beispiele helfen komplizierte Dinge besser zu verstehen und sollten bei umfangreicheren Beschreibungen eingebaut werden. | ||
| + | * **Abbildungen**: Abbildungen (z.B. Architekturmodelle als Diagramme) unterstützen ebenfalls das Verständnis und sind oftmals mit weniger Aufwand zu erstellen als ausführliche Beschreibungen. | ||
| + | * **Aggregationen**: Sinnvoll erscheinen außerdem automatische Aggregationen von zusammengehörigen Informationen. | ||
| + | * **Umfang**: Für einige Dokumentationsartefakte gibt es Orientierungshilfen für die Länge von zu dokumentierenden Informationen. Eine Übersicht in der Literatur vorhandener Umfangsbegrenzungen stellt die nachfolgende Tabelle zusammen (ohne Anspruch auf Vollständigkeit). | ||
| + | |||
| + | ^ Dokument ^ Umfangsbegrenzung ^ | ||
| + | | Projekt-/Produktsteckbrief (o.ä.) | Produktüberblick 100 Wörter + Zielstellung 100 Wörter | | ||
| + | | ::: | 5-200Sätze (1 DIN A4-Seite) | | ||
| + | | Architektur-Dokument | 1.000 Wörter | | ||
| + | | Non-functional Product Backlog (o.ä.) | Qualitätsmerkmale in je kurzen (2–3 Sätze) Beschreibungen | | ||
| + | | Unternehmensarchitektur-dokument (o.ä.) | kurze Beschreibung (1-2 Sätze) für jedes Fremdsystem und jeden Benutzertyp sowie Randbedingungen in ein paar kurzen Sätzen. | | ||
| + | |||
| + | |||