Automatic Production of End User Documentation for DSLs

Gwendal Le Moulec 1, 2 Arnaud Blouin 1, 3 Valérie Gouranton 1, 2 Bruno Arnaldi 1, 2
2 Hybrid - 3D interaction with virtual environments using body and mind
Inria Rennes – Bretagne Atlantique , IRISA_D6 - MEDIA ET INTERACTIONS
3 DiverSe - Diversity-centric Software Engineering
Inria Rennes – Bretagne Atlantique , IRISA_D4 - LANGAGE ET GÉNIE LOGICIEL
Abstract : Domain-speciic languages (DSL) are developed for answering speciic problems by leveraging expertise of domain stakeholders. If DSLs are usually small, their development requires a signiicant sooware engineering eeort: editors, code generators, etc., must be developed to make a DSL usable. Documenting a DSL is also a main and time-consuming task to promote it and address its learning curve. Recent research works in sooware language engineering focus on easing the development of DSLs. In this work, we focus on easing the production of documentations of DSLs having textual concrete syntaxes. We speciically focus on the automatic production of documentations for DSLs. We adapt from the API documentation domain properties that DSL documentations should follow. Based on these properties we propose a model-driven approach that extracts from DSL artifacts information required to build documentation. Our implementation, called Docywood, targets two platforms: Markdown documentations for static web sites and Xtext code fragments for live documentation while modeling. We used Docywood on two DSLs, namely ingML and XCore. Feedback from end users and language designers exhibits qualitative beneets of the proposal. End user experiments conducted on ingML and Target Platform Deenition show beneets on the correctness of the created models when using Docywood.
Type de document :
Pré-publication, Document de travail
2017
Liste complète des métadonnées

Littérature citée [35 références]  Voir  Masquer  Télécharger

https://hal.inria.fr/hal-01549042
Contributeur : Arnaud Blouin <>
Soumis le : vendredi 1 décembre 2017 - 11:18:37
Dernière modification le : mercredi 16 mai 2018 - 11:24:14

Fichier

main.pdf
Fichiers produits par l'(les) auteur(s)

Identifiants

  • HAL Id : hal-01549042, version 2

Citation

Gwendal Le Moulec, Arnaud Blouin, Valérie Gouranton, Bruno Arnaldi. Automatic Production of End User Documentation for DSLs. 2017. 〈hal-01549042v2〉

Partager

Métriques

Consultations de la notice

378

Téléchargements de fichiers

33