Original title:
Multiplatformní nástroj pro generování technické dokumentace z XML
Translated title:
Multi-Platform Tool for Generation of Technical Documentation from XML
Authors:
Jánošíková, Simona ; Setinský, Jiří (referee) ; Strnadel, Josef (advisor) Document type: Bachelor's theses
Year:
2024
Language:
slo Publisher:
Vysoké učení technické v Brně. Fakulta informačních technologií Abstract:
[slo][eng]
Táto bakalárska práca sa zaoberá výzvou v oblasti technickej dokumentácie vývojových prostredí a preskúmava možnosti automatizovanej generácie dokumentácie zo štruktúrovaných XML dát. Problém spočíva v potrebe efektívnej tvorby a udržiavania technickej dokumentácie projektov prostredníctvom automatizovaného procesu. Cieľom práce je navrhnúť, implementovať a zhodnotiť multiplatformný nástroj, ktorý bude schopný z XML vstupov generovať technickú dokumentáciu s dôrazom na praktickú použiteľnosť v reálnych projektoch. Práca je užitočná pre vývojárov, ktorí sa zaoberajú tvorbou a udržiavaním technickej dokumentácie vývojových prostredí. Poskytuje konkrétny nástroj, ktorý môže zefektívniť proces generovania dokumentácie a zlepšiť čitateľnosť dokumentácie v rámci projektov využívajúcich XML formát pre uloženie informácií.
This bachelor's thesis deals with the challenge in the field of technical documentation of development environments and explores the possibilities of automated generation of documentation from structured XML data. The problem lies in the need for efficient creation and maintenance of technical project documentation through an automated process. The goal of the work is to design, implement and evaluate a multi-platform tool that will be able to generate technical documentation from XML inputs with an emphasis on practical usability in real projects. The work is useful for developers who are involved in the creation and maintenance of technical documentation of development environments. It provides a specific tool that can streamline the documentation generation process and improve the readability of documentation within projects using the XML format for storing information.
Keywords:
automated generation; CMSIS-SVD; Latex; Markdown; PDF; Python; technical documentation; tool; UPPAAL; XML
Institution: Brno University of Technology
(web)
Document availability information: Fulltext is available in the Brno University of Technology Digital Library. Original record: https://hdl.handle.net/11012/247854