Lessons from trying to develop a robust documentation exemplar

  • Authors:
  • Lynn Robert Carter;Andreas Karatsolis

  • Affiliations:
  • Carnegie Mellon University in Qatar, Doha, Qatar;Carnegie Mellon University in Qatar, Doha, Qatar

  • Venue:
  • Proceedings of the 27th ACM international conference on Design of communication
  • Year:
  • 2009

Quantified Score

Hi-index 0.00

Visualization

Abstract

Software system documentation has been an integral part of the development process since the first efforts to design and implement large and robust systems. However, the focus of this documentation typically has been limited to the production of discrete artifacts, despite the richness of data and genres that surround it. Efforts to develop a robust documentation exemplar - Della - have not been completely successful, mainly because the provided documentation was largely ignored by many students for simpler but less effective alternate designs. This paper will present, in addition to the lessons learned from the Della project, some insights into the direction software system documentation now should be taking in support of large and long-lived systems.