R. Plösch, A. Dautovic, M. Saft: The Value of Software Documentation Quality, 14th International Conference on Quality Software, Dallas, USA, October 2-3, 2014, IEEE Computer Society Press 2014, doi:10.1109/QSIC.2014.22

This paper presents the results of a study on software documentation quality in practice. Goal of this study is identifying the current state of software documentation quality and used analysis techniques for determining software documentation quality. Moreover, we aim at finding out, whether there is a demand for a tool-based software documentation quality analysis approach. This approach consists of a documentation quality model and a document checking tool, as proposed in previous work. We developed an online survey and asked about 300 experts to answer it. The survey was completed by 88 experts and the overall results confirm the importance of software documentation quality as well as the need for better tool support. The survey shows that the most important quality attributes with regard to documentation quality are accuracy, clarity, consistency, readability, structuredness, and understandability. Most of these quality attributes are currently covered by our software documentation quality analysis approach; some of them (e.g., accuracy, structuredness) still need more attention, i.e. better support in our quality model and tool.

The Value of Software Documentation Quality