Fraunhofer-Gesellschaft

Publica

Hier finden Sie wissenschaftliche Publikationen aus den Fraunhofer-Instituten.

View-based software documentation

 
: Bayer, J.

:
:

Stuttgart: Fraunhofer IRB Verlag, 2004, XX, 290 pp. : Ill., Lit.
Zugl.: Kaiserslautern, TU, Diss., 2004
PhD Theses in Experimental Software Engineering, 15
ISBN: 3-8167-6616-1
ISBN: 978-3-8167-6616-2
English
Dissertation
Fraunhofer IESE ()
software documentation; separation of concerns; stakeholder orientation; aspect-oriented approach; experimental software engineering

Abstract
Dokumentation ist ein integraler Bestandteil jedes Software-Systems, die die notwendigen Informationen zur effektiven und erfolgreichen Erstellung, Nutzung und Wartung des Systems enthält. In der heutigen Praxis wird die Dokumentation oft vernachlässigt, was zu Dokumentationen niedriger Qualität führt. Die Qualität einer Software-Dokumentation kann allerdings nur in begrenzten Maße objektiv bestimmt werden; sie ist vielmehr von den Aufgaben abhängig, die durch die Dokumentation unterstützt werden sollen. Darum wird in dieser Dissertation ein sichtenbasierter Ansatz präsentiert und validiert, der die Qualität von Software-Dokumentation dadurch erhöht, dass maßgeschneiderte Dokumente entwickelt werden, die für die verschiedenen Nutzer einer Dokumentation genau die Informationen enthalten, die sie benötigen. Dabei werden software-entwickelnde Organisationen durch ein Qualitätsmodell unterstützt, dass die Qualität existierender Dokumentationen analysiert, sowie durch eine Methode, die, basierend auf existierenden Dokumentationspraktiken, die Dokumentationsqualität systematisch verbessert. Documentation is an integral part of any software system. It contains the information that is necessary to effectively and successfully develop, use, and maintain a software system. In practice, however, the creation of appropriate documentation is largely neglected resulting in documentation of low quality. The quality of software documentation is dependent on the tasks it is used for and can thus only be assessed objectively to a small extent. A view-based approach to software documentation is, therefore, presented and validated in this thesis that improves the quality of software documentation by developing customized documents that provide, for the users of documentation, precisely the information they require. The approach supports software-developing organizations in improving their documentation by providing a quality model to assess the quality of their current documentation and an approach to systematically improve the quality based on the established documentation practices.

: http://publica.fraunhofer.de/documents/N-24226.html