A View-Based Approach for Improving Software Documentation Practices

  • Authors:

  • Joachim Bayer;Dirk Muthig

  • Affiliations:

  • Fraunhofer Institute for Experimental Software Engineering (IESE), Kaiserslautern, Germany;Fraunhofer Institute for Experimental Software Engineering (IESE), Kaiserslautern, Germany

  • Venue:
  • ECBS '06 Proceedings of the 13th Annual IEEE International Symposium and Workshop on Engineering of Computer Based Systems
  • Year:
  • 2006

Quantified Score

Hi-index 0.00

Visualization

Abstract

Documentation is an integral part of a software system. It contains the information that is necessary to effectively and successfully develop, use, and maintain a system. In practice, however, the creation of appropriate documentation is largely neglected. This paper investigates the reasons for this neglect, presents view-based software documentation, our approach to improve the current situation, and reports on empirical evidence in support of the presented approach. Because the quality of documentation depends on its usage, view-based software documentation exploits existing software modeling techniques to provide all users of documentation with the documentation they require for performing their tasks. View-based software documentation has been empirically validated in a series of experiments and case studies that showed that the approach improves the completeness, correctness, and usefulness of produced and maintained documentation. One of the experiments is described here in more detail.