Fraunhofer-Gesellschaft

Publica

Hier finden Sie wissenschaftliche Publikationen aus den Fraunhofer-Instituten.

Improving software documentation by separating the concerns of documentation consumers

 
: Bayer, J.; Muthig, D.

:
urn:nbn:de:0011-n-212200 (217 KByte PDF)
MD5 Fingerprint: 89972c8b9611eb26e1b718d0f17827c4
Created on: 02.06.2004


Kaiserslautern, 2003, VII, 27 pp. : Ill., Lit.
IESE-Report, 114.03/E
Reportnr.: 114.03/E
English
Report, Electronic Publication
Fraunhofer IESE ()
software documentation; separation of concerns; aspect-oriented approach

Abstract
Documentation is an integral, yet often neglected, part of a software system. It provides information about a software system to a large variety of stakeholders that use the documentation as information source in different tasks including the creation and maintenance of the system or its assessment and usage. Due to the diversity of usage scenarios, the quality of a software documentation can not be assessed objectively, but rather in a subjective, task-dependent way. Furthermore, the different uses of documentation must be understood and taken into account when the quality of software documentation is to be improved.
In this paper, an approach is presented that applies the software engineering principle "separation of concerns" to the documentation of software systems to enable an improvement of the current documentation practices. The first step in the approach is the elicitation of the different documentation consumers with their concerns. Based on the elicited concerns, documents are produced that reflect each consumer's perspective on the software system. The presented view-based approach to software documentation has been validated in a series of experiments and industrial applications that are discussed as well.

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