What is Écrit

Developing a user manual for your software application is a quite cumbersome task, yet it is required as a first port-of-call for your users. The capabilites of automated generation of user manuals is very limited, as the code one develops does not provide information about the bigger relations within the code. That is, you mostly only have your classes and packages and the semantics of your code only emerges out of the interplay of these classes.

Eclipse 4 is different. Here you have an application model which contains the information about the inter-dependencies of your code. The Écrit research project wants to find out to what degree the information in this application model can be used to generate a users manual.

What does it consist of

The tooling currently consists of two different plug-ins. The Eclipse 4 application model editor extension and the Ecrit plugin. The model editor extension allows to add additional information to your application model, which is then used by the plugin to populate the initial documentation artifacts.

Acknowledgement

The Écrit project is partially sponsored by the Austrian Research Promotion Agency (FFG) under project number 840165. (Oct 2013 – Sep 2014)

Contact

For informations on this project please contact

Marco Descher
University of Applied Sciences Vorarlberg, Austria

mde AT fhv DOT at