NDLI: The Value of Software Documentation Quality

Content Provider	IEEE Xplore Digital Library
Author	Plosch, R. Dautovic, A. Saft, M.
Copyright Year	2014
Description	Author affiliation: Bus. Inf. - Software Eng., Johannes Kepler Univ., Linz, Austria (Plosch, R.; Dautovic, A.) \|\| Corp. Technol., Siemens AG, Munich, Germany (Saft, M.)
Abstract	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 understand ability. 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.
Sponsorship	Reliab. Soc.
Starting Page	333
Ending Page	342
File Size	536192
Page Count	10
File Format	PDF
ISSN	15506002
e-ISBN	9781479971985
DOI	10.1109/QSIC.2014.22
Language	English
Publisher	Institute of Electrical and Electronics Engineers, Inc. (IEEE)
Publisher Date	2014-10-02
Publisher Place	USA
Access Restriction	Subscribed
Rights Holder	Institute of Electrical and Electronics Engineers, Inc. (IEEE)
Subject Keyword	Documentation Software IEEE standards ISO standards Maintenance engineering Guidelines automatic evaluation of documentation quality software documentation quality role of quality in documentation
Content Type	Text
Resource Type	Article

Sl.	Authority	Responsibilities	Communication Details
1	Ministry of Education (GoI), Department of Higher Education	Sanctioning Authority	https://www.education.gov.in/ict-initiatives
2	Indian Institute of Technology Kharagpur	Host Institute of the Project: The host institute of the project is responsible for providing infrastructure support and hosting the project	https://www.iitkgp.ac.in
3	National Digital Library of India Office, Indian Institute of Technology Kharagpur	The administrative and infrastructural headquarters of the project	Dr. B. Sutradhar bsutra@ndl.gov.in
4	Project PI / Joint PI	Principal Investigator and Joint Principal Investigators of the project	Dr. B. Sutradhar bsutra@ndl.gov.in Prof. Saswat Chakrabarti will be added soon
5	Website/Portal (Helpdesk)	Queries regarding NDLI and its services	support@ndl.gov.in
6	Contents and Copyright Issues	Queries related to content curation and copyright issues	content@ndl.gov.in
7	National Digital Library of India Club (NDLI Club)	Queries related to NDLI Club formation, support, user awareness program, seminar/symposium, collaboration, social media, promotion, and outreach	clubsupport@ndl.gov.in
8	Digital Preservation Centre (DPC)	Assistance with digitizing and archiving copyright-free printed books	dpc@ndl.gov.in
9	IDR Setup or Support	Queries related to establishment and support of Institutional Digital Repository (IDR) and IDR workshops	idr@ndl.gov.in

Evaluating the assessment method of the software maintenance maturity model

Automatic assessment of software documentation quality

ISO 9001 and Agile Development

A specialisation of the SQuaRE quality model for the evaluation of the software evolution and maintenance activity

Quality models: Role and value in software engineering

Investigation of the Capability of XP to Support the Requirements of ISO 9001 Software Process Certification

ISO standards for software user documentation

Demonstrating the capabilities of IEEE SIMICA standards in support of the DoD ATS Framework in a net-centric maintenance environment

Tool Support for Continuous Quality Assessment

The Value of Software Documentation Quality

Similar Documents

Evaluating the assessment method of the software maintenance maturity model

Automatic assessment of software documentation quality

ISO 9001 and Agile Development

A specialisation of the SQuaRE quality model for the evaluation of the software evolution and maintenance activity

Quality models: Role and value in software engineering

Investigation of the Capability of XP to Support the Requirements of ISO 9001 Software Process Certification

ISO standards for software user documentation

Demonstrating the capabilities of IEEE SIMICA standards in support of the DoD ATS Framework in a net-centric maintenance environment

Tool Support for Continuous Quality Assessment

The Value of Software Documentation Quality