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.
[1]
Timothy Lethbridge,et al.
The relevance of software documentation, tools and technologies: a survey
,
2002,
DocEng '02.
[2]
Janice Singer,et al.
Studying work practices to assist tool design in software engineering
,
1998,
Proceedings. 6th International Workshop on Program Comprehension. IWPC'98 (Cat. No.98TB100242).
[3]
Janice Singer,et al.
An examination of software engineering work practices
,
1997,
CASCON.
[4]
Janice Singer.
Practices of software maintenance
,
1998,
Proceedings. International Conference on Software Maintenance (Cat. No. 98CB36272).
[5]
Andrew Forward,et al.
Software documentation: Building and maintaining artefacts of communication.
,
2002
.