The DOI matches its Crossref record; 43 of the 43 references it cites were found in a registry or an index.
Recovering traceability links between code and documentation
Abstract
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.
Overview
The claims and statistics of this paper haven’t been checked yet.
Free: it reads the open-access text and checks the first 5 claims that cite a source we can check. Create a free account to check every claim.
Integrity signals
Registry
Cites
Statistics
Verification
Claims the paper makes
The claims and statistics of this paper haven’t been checked yet.
Free: it reads the open-access text and checks the first 5 claims that cite a source we can check. Create a free account to check every claim.
Self-check
Percentages, sums and reported differences re-computed from the paper’s own numbers.
The self-check needs the paper’s full text.
Citations
Cites
Elements of Information Theory
Cover, T. M., & Thomas, J. A. (2001) · Wiley eBooks · doi:10.1002/0471200611 · Cited by 36,808
Rayward-Smith, V. J. (1991) · Journal of the Operational Research Society · doi:10.1057/jors.1991.155 · Cited by 16,821
Term-weighting approaches in automatic text retrieval
Salton, G., & Buckley, C. (1988) · Information Processing & Management · doi:10.1016/0306-4573(88)90021-0 · Cited by 9,740
Algorithms on Strings, Trees and Sequences: Computer Science and Computational Biology
Gusfield, D. (1997) · Cambridge University Press eBooks · doi:10.1017/cbo9780511574931 · Cited by 3,078
Information Retrieval: Data Structures and Algorithms
Frakes, W. B., & Baeza-Yates, R. A. (1992) · Cited by 2,757
Reverse engineering and design recovery: a taxonomy
Chikofsky, E. J., & Cross, J. H. (1990) · IEEE Software · doi:10.1109/52.43044 · Cited by 2,012
Algorithms on strings, trees, and sequences
Gusfield, D. (1997) · Cited by 1,697
Elements of Information Theory
Phoenix, S. J. D. (1992) · Journal of Modern Optics · doi:10.1080/09500349214551641 · Cited by 1,380
gIBIS: a hypertext tool for exploratory policy discussion
Conklin, J., & Begeman, M. L. (1988) · ACM Transactions on Information Systems · doi:10.1145/58566.59297 · Cited by 1,088
Empirical Studies of Programming Knowledge
Soloway, E., & Ehrlich, K. (1984) · IEEE Transactions on Software Engineering · doi:10.1109/tse.1984.5010283 · Cited by 877
Cited by
On the naturalness of software
Hindle, A., Barr, E. T., Su, Z., Gabel, M., & Dévanbu, P. (2012) · doi:10.5555/2337223.2337322 · Cited by 541
Detection of Duplicate Defect Reports Using Natural Language Processing
Runeson, P., Alexandersson, M., & Nyholm, O. (2007) · 29th International Conference on Software Engineering (ICSE'07) · doi:10.1109/icse.2007.32 · Cited by 523
Semantic clustering: Identifying topics in source code
Kuhn, A., Ducasse, S., & Gîrba, T. (2007) · Information and Software Technology · doi:10.1016/j.infsof.2006.10.017 · Cited by 496
Advancing candidate link generation for requirements tracing: the study of methods
Hayes, J. H., Dekhtyar, A., & Sundaram, S. K. (2006) · IEEE Transactions on Software Engineering · doi:10.1109/tse.2006.3 · Cited by 481
An information retrieval approach to concept location in source code
Marcus, A., Sergeyev, A., Rajlich, V., & Maletic, J. I. (2005) · 11th Working Conference on Reverse Engineering · doi:10.1109/wcre.2004.10 · Cited by 455
On the naturalness of software
Hindle, A., Barr, E. T., Su, Z., Gabel, M., & Devanbu, P. (2012) · 2012 34th International Conference on Software Engineering (ICSE) · doi:10.1109/icse.2012.6227135 · Cited by 425
ReLink: recovering links between bugs and changes
Wu, R., Zhang, H., Kim, S., & Cheung, S.-C. (2011) · Proceedings of the 19th ACM SIGSOFT symposium and the 13th European conference on Foundations of software engineering · doi:10.1145/2025113.2025120 · Cited by 412
Lucia, A. D., Fasano, F., Oliveto, R., & Tortora, G. (2007) · ACM Transactions on Software Engineering and Methodology · doi:10.1145/1276933.1276934 · Cited by 354
A survey of traceability in requirements engineering and model-driven development
Winkler, S., & von Pilgrim, J. (2010) · Software & Systems Modeling · doi:10.1007/s10270-009-0145-0 · Cited by 313
Software traceability: trends and future directions
Cleland-Huang, J., Gotel, O. C. Z., Huffman Hayes, J., Mäder, P., & Zisman, A. (2014) · Future of Software Engineering Proceedings · doi:10.1145/2593882.2593891 · Cited by 309
“[3], who used a probabilistic approach to retrieve trace links between code and documentation.”
MethodOn the naturalness of software
Hindle, A., Barr, E. T., Gabel, M., Su, Z., & Devanbu, P. (2016) · Communications of the ACM · doi:10.1145/2902362 · Cited by 307
Using the Conceptual Cohesion of Classes for Fault Prediction in Object-Oriented Systems
Marcus, A., Poshyvanyk, D., & Ferenc, R. (2008) · IEEE Transactions on Software Engineering · doi:10.1109/tse.2007.70768 · Cited by 294
Automated classification of non-functional requirements
Cleland-Huang, J., Settimi, R., Zou, X., & Solc, P. (2007) · Requirements Engineering · doi:10.1007/s00766-007-0045-1 · Cited by 294
Evolution of software in automated production systems: Challenges and research directions
Vogel-Heuser, B., Fay, A., Schaefer, I., & Tichy, M. (2015) · Journal of Systems and Software · doi:10.1016/j.jss.2015.08.026 · Cited by 289
Improving requirements tracing via information retrieval
Hayes, J. H., Dekhtyar, A., & Osborne, J. (2004) · Journal of Lightwave Technology · doi:10.1109/icre.2003.1232745 · Cited by 287
Menzies, T., Dekhtyar, A., Distefano, J., & Greenwald, J. (2007) · IEEE Transactions on Software Engineering · doi:10.1109/tse.2007.70721 · Cited by 277
Software Documentation Issues Unveiled
Aghajani, E., Nagy, C., Vega-Marquez, O. L., Linares-Vasquez, M., Moreno, L., Bavota, G., & Lanza, M. (2019) · 2019 IEEE/ACM 41st International Conference on Software Engineering (ICSE) · doi:10.1109/icse.2019.00122 · Cited by 195
Improving code readability models with textual features
Scalabrino, S., Linares-Vasquez, M., Poshyvanyk, D., & Oliveto, R. (2016) · 2016 IEEE 24th International Conference on Program Comprehension (ICPC) · doi:10.1109/icpc.2016.7503707 · Cited by 114
Can Better Identifier Splitting Techniques Help Feature Location?
Dit, B., Guerrouj, L., Poshyvanyk, D., & Antoniol, G. (2011) · 2011 IEEE 19th International Conference on Program Comprehension · doi:10.1109/icpc.2011.47 · Cited by 89
Self-citationDetecting, Tracing, and Monitoring Architectural Tactics in Code
Mirakhorli, M., & Cleland-Huang, J. (2016) · IEEE Transactions on Software Engineering · doi:10.1109/tse.2015.2479217 · Cited by 85
Improving automated documentation to code traceability by combining retrieval techniques
Chen, X., & Grundy, J. (2011) · 2011 26th IEEE/ACM International Conference on Automated Software Engineering (ASE 2011) · doi:10.1109/ase.2011.6100057 · Cited by 50
“For the second group, class names are most likely not part of common words that can be found in a dictionary.”
BackgroundMethodInfluentialSocial engineering in social networking sites: Affect-based model
Algarni, A., Xu, Y., Chan, T., & Tian, Y.-C. (2013) · 8th International Conference for Internet Technology and Secured Transactions (ICITST-2013) · doi:10.1109/icitst.2013.6750253 · Cited by 41
Parameterizing and Assembling IR-Based Solutions for SE Tasks Using Genetic Algorithms
Panichella, A., Dit, B., Oliveto, R., Di Penta, M., Poshyvanyk, D., & De Lucia, A. (2016) · 2016 IEEE 23rd International Conference on Software Analysis, Evolution, and Reengineering (SANER) · doi:10.1109/saner.2016.97 · Cited by 36
Self-citationGenerating Unit Tests for Documentation
Nassif, M., Hernandez, A., Sridharan, A., & Robillard, M. P. (2022) · IEEE Transactions on Software Engineering · doi:10.1109/tse.2021.3087087 · Cited by 22
“Documentation traceability is a challenging problem [47], [48], but it is a prerequisite to validate the correct-”
BackgroundGuiding Human Validation of LLM-Generated Code via Verifiable Literate Programming
Yuan, Z., Lu, W., Wu, H., Jin, D., & Wu, C. (2026) · arXiv · doi:10.48550/arxiv.2607.02333
“We regard this as a traceability-link recovery (TLR) problem [49] with an implementation-relevance filter, which we refer to as implementation-relevant TLR.”
Metadata
- Authors
- Antoniol, G., Canfora, G., Casazza, G., De Lucia, A., & Merlo, E.
- Venue
- IEEE Transactions on Software Engineering
- Published
- 2002-10
- Volume
- 28
- Issue
- 10
- Pages
- 970-983
- ISSN
- 0098-5589 (ISSN-L)
- 1939-3520
- 2326-3881
- OpenAlex
- W2128581098
- Cited by
- 967
- References
- 43
- FWCI
- 47.87
- Type
- journal article
- Language
- en
- Open access
- closed
About these checks
Registry, retraction, Cites and statistics results are computed, not judged, with one exception: a printed reference that no index lists is read once by a model before it counts as a citation error. Claims are extracted by a model and kept only when their quote appears verbatim in the text; each cited source is then checked, with a model’s help, for whether it says what the claim relies on. Those verdicts can be wrong — read the claim’s quote and the cited source before relying on one.
Statistics and arithmetic are recomputed, not judged.
Confidence bands are shown only for fields calibrated on our annotated test set. None is calibrated yet, so no band is shown.
What counts as a claim ›How we measure confidence ›How we check this ›
Are you an author, or do you see a problem with this page? Request a review
Data sources
Bibliographic data: Semantic Scholar, OpenAlex, Crossref.
Contains information from the Semantic Scholar Academic Graph Datasets, made available under the ODC Attribution License (ODC-BY 1.0).
Semantic Scholar’s data is described in: Kinney, R., et al. (2023). The Semantic Scholar Open Data Platform. arXiv:2301.10140.