lnu.sePublications
Change search
CiteExportLink to record
Permanent link

Direct link
Cite
Citation style
  • apa
  • ieee
  • modern-language-association-8th-edition
  • vancouver
  • Other style
More styles
Language
  • de-DE
  • en-GB
  • en-US
  • fi-FI
  • nn-NO
  • nn-NB
  • sv-SE
  • Other locale
More languages
Output format
  • html
  • text
  • asciidoc
  • rtf
A Metrics-Based Approach to Technical Documentation Quality
Linnaeus University, Faculty of Science and Engineering, School of Computer Science, Physics and Mathematics. (Software Technology Group)ORCID iD: 0000-0002-0835-823X
Uppsala University, Department of IT. (UPMARC)ORCID iD: 0000-0003-1173-5187
Linnaeus University, Faculty of Science and Engineering, School of Computer Science, Physics and Mathematics. (Software Technology Group)
Linnaeus University, Faculty of Science and Engineering, School of Computer Science, Physics and Mathematics. (Software Technology Group)ORCID iD: 0000-0002-7565-3714
2010 (English)In: Proceedings of the 7th International Conference on Quality of Information and Communications Technology, IEEE, 2010, p. 476-481Conference paper, Published paper (Refereed)
Abstract [en]

Technical documentation is now fully taking the step from stale printedbooklets (or electronic versions of these) to interactive and online versions.This provides opportunities to reconsider how we define and assess the qualityof technical documentation. This paper suggests an approach based on theGoal-Question-Metric paradigm: predefined quality goals are continuously assessedand visualized by the use of metrics. To test this approach, we performtwo experiments. We adopt well known software analysistechniques, e.g., clone detection and test coverage analysis, and assess thequality of two real world documentations, that of a mobile phone and of(parts of) a warship. The experiments show that quality issues can be identifiedand that the approach is promising.Technical documentation is now fully taking the step from stale printedbooklets (or electronic versions of these) to interactive and online versions.This provides opportunities to reconsider how we define and assess the qualityof technical documentation. This paper suggests an approach based on the Goal-Question-Metric paradigm: predefined quality goals are continuously assessedand visualized by the use of metrics. To test this approach, we performtwo experiments. We adopt well known software analysistechniques, e.g., clone detection and test coverage analysis, and assess thequality of two real world documentations, that of a mobile phone and of(parts of) a warship. The experiments show that quality issues can be identifiedand that the approach is promising.

Place, publisher, year, edition, pages
IEEE, 2010. p. 476-481
Keywords [en]
Information quality, Quality assurance, Software metrics, Documentation
National Category
Software Engineering
Research subject
Computer and Information Sciences Computer Science, Computer Science
Identifiers
URN: urn:nbn:se:lnu:diva-6951DOI: 10.1109/QUATIC.2010.88Scopus ID: 2-s2.0-78751549202ISBN: 978-1-4244-8539-0 (print)OAI: oai:DiVA.org:lnu-6951DiVA, id: diva2:332256
Conference
7th International Conference on Quality of Information and Communications Technology, Porto, 29 September-2 October, 2010
Available from: 2010-08-03 Created: 2010-08-03 Last updated: 2019-01-17Bibliographically approved

Open Access in DiVA

No full text in DiVA

Other links

Publisher's full textScopus

Authority records BETA

Wingkvist, AnnaEricsson, MorganLincke, RüdigerLöwe, Welf

Search in DiVA

By author/editor
Wingkvist, AnnaEricsson, MorganLincke, RüdigerLöwe, Welf
By organisation
School of Computer Science, Physics and Mathematics
Software Engineering

Search outside of DiVA

GoogleGoogle Scholar

doi
isbn
urn-nbn

Altmetric score

doi
isbn
urn-nbn
Total: 691 hits
CiteExportLink to record
Permanent link

Direct link
Cite
Citation style
  • apa
  • ieee
  • modern-language-association-8th-edition
  • vancouver
  • Other style
More styles
Language
  • de-DE
  • en-GB
  • en-US
  • fi-FI
  • nn-NO
  • nn-NB
  • sv-SE
  • Other locale
More languages
Output format
  • html
  • text
  • asciidoc
  • rtf