Write a Blog >>
Fri 13 Nov 2020 01:30 - 01:32 at Virtual room 1 - Documentation

Good software documentation encourages good software engineering, but the meaning of "good" documentation is vaguely defined in the software engineering literature. To clarify this ambiguity, we draw on work from the data and information quality community to propose a framework that decomposes documentation quality into ten dimensions of structure, content, and style. To demonstrate its application, we recruited technical editors to apply the framework when evaluating examples from several genres of software documentation. We summarise their assessments – for example, reference documentation and README files excel in quality whereas blog articles have more problems – and we describe our vision for reasoning about software documentation quality and for the expansion and potential of a unified quality framework.

Fri 13 Nov
Times are displayed in time zone: (UTC) Coordinated Universal Time change

01:30 - 01:32
Talk
Visions and Reflections
Christoph TreudeUniversity of Adelaide, Australia, Justin Middleton North Carolina State University, USA, Thushari AtapattuThe University of Adelaide
DOI
01:33 - 01:34
Talk
Journal First
Sebastian Baltes QAware GmbH and The University of Adelaide, Christoph TreudeUniversity of Adelaide, Australia, Martin RobillardMcGill University
Pre-print
01:35 - 01:36
Talk
Tool Demos
Boao LiZhejiang University, China, Meng YanChongqing University, Xin XiaMonash University, Xing HuPeking University, Ge LiPeking University, David LoSingapore Management University
DOI
01:37 - 01:38
Talk
Research Papers
Samim MirhosseiniNorth Carolina State University, USA, Chris ParninNorth Carolina State University, USA
DOI Pre-print
01:39 - 01:40
Talk
Research Papers
Sahar MehrpourGeorge Mason University, USA, Thomas LaTozaGeorge Mason University, USA, Hamed SarvariGeorge Mason University, USA
DOI Pre-print
01:41 - 01:42
Talk
Visions and Reflections
Sridhar ChimalakondaIndian Institute of Technology Tirupati, Akhila Sri Manasa VenigallaIIT Tirupati, India
DOI
01:43 - 02:00
Talk
Paper Presentations
Akhila Sri Manasa Venigalla, Christoph TreudeUniversity of Adelaide, Australia, Sahar MehrpourGeorge Mason University, USA, Samim MirhosseiniNorth Carolina State University, USA, Sridhar ChimalakondaIndian Institute of Technology Tirupati, M: Venera ArnaoudovaWashington State University