arrow
Return

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
deleteOriginal
deleteOriginal request for help
deleteShare
deleteSave
Abstract

Abstract

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.
Keywords:
Documentation
maintainability
frameworks
AI Summary

AI Summary

Key information extracted from the uploaded paper, including a brief overview, abstract, background, key highlights, visual analysis, and future outlook.

Journal

IEEE Transactions on Software Engineering cover
IEEE Transactions on Software Engineering
IF:
5.6
Papers:
2.9K
Citations:
1.1W

Organization

M
McGill University
Scholars:
5.5W
Papers: 4.9W
Citations: 7.0W
Cited Papers

Cited Papers

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
errShare
errSave
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
errShare
errSave
errShare
errSave
Recovering traceability links between code and documentation
err2002-10-01
err601
errOAAI
errAntoniol, G; Canfora, G; Casazza, G; De Lucia, A; Merlo, E
errShare
errSave
Airway Smooth Muscle Hypercontractility in Asthma
err2013-03-18
err0
errOAAI
errRachid Berair; Fay Hollins; Christopher Brightling
errShare
errSave
researcher View more