A Tool for Automated Generation of Interactive User Documentation for Software Applications

Bc. Petra Šátková

Bachelor's thesis

Nástroj pro automatizované vytváření interaktivní uživatelské dokumentace k softwarovým aplikacím

Anotácia:

Tato bakalářská práce se zabývá problémem ručního a časově náročného vytváření uživatelské dokumentace pro softwarové aplikace. Cílem této práce je navrhnout a implementovat nástroj schopný automaticky generovat uživatelskou dokumentaci kombinací více informačních zdrojů. Navrhovaný systém využívá snímky obrazovky uživatelského rozhraní pořízené za běhu a specifikace OpenAPI popisující funkčnost backendu. Systém se skládá z několika fází, včetně extrakce OpenAPI, analýzy snímků obrazovky, generování mezilehlé reprezentace a finální dokumentace ve formátech Markdown a HTML. Díky integraci vizuálních a strukturovaných dat vytváří tento nástroj dokumentaci srozumitelnou pro člověka, která odráží jak vzhled, tak chování aplikace. Navrhované řešení bylo vyvinuto a vyhodnoceno na reálné aplikaci. Výsledky ukazují, že nástroj je schopen generovat dokumentaci, která je strukturálně konzistentní a funkčně přesná, a představuje tak životaschopnou alternativu k ručním procesům tvorby dokumentace. Generované výstupy mohou navíc sloužit nejen jako uživatelské příručky, ale také jako znalostní báze pro navazující aplikace, jako jsou systémy s rozšířeným vyhledáváním a konverzační asistenti.

Abstract:

This thesis addresses the problem of the manual and time-consuming creation of user documentation for software applications. The goal of this thesis is to design and implement a tool capable of automatically generating user documentation by combining multiple sources of information. The proposed system leverages runtime screenshots of the user interface and OpenAPI specifications describing backend functionality. The system consists of several stages, including OpenAPI extraction, screenshot analysis, intermediate representation generation, and final documentation in Markdown and HTML formats. By integrating visual and structured data, the tool produces human-readable documentation that reflects both the appearance and behavior of the application. The proposed solution was developed and evaluated on a real-world application. The results demonstrate that the tool is capable of generating documentation that is structurally consistent and functionally accurate, providing a viable alternative to manual documentation processes. Additionally, the generated outputs can serve not only as user guides but also as a knowledge base for downstream applications such as retrieval-augmented systems and conversational assistants.

Kľúčové slová

velký jazykový model, LLM, uživatelská dokumentace

Keywords

LLM, large language model, user documentation

Jazyk práce: English

Datum vytvoření / odevzdání či podání práce: 15. 5. 2026

Obhajoba závěrečné práce

• Obhajoba proběhla 23. 6. 2026
• Vedúci: Ing. Roman Valovič
• Oponent: Jan Vavřina, Bc.

Mendel University in Brno

Faculty of Business and Economics

Bachelor programme / specializace:
Open Informatics / Scope for Open Informatics