A view-based approach for improving software documentation practices

被引:11
作者
Bayer, Joachim [1 ]
Muthig, Dirk [1 ]
机构
[1] Fraunhofer Inst Expt Software Engn, Fraunhofer Pl 1, D-67663 Kaiserslautern, Germany
来源
13TH ANNUAL IEEE INTERNATIONAL SYMPOSIUM AND WORKSHOP ON ENGINEERING OF COMPUTER BASED SYSTEMS, PROCEEDINGS: MASTERING THE COMPLEXITY OF COMPUTER-BASED SYSTEMS | 2006年
关键词
D O I
10.1109/ECBS.2006.18
中图分类号
TP3 [计算技术、计算机技术];
学科分类号
0812 ;
摘要
Documentation is an integral part of a software system. It contains the information that is necessary to effectively and successfully develop, use, and maintain a system. In practice, however, the creation Of appropriate documentation is largely neglected. This paper investigates the reasons for this neglect, presents view-based software documentation, our approach to improve the current situation, and reports on empirical evidence in support of the presented approach. Because the quality of documentation depends on its usage, view-based software documentation exploits existing software modeling techniques to provide all users of documentation with the documentation they require for performing their tasks. View-based software documentation has been empirically validated in a series of experiments and case studies that showed that the approach improves the completeness, correctness, and usefulness of produced and maintained documentation. One of the experiments is described here in more detail.
引用
收藏
页码:269 / +
页数:2
相关论文
共 23 条
[1]  
Ambler S. W., 2002, AGILE MODELING
[2]  
[Anonymous], 1999, APPL SOFTWARE ARCHIT
[3]  
[Anonymous], 2003, AGILE DOCUMENTATION
[4]  
[Anonymous], 1998, 830 IEEE
[5]  
ATKINSON C, 2001, COMPONENT BASED PROD
[6]  
BARKER TT, 1998, WRITIG SOFTWARE DOCU
[7]   THE TAME PROJECT - TOWARDS IMPROVEMENT-ORIENTED SOFTWARE ENVIRONMENTS [J].
BASILI, VR ;
ROMBACH, HD .
IEEE TRANSACTIONS ON SOFTWARE ENGINEERING, 1988, 14 (06) :758-773
[8]  
BAYER J, 2004, THESIS FRAUNHOFER IR
[9]  
BAYER J, 2001, P 4 INT WORKSH SOFTW
[10]  
BAYER J, 2001, 02401E FRAUNH IESE