Software documentation is a basic component of the software development process: from the definition of the functional requirements to the maintenance phase. Software documentation refers to different types of documents that facilitates the software developer's tasks. Then, it includes the textual documentation required by the Software engineering standards, API documentation, Wiki pages and source code comments. Surveys and studies indicate that the documentation is not always available and, if available, only partially addresses the developers' needs, as it is often wrong, incomplete, out-of-date and ambiguous. This paper focuses on the quality assessment of the documentation of open source systems with the aim of understanding the support it can offer for adopting them and executing maintenance activities. Specifically, a quality model is defined and a preliminary investigation of its applicability is performed.

Evaluating the quality of the documentation of open source software

Aversano, Lerina;Guardabascio, Daniela;Tortorella, Maria
2017-01-01

Abstract

Software documentation is a basic component of the software development process: from the definition of the functional requirements to the maintenance phase. Software documentation refers to different types of documents that facilitates the software developer's tasks. Then, it includes the textual documentation required by the Software engineering standards, API documentation, Wiki pages and source code comments. Surveys and studies indicate that the documentation is not always available and, if available, only partially addresses the developers' needs, as it is often wrong, incomplete, out-of-date and ambiguous. This paper focuses on the quality assessment of the documentation of open source systems with the aim of understanding the support it can offer for adopting them and executing maintenance activities. Specifically, a quality model is defined and a preliminary investigation of its applicability is performed.
2017
9789897582509
Open source software; Software documentation; Software maintenance; Software measurement; Software metrics; Software reusability; Computer Science Applications1707 Computer Vision and Pattern Recognition; Software
File in questo prodotto:
Non ci sono file associati a questo prodotto.

I documenti in IRIS sono protetti da copyright e tutti i diritti sono riservati, salvo diversa indicazione.

Utilizza questo identificativo per citare o creare un link a questo documento: https://hdl.handle.net/20.500.12070/38752
Citazioni
  • ???jsp.display-item.citation.pmc??? ND
  • Scopus 3
  • ???jsp.display-item.citation.isi??? ND
social impact