Objektorientierte Software-Dokumentation

Software-Dokumentation bietet Software-Entwicklern und -Benutzern eine nützliche Beschreibung dessen, was die Software tut, wie sie funktioniert, wie sie gebaut ist und wie sie benutzt werden soll. Ein Benutzerhandbuch zeigt zum Beispiel, wie Benutzer mit einem Softwareprodukt interagieren sollten, während das Designdokument den Entwicklern bei der Entwicklung und Wartung der Software hilft. Die Hauptherausforderung besteht darin, ein automatisiertes Werkzeug zu konstruieren, das bei Bedarf eine dynamische Dokumentation des Software-Quellcodes erstellen kann. Dieses Buch stellt einen automatischen Ansatz vor, der als Al-Msie'deen-Ansatz bezeichnet wird, um Software-Dokumentation für Software-Code bei Bedarf zu erzeugen. Die Neuheit dieses Ansatzes liegt in der Produktion von dynamischer Softwarecode-Dokumentation auf Paket-, Klassen-, Attribut- und Methodenebene. Code-Dokumentation ist ein schriftlicher Text oder illustrierte Diagramme, die Informationen über alle Ebenen der Code-Granularität, von der Paket- bis hinunter zur Methodenebene, darstellen.