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-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.
Document type :
Journal articles
Complete list of metadatas

Cited literature [22 references]  Display  Hide  Download

https://hal.inria.fr/hal-01549042
Contributor : Arnaud Blouin <>
Submitted on : Tuesday, July 24, 2018 - 3:54:45 PM
Last modification on : Friday, September 13, 2019 - 9:48:41 AM
Long-term archiving on : Thursday, October 25, 2018 - 3:23:22 PM

File

main.pdf
Files produced by the author(s)

Identifiers

Citation

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

Share

Metrics

Record views

1133

Files downloads

358