Automatic Production of End User Documentation for DSLs - Inria - Institut national de recherche en sciences et technologies du numérique Accéder directement au contenu
Article Dans Une Revue Computer Languages, Systems and Structures Année : 2018

Automatic Production of End User Documentation for DSLs

Résumé

Domain-specific languages (DSL) are developed for answering specific problems by leveraging the expertise of domain stakeholders. The development of DSLs requires a significant software engineering effort: editors, code generators, etc., must be developed to make a DSL usable. Documenting a DSL is also a major and time-consuming task required to promote it and address its learning curve. Recent research work in software language engineering focus on easing the development of DSLs. This work focuses on easing the production of documentation of textual DSLs. The API documentation domain identified challenges we adapted to DSL documentation. Based on these challenges we propose a model-driven approach that relies on DSL artifacts to extract information required to build documentation. Our implementation, called Docywood, targets two platforms: Markdown documentation for static web sites and Xtext code fragments for live documentation while modeling. We used Docywood on two DSLs, namely ThingML and Target Platform Definition. Feedback from end users and language designers exhibits qualitative benefits of the proposal with regard to the DSL documentation challenges. End user experiments conducted on ThingML and Target Platform Definition show benefits on the correctness of the created models when using Docywood on ThingML.
Fichier principal
Vignette du fichier
main.pdf (1.05 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

Citer

Gwendal Le Moulec, Arnaud Blouin, Valérie Gouranton, Bruno Arnaldi. Automatic Production of End User Documentation for DSLs. Computer Languages, Systems and Structures, 2018, 54, pp.337-357. ⟨10.1016/j.cl.2018.07.006⟩. ⟨hal-01549042v3⟩
725 Consultations
589 Téléchargements

Altmetric

Partager

Gmail Facebook X LinkedIn More