Title
Linking Documentation and Source Code in a Software Chrestomathy
Abstract
The software chrestomathy of the 101companies community project demonstrates 'many' software languages and software technologies by implementing 'many' variants of a human resources management system, each implementation selects from 'many' optional features. All implementations are available through a source-code repository and they are documented on a wiki. Source code and documentation encode references to software languages, software technologies, software concepts, and product features, which, by themselves, are also documented and linked on the wiki. This setup implies the challenges of establishing links between source code and documentation as well as verifying that source code and documentation are in agreement. We describe an approach that addresses these challenges, it relies on a rule-based system which extracts relevant information from source-code artifacts (e.g., information about language and technology usage) and assigns metadata to the artifacts (e.g., methods for validation and fact extraction). The linked source-code repository and wiki as well as various derived information resources are available through the 101ecosystem for the benefit of the reverse engineering community.
Year
DOI
Venue
2012
10.1109/WCRE.2012.43
Reverse Engineering
Keywords
Field
DocType
information resource,software chrestomathy,linking documentation,software language,software technology,software concept,source code,documentation encode reference,relevant information,source-code repository,source-code artifact,traceability,meta data,computer architecture,documentation,reverse engineering,data mining,information services
Static program analysis,Software engineering,Computer science,Software documentation,Internal documentation,Software system,Software walkthrough,Software construction,Software verification and validation,Software development
Conference
ISSN
ISBN
Citations 
1095-1350
978-1-4673-4536-1
5
PageRank 
References 
Authors
0.43
14
5
Name
Order
Citations
PageRank
Jean-Marie Favre1354.73
Ralf Lammel2485.77
Martin Leinberger3235.94
Thomas Schmorleiz4452.89
Andrei Varanovich5464.04