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.
Type de document :
Communication dans un congrès
WCRE, Oct 2012, Kingston, Canada. pp.335-344, 2012
Liste complète des métadonnées

https://hal.inria.fr/hal-01003783
Contributeur : Jean-Marie Favre <>
Soumis le : mardi 10 juin 2014 - 16:25:54
Dernière modification le : jeudi 11 octobre 2018 - 08:48:02

Identifiants

  • HAL Id : hal-01003783, version 1

Collections

Citation

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, 2012. 〈hal-01003783〉

Partager

Métriques

Consultations de la notice

82