How Documentation Evolves Over Time – IWPSE 2007

by Daniel Schreck, Valentin Dallmeier, Thomas Zimmermann

Good source code documentation, especially of programming interfaces, is essential for using and maintaining software components. In this paper, we present the Quasoledo tool that automatically measures the quality of documentation with respect to completeness, quantity, and readability. We applied our set of metrics to the Eclipse project, and benchmarked against the well-documented Java class library. The result of Quasoledo is a map of documentation quality in Eclipse, showing the best documentation for its core components. Additionally, we looked at the evolution of Eclipse and identified batch updates that caused jumps in documentation quality. For Eclipse, only 32.6% of all changes touched documentation.

Download as PDF.
See also: http://www.softevo.org/

Reference

Daniel Schreck, Valentin Dallmeier, Thomas Zimmermann. How Documentation Evolves Over Time. In Proceedings of the 9th International Workshop on Principles of Software Evolution (IWPSE 2007), Dubrovnik, Croatia, September 2007.

BibTeX Entry

@inproceedings{schreck-iwpse-2007,
    title = "How Documentation Evolves Over Time",
    author = "Daniel Schreck and Valentin Dallmeier and Thomas Zimmermann",
    year = "2007",
    month = "September",
    booktitle = "Proceedings of the 9th International Workshop on Principles of Software Evolution",
    location = "Dubrovnik, Croatia",
}