Automatic assessment of software documentation quality

Dautovic, Andreas

doi:10.1109/ase.2011.6100151

Cited by 8 publications

(6 citation statements)

References 15 publications

Supporting

Mentioning

Contrasting

Order By: Relevance

“…For this purpose, the work of [5] might serve as a basis for rules that check for best practice in software documents. Another idea is to extend SAQE by using the requirements and techniques of other standards such as IEC 62304 for medical software or EN 50128 for railway applications.…”

Section: Summary Lessons Learned and Future Workmentioning

confidence: 99%

Objective safety compliance checks for source code

Mayr¹,

Plösch²,

Saft

2014

Companion Proceedings of the 36th International Conference on Software Engineering

View full text Add to dashboard Cite

Safety standards such as IEC 61508 are an important instrument for developing safety-critical systems. They provide requirements and recommendations to assist engineers in system and software development. Nevertheless, applying this standard in practice is difficult due to unclear requirements and unclear or missing acceptance criteria. We systematically developed a quality model including proper measurement support that covers the coderelated parts of IEC 61508 in [20]. In this paper, we present the assessment approach for automatic compliance checks of the code-related parts of the standard. We find in a validation study that the assessment results obtained by applying this approach to real-world projects are in line with their externally granted certification. The results are valid for the vast majority of the modeled elements of the standard. Moreover, by drilling down into the assessment results, we are able to detect deficiencies in the certified real-world projects.

show abstract

Section: Summary Lessons Learned and Future Workmentioning

confidence: 99%

Objective safety compliance checks for source code

Mayr¹,

Plösch²,

Saft

2014

Companion Proceedings of the 36th International Conference on Software Engineering

View full text Add to dashboard Cite

show abstract

“…The experience paper [13] reported the in-process inspections of design and development work products at AT&T. Brykczynski reported in 1999 paper [14] a survey of software inspection checklists. Software documentation quality is also another active related field to our work, e.g., works such as [15][16][17][18]. The work in [17] presents a quality monitoring method for the automated quality assessment of software documentation using a document quality analysis framework and a set of quality rules which represent best practices for software documentation.…”

Section: Related Work and Toolsmentioning

confidence: 99%

“…Software documentation quality is also another active related field to our work, e.g., works such as [15][16][17][18]. The work in [17] presents a quality monitoring method for the automated quality assessment of software documentation using a document quality analysis framework and a set of quality rules which represent best practices for software documentation. To shows the value of software documentation quality, [18] conducted a survey software professional and the survey shows that the most important quality attributes with regard to documentation quality are accuracy, clarity, consistency, readability, structuredness, and understandability.…”

Section: Related Work and Toolsmentioning

confidence: 99%

A Tool for Automated Inspection of Software Design Documents and Its Empirical Evaluation in an Aviation Industry Setting

Coşkun

Ceylan

Yigitozu

et al. 2016

2016 IEEE Ninth International Conference on Software Testing, Verification and Validation Workshops (ICSTW)

View full text Add to dashboard Cite

While software inspection is an effective activity to detect defects early in the software development lifecycle, it is an effortintensive and error-prone activity. Motivated by a real need in the context of the Turkish Aerospace Industries Inc. (TAI), a tool named AutoInspect was developed to (semi-) automate the inspection of software design documents and, as a result, to increase the efficiency and effectiveness of the inspection process. We present in this paper the features of the tool, its development details and its initial evaluation for inspecting the design documents of three real systems in the company. The results of the initial case-study reveal that the tool is indeed able to increase the inspections efficiency and effectiveness. In terms of efficiency, inspection engineers who used AutoInspect performed 41-50% more efficiently, for the three design documents under study, compared to the case when the tool was not used (i.e., manual inspections). In terms of effectiveness, compared to manual inspections, the automated approach found between 23-33% more defects in the three design documents under study. As the tool currently only provides partial automation, our efforts are currently underway to increase its automation level even further. Keywords-Software inspections; design verification; automated inspections; industry case study; improving efficiency and effectiveness; Computer-aided software engineering (CASE).

show abstract

“…In [19], the author presented an automated quality assessment approach for software documentation using a developed document quality analysis framework and software document quality rules and principles.…”

Section: Related Workmentioning

confidence: 99%

A Topic Modeling Based Solution for Confirming Software Documentation Quality

Alhindawi¹,

Al-Hazaimeh²,

Malkawi³

et al. 2016

ijacsa

View full text Add to dashboard Cite

Abstract-this paper presents an approach for evaluating and confirming the quality of the external software documentation using topic modeling. Typically, the quality of the external documentation has to mirror precisely the organization of the source code. Therefore, the elements of such documentation should be strongly written, associated, and presented. In this paper, we use Latent Dirichlet Allocation (LDA) and HELLINGER DISTANCE to compute the similarities between the fragments of source code and the external documentation topics. These similarities are used in this paper to improve and advance the existing external documentation. Furthermore, these similarities can also be used for evaluating the new documenting process during the evolution phase of the software. The results show that the new approach yields state-of-the-art performance in evaluating and confirming the existing external documentations quality and superiority.

show abstract

Automatic assessment of software documentation quality

Cited by 8 publications

References 15 publications

Objective safety compliance checks for source code

Objective safety compliance checks for source code

A Tool for Automated Inspection of Software Design Documents and Its Empirical Evaluation in an Aviation Industry Setting

A Topic Modeling Based Solution for Confirming Software Documentation Quality

Contact Info

Product

Resources

About