arrow
返回

Using Traceability Links to Recommend Adaptive Changes for Documentation Evolution

delete2014-11-01
delete30
PRE
AI
B
Barthélémy Dagenais *
M
Martin P. Robillard
DOI:10.1109/TSE.2014.2347969delete
delete原文链接
delete原文求助
delete分享
delete收藏
摘要

摘要

En 中文
Developer documentation helps developers learn frameworks and libraries, yet developing and maintaining accurate documentation requires considerable effort and resources. Contributors who work on developer documentation often need to manually track all changes in the code, determine which changes are significant enough to document, and then, adapt the documentation. We propose AdDoc, a technique that automatically discovers documentation patterns, i.e., coherent sets of code elements that are documented together, and that reports violations of these patterns as the code and the documentation evolves. We evaluated our approach in a retrospective analysis of four Java open source projects and found that at least 50 percent of all the changes in the documentation were related to existing documentation patterns. Our technique allows contributors to quickly adapt existing documentation, so that they can focus their documentation effort on the new features.
Keyword:
Documentation
maintainability
frameworks
AI总结

AI总结

对已上传原文的论文进行重点信息的提取,主要内容包括:简要概述、研究摘要、背景介绍、关键亮点、图文解析、展望与总结。

期刊

IEEE Transactions on Software Engineering 封面图
IEEE Transactions on Software Engineering
IF:
5.6
论文数:
2.9K
被引数:
1.1W

机构

M
McGill University
学者数:
5.5W
论文数: 4.9W
被引数: 7.0W
引用论文

引用论文

Free posterior tibial perforator flap: Anatomy and a report of 6 cases
err1996-01-01
err0
PREAI
errLeung-Kim Hung; Jie Lao; Pak-Cheong Ho
err分享
err收藏
Geographic distribution ranges of terrestrial mammal species in the 1970s
err2019-06-12
err0
errOAAI
errMichela Pacifici; Andrea Cristiano; Andrew A. Burbidge; John C. Z. Woinarski; Moreno Di Marco; Carlo Rondinini
err分享
err收藏
err分享
err收藏
err分享
err收藏
Recovering traceability links between code and documentation
err2002-10-01
err601
errOAAI
errAntoniol, G; Canfora, G; Casazza, G; De Lucia, A; Merlo, E
err分享
err收藏
err分享
err收藏
Airway Smooth Muscle Hypercontractility in Asthma
err2013-03-18
err0
errOAAI
errRachid Berair; Fay Hollins; Christopher Brightling
err分享
err收藏
学者 查看更多内容