Automatic user documentation generation based on application model within integrated development environment Eclipse

Kvalitetna korisnička dokumentacija važan je dio svakog programskog proizvoda. U ovom radu proučavaju se mogudnosti i ograničenja automatskog generiranja korisničke dokumentacije zasnovanog na aplikacijskom modelu koji podržava integrirana razvojna okolina Eclipse. Istražuje se rješenje nastalo u sklopu projekta Ecrit, u obliku Eclipse plugin-a pomodu kojeg se jednim pritiskom na gumb na temelju informacija sadržanih u aplikacijskom modelu generira korisnička dokumentacija. U svrhu proučavanja kako trebaju biti oblikovane aplikacije na kojima bi ovo rješenje bilo primjenjivo, implementirana je Eclipse RCP aplikacija „Krtice“. S druge strane, predložen je koncept za jednostavniju izradu i održavanje korisničke dokumentacije koji se temelji na interaktivnom korisničkom sučelju preko kojeg kreator dokumentacije unosi tražene podatke. Implementaciju predloženog rješenja predstavlja aplikacija „User Manual Manager“.High-quality user documentation is an important part of any software product. This paper analyzes the possibilities and limitations of automatic user documentation generation based on application model within integrated development environment Eclipse. The paper explores the solution created within the project Ecrit, which is an Eclipse plugin that generates user documentation by a single button press, on the basis of information contained in the application model. In order to analyze how applications should be designed so that the solution could be applicable, an Eclipse RCP application „Moles“ is implemented. On the other hand, the paper proposes another concept to simplify the creation and maintenance of user documentation. The concept is based on an interactive user interface through which the user documentation writer enters the requested data. The proposed solution is implemented in the application „User Manual Manager“