lnu.sePublications
Change search
CiteExportLink to record
Permanent link

Direct link
Cite
Citation style
  • apa
  • harvard1
  • 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 Visualization-based Approach to Present and Assess Technical Documentation Quality
Linnaeus University, Faculty of Science and Engineering, School of Computer Science, Physics and Mathematics.ORCID iD: 0000-0002-0835-823X
Linnaeus University, Faculty of Science and Engineering, School of Computer Science, Physics and Mathematics.ORCID iD: 0000-0003-1173-5187
Linnaeus University, Faculty of Science and Engineering, School of Computer Science, Physics and Mathematics.ORCID iD: 0000-0002-7565-3714
2011 (English)In: Electronic Journal of Information Systems Evaluation, ISSN 1566-6379, E-ISSN 1566-6379, Vol. 14, no 1, 150-159 p.Article in journal (Refereed) Published
Abstract [en]

Technical documentation has moved from printed booklets to electronic versions that need to be updated continuously to match product development and user demands. There is an imminent need to ensure the quality of technical documentation, i.e., information that fol- lows a product.

In order to ensure the quality, it is important to be able to measure it in a constructively way. We approach technical documentation quality from a software quality perspective and rely on automated measurements and analyses. We acknowledge that it is not possible to assess quality attributes such as “ease of understanding” using automated measure- ments. We rely on visualizations as a communication medium between machines and humans, and define a visualization-based quality assess- ment approach for technical documentation.

In order to test our approach, we use it to assess the quality of 3 real- world documentations from a Swedish mobile phone manufacture, a Japanese camera manufacture, and a Swedish warship producer. The study shows that our approach can be used to identify potential quality defects. For example, we tested an unclassified subset of the warship’s technical documentation and found that 49% of it was redundant text clones. We performed the study in collaboration with a Swedish company that is in charge of creating and maintaining the 3 documentations, and they acknowledge that our approach has great potential and that our results proved helpful to them. 

Place, publisher, year, edition, pages
2011. Vol. 14, no 1, 150-159 p.
Keyword [en]
Information Quality, Software Analysis, Software Visualization, Technical Documentation, Visual Analytics
National Category
Computer Science
Research subject
Computer Science, Software Technology
Identifiers
URN: urn:nbn:se:lnu:diva-16416OAI: oai:DiVA.org:lnu-16416DiVA: diva2:470529
Available from: 2011-12-29 Created: 2011-12-29 Last updated: 2017-01-27Bibliographically approved

Open Access in DiVA

No full text

Other links

Fulltext

Search in DiVA

By author/editor
Wingkvist, AnnaEricsson, MorganLöwe, Welf
By organisation
School of Computer Science, Physics and Mathematics
In the same journal
Electronic Journal of Information Systems Evaluation
Computer Science

Search outside of DiVA

GoogleGoogle Scholar

Total: 212 hits
CiteExportLink to record
Permanent link

Direct link
Cite
Citation style
  • apa
  • harvard1
  • 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