arrow
Return

Recovering traceability links between code and documentation

delete2002-10-01
delete601
delete
OA
AI
G
Giuliano Antoniol
G
Gerardo Canfora
G
G. Casazza
A
Andrea De Lucia
E
Ettore Merlo
DOI:10.1109/TSE.2002.1041053delete
deleteOriginal
deleteOriginal request for help
deleteShare
deleteSave
Abstract

Abstract

En 中文
Software system documentation is almost always expressed informally in natural language and free text. Examples include requirement specifications, design documents, manual pages, system development journals, error logs, and related maintenance reports. We propose a method based on information retrieval to recover traceability links between source code and free text documents. A premise of our work is that programmers use meaningful names for program items, such as functions, variables, types, classes, and methods. We believe that the application-domain knowledge that programmers process when writing the code is often captured by the mnemonics for identifiers; therefore, the analysis of these mnemonics can help to associate high-level concepts with program concepts and vice-versa. We apply both a probabilistic and a vector space information retrieval model in two case studies to trace C++ source code onto manual pages and Java code to functional requirements. We compare the results of applying the two models, discuss the benefits and limitations, and describe directions for improvements.
Keywords:
redocumentation
traceability
program comprehension
object orientation
information retrieval

Journal

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

Organization

No organization information available
Cited Papers

Cited Papers

Polymer-based sensor arrays and multicomponent analysis for the detection of hazardous oragnic vapours in the environment
err1995-01-01
err0
PREAI
errAndreas Hierlemann; Udo Weimar; Gerolf Kraus; Markus Schweizer-Berberich; Wolfgang Göpel
errShare
errSave
errShare
errSave
The Scientific Revolution
err
IF0
err2018-01-01
err0
PREAI
errSteven Shapin
errShare
errSave
Malignant fibrous histiocytoma of the right ventricle of the heart
err2008-12-12
err0
PREAI
errNorihiro Teramoto; Kazuhiko Hayashi; Katsuya Miyatani; Kenji Miyake; Ashit Baran Sarker; Yoshino Tadashi; Kiyoshi Takahashi; Tadaatsu Akagi; Hiroshi Sunami; Sugato Nawa
errShare
errSave
Coupled Simulation of the Secondary Air Flow, Heat Transfer, and Structural Deflection of a Gas Turbine Engine
err2013-07-09
err0
PREAI
errGuilherme Tondello; Wolodymir Boruszewski; Fernando Mengele; Marcelo Assato; Silvio Shimizu; Shayne Ziegler
errShare
errSave
errShare
errSave
Individual patient data meta-analysis of randomized trials evaluating IL-2 monotherapy as remission maintenance therapy in acute myeloid leukemia
err2011-06-30
err0
errOAAI
errMarc Buyse; Pierre Squifflet; Beverly J. Lange; Todd A. Alonzo; Richard A. Larson; Jonathan E. Kolitz; Stephen L. George; Clara D. Bloomfield; Sylvie Castaigne; Sylvie Chevret; Didier Blaise; Dominique Maraninchi; Kathryn J. Lucchesi; Tomasz Burzykowski
errShare
errSave
researcher View more