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,393
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
Towards a theory of the comprehension of computer programs
Brooks, R. (1983) · International Journal of Man-Machine Studies · doi:10.1016/s0020-7373(83)80031-5 · Cited by 756
Witten, I. H., & Bell, T. C. (1991) · IEEE Transactions on Information Theory · doi:10.1109/18.87000 · Cited by 729
A maximum entropy approach to adaptive statistical language modelling
Rosenfeld, R. (1996) · Computer Speech & Language · doi:10.1006/csla.1996.0011 · Cited by 542
Stimulus structures and mental representations in expert comprehension of computer programs
Pennington, N. (1987) · Cognitive Psychology · doi:10.1016/0010-0285(87)90007-7 · Cited by 526
Software reflexion models: bridging the gap between source and high-level models
Murphy, G. C., Notkin, D., & Sullivan, K. (1995) · Proceedings of the 3rd ACM SIGSOFT symposium on Foundations of software engineering · doi:10.1145/222124.222136 · Cited by 479
Introduction to Probability and Mathematical Statistics.
Franck, W., Bain, L. J., & Engelhardt, M. (1988) · Journal of the American Statistical Association · doi:10.2307/2288954 · Cited by 479
An information retrieval approach for automatically constructing software libraries
Maarek, Y. S., Berry, D. M., & Kaiser, G. E. (1991) · IEEE Transactions on Software Engineering · doi:10.1109/32.83915 · Cited by 442
Software reflexion models: bridging the gap between design and implementation
Murphy, G. C., Notkin, D., & Sullivan, K. J. (2001) · IEEE Transactions on Software Engineering · doi:10.1109/32.917525 · Cited by 398
Syntactic/semantic interactions in programmer behavior: A model and experimental results
Shneiderman, B., & Mayer, R. (1979) · International Journal of Computer & Information Sciences · doi:10.1007/bf00977789 · Cited by 382
Expertise in debugging computer programs: A process analysis
Vessey, I. (1985) · International Journal of Man-Machine Studies · doi:10.1016/s0020-7373(85)80054-7 · Cited by 359
Design recovery for maintenance and reuse
Biggerstaff, T. J. (1989) · Computer · doi:10.1109/2.30731 · Cited by 359
Cognitive processes in program comprehension
Letovsky, S. (1987) · Journal of Systems and Software · doi:10.1016/0164-1212(87)90032-x · Cited by 327
The concept assignment problem in program understanding
Biggerstaff, T. J., Mitbander, B. G., & Webster, D. E. (1993) · doi:10.5555/257572.257679 · Cited by 325
Identifying and qualifying reusable software components
Caldiera, G., & Basili, V. R. (1991) · Computer · doi:10.1109/2.67210 · Cited by 292
Comprehension strategies in programming
Pennington, N. (1987) · Ablex Publishing Corp. eBooks · Cited by 285
Supporting systems development by capturing deliberations during requirements engineering
Ramesh, B., & Dhar, V. (1992) · IEEE Transactions on Software Engineering · doi:10.1109/32.142872 · Cited by 284
Introduction to Probability and Mathematical Statistics.
Bain, L. J., & Engelhardt, M. (1993) · Biometrics · doi:10.2307/2532587 · Cited by 280
An object-oriented tool for tracing requirements
Pinheiro, F. A. C., & Goguen, J. A. (1996) · IEEE Software · doi:10.1109/52.506462 · Cited by 185
Automatic spelling correction using a trigram similarity measure
Angell, R. C., Freund, G. E., & Willett, P. (1983) · Information Processing & Management · doi:10.1016/0306-4573(83)90022-5 · Cited by 175
Information retrieval models for recovering traceability links between code and documentation
Antoniol, Canfora, Casazza, & Lucia, D. (2000) · Proceedings International Conference on Software Maintenance ICSM-94 · doi:10.1109/icsm.2000.883003 · Cited by 163
Spoken Dialogues with Computers
Mori, R. D. (1998) · Cited by 136
Software reuse through information retrieval
Frakes, W. B., & Nejmeh, B. A. (1986) · ACM SIGIR Forum · doi:10.1145/24634.24636 · Cited by 129
Monitoring compliance of a software system with its high-level design models
Sefika, M., Sane, A., & Campbell, R. H. (1996) · doi:10.5555/227726.227810 · Cited by 126
Identification of dynamic comprehension processes during large scale maintenance
von Mayrhauser, A., & Vans, A. M. (1996) · IEEE Transactions on Software Engineering · doi:10.1109/32.508315 · Cited by 124
From program comprehension to tool requirements for an industrial environment
von Mayrhauser, A., & Vans, A. M. (2002) · IEEE International Conference on Program Comprehension (ICPC) · doi:10.1109/wpc.1993.263903 · Cited by 92
Identifying the starting impact set of a maintenance request: a case study
Antoniol, G., Canfora, G., Casazza, G., & Lucia, A. D. (2002) · Euromicro Conference on Software Maintenance and Reengineering (CSMR) · doi:10.1109/csmr.2000.827331 · Cited by 89
Self-citationRecovering code to documentation links in OO systems
Antoniol, G., Canfora, G., Lucia, A. D., & Merlo, E. (2003) · Working Conference on Reverse Engineering (WCRE) · doi:10.1109/wcre.1999.806954 · Cited by 65
Self-citationMonitoring compliance of a software system with its high-level design models
Sefika, M., Sane, A., & Campbell, R. H. (2002) · doi:10.1109/icse.1996.493433 · Cited by 62
Tracing object-oriented code into functional requirements
Antoniol, G., Canfora, G., Casazza, G., Lucia, A. D., & Merlo, E. (2002) · IEEE International Conference on Program Comprehension (ICPC) · doi:10.1109/wpc.2000.852482 · Cited by 48
Self-citationTraceability recovery by modeling programmer behavior
Antoniol, G., Casazza, C., & Cimitile, A. (2002) · Proceedings - Working Conference on Reverse Engineering · doi:10.1109/wcre.2000.891475 · Cited by 43
Self-citationDynamic code cognition behaviors for large scale code
von Mayrhauser, A., & Vans, A. M. (2002) · IEEE International Conference on Program Comprehension (ICPC) · doi:10.1109/wpc.1994.341253 · Cited by 26
Empirical studies of programming knowledge
Soloway, E., & Ehrlich, K. (1989) · ACM eBooks · doi:10.1145/75722.75734 · Cited by 25
(1997)
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
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.