Ich denke, jeder ist sich darüber bewusst. Demanch sollten wir jede Analyse eines Problemes mit der Erstellung eines Modells beginnen, oder?
Im Rahmen der Vorlesung Hardware/Software-Codesign wurden Modelle für den HS-Codesign Prozess vorgestellt. Auf den ersten Blick fragte ich mich, was mach ich damit. Genauer betrachtet, zeigte sich, dass die Modelle die wesentlichen Eigenschaften/Objekte und deren Beziehungen abbilden, bzw. veranschaulichen.
So hier nun mein Problem: Wie dokumentiere ich Software am besten? Wie bereits erwähnt, wie benötigen ein Modell.
Welche Elemente gibt es in dieser Welt?
1. Sichten: wer liest und wer schreibt die Dokumentation
2. Orte: wo ist die Dokumentation hinterlegt
3. Arten: in welcher Form liegt die Dokumentation vor
zu 1. Objekte der Klasse "Sichten"
Hier kann man verschiedene Rollen betrachten:
- Entwickler, der das System schreibt
- Entwickler, der das System weiterentwickeln und warten soll (also ein neues Teammitglied)
- Entwickler, der das System nutzt (API)
- Tester Entwicklung (Teilmenge von "Entwickler, der das System nutzt") (auf API Ebene)
- Tester Blackbox (auf Anwendungsebene)
zu 2. Objekte der Klasse "Ort"
- Quellcode
- Anforderungsspezifikation
- Testfallspezifikation
zu 3. Objekte der Klasse "Art"
- Prosa
- Javadoc
- Namenskonventionen
- Testfall
Nun gilt es, diese Elemente in Beziehung zu setzten.