Usage and usefulness of technical software documentation: An industrial case study

Golara Garousi, Vahid Garousi-Yusifoʇlu*, Guenther Ruhe, Junji Zhi, Mahmoud Moussavi, Brian Smith

*Corresponding author for this work

Research output: Contribution to journalArticlepeer-review

18 Citations (Scopus)
53 Downloads (Pure)

Abstract

Context: Software documentation is an integral part of any software development process. However, software practitioners are often concerned about the value, degree of usage and usefulness of documentation during development and maintenance. Objective: Motivated by the needs of NovAtel Inc. (NovAtel), a world-leading company developing software systems in support of global navigation satellite systems, and based on the results of a former systematic mapping study, we aimed at better understanding of the usage and the usefulness of various technical documents during software development and maintenance. Method: We utilized the results of a former systematic mapping study and performed an industrial case study at NovAtel. From the joint definition of the analysis goals, the research method incorporates qualitative and quantitative analysis of 55 documents (design, test and process related) and 1630 of their revisions. In addition, we conducted a survey on the usage and usefulness of documents. A total of 25 staff members from the industrial partner, all having a medium to high level of experience, participated in the survey. Results: In the context of the case study, a number of findings were derived. They include that (1) technical documentation was consulted least frequently for maintenance purpose and most frequently as an information source for development, (2) source code was considered most frequently as the preferred information source during software maintenance, (3) there is no significant difference between the usage of various documentation types during both development and maintenance, and (4) initial hypotheses stating that up-to-date information, accuracy and preciseness have the highest impact on usefulness of technical documentation. Conclusions: It is concluded that the usage of documentation differs for various purposes and it depends on the type of the information needs as well as the tasks to be completed (e.g., development and maintenance). The results have been confirmed to be helpful for the company under study, and the firm is currently implementing some of the recommendations given.

Original languageEnglish
Pages (from-to)664-682
JournalInformation and Software Technology
Volume57
Issue number1
Early online date28 Aug 2014
DOIs
Publication statusPublished - 01 Jan 2015
Externally publishedYes

Keywords

  • Case study
  • Industrial context
  • Technical software documentation
  • Usage
  • Usefulness

ASJC Scopus subject areas

  • Software
  • Information Systems
  • Computer Science Applications

Fingerprint Dive into the research topics of 'Usage and usefulness of technical software documentation: An industrial case study'. Together they form a unique fingerprint.

Cite this