How software engineers use documentation: The state of the practice

被引:184
|
作者
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
相关论文
共 50 条
  • [1] FORTUNE - A DOCUMENTATION SUPPORT SYSTEM FOR SOFTWARE ENGINEERS
    MULLIN, D
    [J]. LECTURE NOTES IN COMPUTER SCIENCE, 1987, 289 : 387 - 394
  • [2] The state of practice in the use of software metrics
    Jeffery, R
    Zucker, B
    [J]. AUSTRALIAN COMPUTER JOURNAL, 1999, 31 (01): : 9 - 16
  • [3] An overview of industrial software documentation practice
    Visconti, M
    [J]. XXII INTERNATIONAL CONFERENCE OF THE CHILEAN COMPUTER SCIENCE SOCIETY, PROCEEDINGS, 2002, : 179 - 186
  • [4] Software documentation: How much is enough?
    Briand, LC
    [J]. SEVENTH EUROPEAN CONFERENCE ON SOFTWARE MAINTENANCE AND REENGINEERING, PROCEEDINGS, 2003, : 13 - 15
  • [5] Assessing the state of software documentation practices
    Visconti, M
    Cook, CR
    [J]. PRODUCT FOCUSED SOFTWARE PROCESS IMPROVEMENT, 2004, 3009 : 485 - 496
  • [6] Software Architecture Documentation in Practice session report
    Clements, Paul C.
    [J]. 5th Working IEEE/IFIP Conference on Software Architecture, Proceedings, 2006, : 257 - 258
  • [7] HOW ENGINEERS USE COMPUTER
    LAVOIE, FJ
    [J]. MACHINE DESIGN, 1970, 42 (20) : 106 - &
  • [8] How Can Metaheuristics Help Software Engineers?
    Alba, Enrique
    [J]. SEARCH-BASED SOFTWARE ENGINEERING, SSBSE 2018, 2018, 11036 : 89 - 105
  • [9] ON THE USE OF PSYCHOLOGY IN EVALUATING SOFTWARE DOCUMENTATION
    BOEHMDAVIS, DA
    [J]. BEHAVIOR RESEARCH METHODS & INSTRUMENTATION, 1983, 15 (02): : 217 - 221
  • [10] The practice of jurisdictionalizing: How engineers use documents to shape and maintain professional authority
    Meilvang, Marie Leth
    [J]. SOCIOLOGICAL REVIEW, 2020, 68 (01): : 77 - 93