Recovering Code to Documentation Links in OO Systems

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 an approach to establish and maintain traceability links between the source code and free text documents. A premise of our work is that programmers use meaningful names for program's 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. In this paper, the approach is applied to software written in an object-oriented language, namely C++, to trace classes to manual sections.

• Type: Conference
• Year: 1999
• Where: WCRE
• Authors: Giuliano Antoniol, Gerardo Canfora, Andrea De Lucia, Ettore Merlo
• Keywords: Examples Include Requirement, Free Text, Related Maintenance Reports, Software Engineering, WCRE 1999