Linking Documentation and Source Code in a Software Chrestomathy - Inria - Institut national de recherche en sciences et technologies du numérique Access content directly
Conference Papers Year : 2012

Linking Documentation and Source Code in a Software Chrestomathy

Jean-Marie Favre
  • Function : Author
  • PersonId : 855164
Ralf Lammel
  • Function : Author
Martin Leinberger
  • Function : Author
Thomas Schmorleiz
  • Function : Author
Andrei Varanovich
  • Function : Author


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.
No file

Dates and versions

hal-01003783 , version 1 (10-06-2014)


  • HAL Id : hal-01003783 , version 1


Jean-Marie Favre, Ralf Lammel, Martin Leinberger, Thomas Schmorleiz, Andrei Varanovich. Linking Documentation and Source Code in a Software Chrestomathy. WCRE, Oct 2012, Kingston, Canada. pp.335-344. ⟨hal-01003783⟩
82 View
0 Download


Gmail Facebook Twitter LinkedIn More