Dokumentation Flashcards
Ziele der Dokumentation
“Software besteht nicht nur aus einem oder mehreren Programmen, sondern umfasst auch die Dokumentation.“ Die zielgruppenorientierte Dokumentation aller relevanten Tätigkeiten im Softwareentwicklungsprozess durch das Requirements bzw. Software Engineering ist deshalb von großer Bedeutung, da sie als Grundlage für alle weiteren Aktivitäten und der Nachvollziehbarkeit dient. Es gibt dazu verschiedene Dokumentationsformen.
Zudem ist es das Ziel der Dokumentation, die Arbeitsergebnisse im Software Engineering zu sichern und den relevanten Stakeholder, entsprechend ihren Berechtigungen, zugänglich zu machen
Die Dokumentation sollte systematisch und strukturiert in einem zeitlogischen Kontext erfolgen. Berücksichtigt werden sollte
§ der beabsichtigte konkrete Zweck
§ die Vermeidung von Redundanzen (ggf. mit Verweisen arbeiten) und Inkonsistenzen
§ die konsistente (im Zusammenhang/Widerspruchsfreiheit) Nutzung von Begriffen im Kontext des festgelegten Glossars
§ die Nutzung von Standardstrukturen, z. B. projektspezifischen Vorgaben
Elemente der Dokumentation
§ Systemdokumentationen
§ Benutzerdokumentationen
§ Glossar
Dokumentation von Systemanforderungen
- Ermittlung der Anforderungen
- Spezifikation der Anforderungen
- Validierung der Anforderungen
Welche Dokumentationsformen gibt es?
- Texte und Tabellen
- Skizzen und Grafiken
- Modelle
- GUI-Prototypen
- Mischformen