Evaluating the Quality of the Documentation of Open Source Software

被引:1
|
作者
Aversano, Lerina [1 ]
Guardabascio, Daniela [1 ]
Tortorella, Maria [1 ]
机构
[1] Univ Sannio, Dept Engn, Pza Roma 21, Benevento, Italy
关键词
Open Source Software; Software Maintenance; Software Reusability; Software Measurement; Software Metrics; Software Documentation;
D O I
10.5220/0006369403080313
中图分类号
TP31 [计算机软件];
学科分类号
081202 ; 0835 ;
摘要
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.
引用
收藏
页码:308 / 313
页数:6
相关论文
共 50 条
  • [1] Evaluating the Quality of Open Source Software
    Spinellis, Diomidis
    Gousios, Georgios
    Karakoidas, Vassilios
    Louridas, Panagiotis
    Adams, Paul J.
    Samoladas, Ioannis
    Stamelos, Ioannis
    [J]. ELECTRONIC NOTES IN THEORETICAL COMPUTER SCIENCE, 2009, 233 : 5 - 28
  • [2] Open Source Software Documentation Mining for Quality Assessment
    Carvalho, Nuno Ramos
    Simoes, Alberto
    Almeida, Jose Joao
    [J]. ADVANCES IN INFORMATION SYSTEMS AND TECHNOLOGIES, 2013, 206 : 785 - 794
  • [3] Evaluating Software Documentation Quality
    Tang, Henry
    Nadi, Sarah
    [J]. 2023 IEEE/ACM 20TH INTERNATIONAL CONFERENCE ON MINING SOFTWARE REPOSITORIES, MSR, 2023, : 67 - 78
  • [4] A Review of Models for Evaluating Quality in Open Source Software
    Adewumi, Adewole
    Misra, Sanjay
    Omoregbe, Nicholas
    [J]. 2013 INTERNATIONAL CONFERENCE ON ELECTRONIC ENGINEERING AND COMPUTER SCIENCE (EECS 2013), 2013, 4 : 88 - 92
  • [5] DMOSS: Open Source Software Documentation Assessment
    Carvalho, Nuno Ramos
    Simoes, Alberto
    Almeida, Jose Joao
    [J]. COMPUTER SCIENCE AND INFORMATION SYSTEMS, 2014, 11 (04) : 1191 - 1207
  • [6] Evaluating Open Source Software Quality Models against ISO 25010
    Adewumi, Adewole
    Misra, Sanjay
    Omoregbe, Nicholas
    [J]. CIT/IUCC/DASC/PICOM 2015 IEEE INTERNATIONAL CONFERENCE ON COMPUTER AND INFORMATION TECHNOLOGY - UBIQUITOUS COMPUTING AND COMMUNICATIONS - DEPENDABLE, AUTONOMIC AND SECURE COMPUTING - PERVASIVE INTELLIGENCE AND COMPUTING, 2015, : 872 - 877
  • [7] THE DOCUMENTATION OF CULTURAL HERITAGE WITH BIM OPEN SOURCE SOFTWARE
    Logothetis, S.
    Stylianidis, E.
    [J]. PROCEEDINGS OF THE 8TH INTERNATIONAL CONGRESS ON ARCHAEOLOGY, COMPUTER GRAPHICS, CULTURAL HERITAGE AND INNOVATION ( ARQUEOLOGICA 2.0): ADVANCED 3D DOCUMENTATION, MODELLING AND RECONSTRUCTION OF CULTURAL HERITAGE OBJECTS, MONUMENTS AND SITES, 2016, : 291 - 294
  • [8] BIM OPEN SOURCE SOFTWARE (OSS) FOR THE DOCUMENTATION OF CULTURAL HERITAGE
    Logothetis, Sotiris
    Stylianidis, Efstratios
    [J]. VIRTUAL ARCHAEOLOGY REVIEW, 2016, 7 (15): : 28 - 35
  • [9] Open Source Software: Communities and Quality
    Abrahao, Silvia
    Staron, Miroslaw
    Serebrenik, Alexander
    Penzenstadler, Birgit
    Capilla, Rafael
    [J]. IEEE SOFTWARE, 2023, 40 (04) : 96 - 99
  • [10] Achieving quality in open source software
    Aberdour, Mark
    [J]. IEEE SOFTWARE, 2007, 24 (01) : 58 - +