Automatická podpora tvorby dokumentace projektů

Abstract

Cílem této práce je vytvořit program, který bude automaticky vytvářet zvolenou úroveň dokumentace z informačního systému pro podporu vědy a výzkumu a umožňovat uživatelský zásah do ní. Zvolený problém jsem vyřešil vytvořením programu v jazyce PHP, který využívá soukromé Wiki výzkumné skupiny KNOT a vytváří speciální hlavičky na určených stránkách. V práci jsem vytvořil detailní návrh postupu generování a kontroly těchto hlaviček, který dokáže rozeznat uživatelský text v hlavičce a pracovat s ním. Podle tohoto návrhu jsem implementoval program, který slouží jako platforma a jeho funkčnost lze rozšířit moduly. Program periodicky kontroluje údaje v informačním systému, ale i obsah hlaviček, jestli v nich uživatel manuálně nezměnil obsah. Pokud se v hlavičce nic nezměnilo, tak tyto hlavičky dokáže přeskočit. Toto zkrátilo dobu kontroly více než dvojnásobně a umožnilo snadné přidávání funkcionality. Vytvořené řešení zabraňuje ztrátě uživatelských dat a velmi urychluje a zefektivňuje kontrolu celé dokumentaceThe goal of this thesis is to create a program which will automatically create selected level of documentation from an information system for supporting science and research and enables user intervention. I solved the selected problem with creating a program in the PHP language which uses a private MediaWIKi which belongs to the KNOT research group and creates special headers on certain pages. In this work I created a detailed proposal of the procedure that generates and checks these headers and it can tell apart user text and work with him. According to this design, I implemented a program that serves as a platform and its functionality can be expanded by modules. The program periodically checks the information in the information system, as well as the contents of the headers, if the user did not manually change the content and if nothing else changed in the header, these headers can be skipped. This shortened the program running time more than twice, and has made it easy to add new functionalities. This solution prevents the loss of user data, greatly speeds up the control of the entire documentation and makes it more efficient.