How software engineers use documentation: the state of the practice
Top Cited Papers
- 3 November 2003
- journal article
- Published by Institute of Electrical and Electronics Engineers (IEEE) in IEEE Software
- Vol. 20 (6), 35-39
- https://doi.org/10.1109/ms.2003.1241364
Abstract
Software engineering is a human task, and as such we must study what software engineers do and think. Understanding the normative practice of software engineering is the first step toward developing realistic solutions to better facilitate the engineering process. We conducted three studies using several data-gathering approaches to elucidate the patterns by which software engineers (SEs) use and update documentation. Our objective is to more accurately comprehend and model documentation use, usefulness, and maintenance, thus enabling better decision making and tool design by developers and project managers. Our results confirm the widely held belief that SEs typically do not update documentation as timely or completely as software process personnel and managers advocate. However, the results also reveal that out-of-date software documentation remains useful in many circumstances.Keywords
This publication has 4 references indexed in Scilit:
- An examination of software engineering work practicesPublished by Association for Computing Machinery (ACM) ,2010
- Practices of software maintenancePublished by Institute of Electrical and Electronics Engineers (IEEE) ,2002
- Studying work practices to assist tool design in software engineeringPublished by Institute of Electrical and Electronics Engineers (IEEE) ,2002
- The relevance of software documentation, tools and technologiesPublished by Association for Computing Machinery (ACM) ,2002