How software engineers use documentation: The state of the practice

被引:186
作者
Lethbridge, TC
Singer, J
Forward, A
机构
[1] Univ Ottawa, Ottawa, ON K1N 6N5, Canada
[2] NRC Inst Informat Technol, Ottawa, ON K1A 0R6, Canada
关键词
D O I
10.1109/MS.2003.1241364
中图分类号
TP31 [计算机软件];
学科分类号
081202 ; 0835 ;
摘要
Three large industrial studies explored how software engineers use and maintain documentation. The studies confirm the widely held belief that most software documentation in a timely manner. the only notable exception is documentation types that are highly structured and easy to maintain, such as test cases and inline comments. The studies also show that out-of-date documentation, especially that containing high-level abstractions, might remain useful.
引用
收藏
页码:35 / +
页数:6
相关论文
共 5 条
[1]  
Forward A., 2002, THESIS U OTTAWA
[2]  
Forward A, 2002, P 2002 ACM S DOC ENG, P26, DOI [DOI 10.1145/585058.585065, 10.1145/585058.585065]
[3]   Practices of software maintenance [J].
Singer, J .
INTERNATIONAL CONFERENCE ON SOFTWARE MAINTENANCE, PROCEEDINGS, 1998, :139-145
[4]   Studying work practices to assist tool design in software engineering [J].
Singer, J ;
Lethbridge, T .
6TH INTERNATIONAL WORKSHOP ON PROGRAM COMPREHENSION (IWPC 98) - PROCEEDINGS, 1998, :173-179
[5]  
SINGER J, 1997, P CASCON 97, P209