Architekturdokumentation Flashcards
Was bringt Dokumentation?
◼Dokumentation ist kein Selbstzweck
◼Zu viel Dokumentation ist unnötiger Ballast („Travel light“)
Eine gute Architekturdokumentation kann helfen, …
◼den Einstieg für neue Teammitglieder erleichtern
◼Entscheidungen nachvollziehbar machen
◼Architektur an Stakeholder, Teammitglieder etc. kommunizieren
◼Hinweise und Vorgaben für Design und Implementierung geben
◼Klarheit beim Erstellen der Architektur bringen
◼Als Grundlage für Architekturbewertung und Reviews dienen
Nenne Qualitätsmerkmale für Architekturdokumentation
◼Aktualität & Korrktheit: keine veralteten Dokumente! Überlegen ob man das Dokument überhaupt benötigt falls Veraltung OK ist
◼Verständlichkeit: versteht der vorgesehene Leserkreis das Dokument?
◼Wartbarkeit: Kann das Dokument leicht angepasst werden? Templates verwenden, Technik und Fachlichkeitauch sprachlich Trennen („als DB verwenden wir Oracle“ statt „beim Zugriff auf Oracle 10g …“)
◼Kompaktheit & Angemessenheit: Vor allem die wesentlichen Fakten vermitteln
◼Strukturiertheit: Die Beschreibungen immer Top-Down aufbauen (auch wenn der Entwurf u.U. Bottom-Uperfolgte)
