Automatic Production of End User Documentation for DSLs - Université de Rennes Accéder directement au contenu
Pré-Publication, Document De Travail Année : 2017

Automatic Production of End User Documentation for DSLs

Résumé

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.
Fichier principal
Vignette du fichier
main.pdf (1.21 Mo) Télécharger le fichier
Origine : Fichiers produits par l'(les) auteur(s)
Loading...

Dates et versions

hal-01549042 , version 1 (28-06-2017)
hal-01549042 , version 2 (01-12-2017)
hal-01549042 , version 3 (24-07-2018)

Identifiants

  • HAL Id : hal-01549042 , version 1

Citer

Gwendal Le Moulec, Arnaud Blouin, Valérie Gouranton, Bruno Arnaldi. Automatic Production of End User Documentation for DSLs. 2017. ⟨hal-01549042v1⟩
713 Consultations
589 Téléchargements

Partager

Gmail Facebook X LinkedIn More