Automating Manual Documentation Processes

Bc. Diana Vilkoláková

Master's thesis

Abstract:

Dokumentácia je neoddeliteľná súčasť softvérového systému. Táto práca diskutuje dôležitosť kvalitnej dokumentácie pri snahe o úspešnosť mnohých projektov a sumarizuje vhodné postupy a vzory, ktoré sa aplikujú pri písaní softvérovej dokumentácie. Atlassian Confluence bol opísaný detailnejšie, pretože tento nástroj na písanie technickej dokumentácie používa Kentico. Práca obsahuje aj prehľad ďalších nástrojov podporujúcich kolaboráciu a samotné dokumentovanie softvéru. Keďže dokumentácia je často zanedbávaná, je vhodné automatizovať tento proces, aby sa ušetril čas a zdroje. V práci som identifikovala opakujúce sa manuálne procesy, ktoré sa dejú pri tvorbe a údržbe technickej dokumentácie v Kenticu, navrhla možné vylepšenia, stanovila požiadavky a implementovala nástroj automatizujúci identifiované procesy za cieľom ušetrenia firemných zdrojov. Za účelom prevedenia čitateľa implementačným procesom som popísala použité technológie a detaily vývoja. Po integrovaní nástroja do firemného produkčného prostredia bol ušetrený čas a objem práce strávený pri písaní dokumentácie, ako sa predpokladalo. Práca obsahuje súhrn získaných benefitov a návrhov na možnú budúcu automatizáciu manuálnych procesov pri tvorbe dokumentácie v Kenticu. Taktiež som navrhla možné rozšírenie implementovaného nástroja.

Abstract:

Documentation is an integral part of a software system. This thesis discussed the importance of having high quality documentation to the success of many projects and summarized good practices and possible patterns to apply in the writing of software documentation. Atlassian Confluence was described in more detail as it is the tool of choice at Kentico for writing technical documentation. The thesis contains an overview of other tools supporting authoring, collaboration and documenting along with their respective advantages and disadvantages. Since documentation is often neglected, it is advisable to automate this process in order to save time and money. I identified repetitive manual processes happening during creation and maintenance of technical documentation at Kentico, proposed possible enhancements, established the requirements and implemented a tool that automates these repetitive tasks with the goal of saving the company's resources. The technology stack and development details are explained to guide the reader through the implementation process. After the tool was integrated in the company's production environment, the workload of documenting was lowered and time was saved as predicted. I outlined the gained benefits and laid out suggestions for further possibilities of manual process automation involved in creation of technical documentation in Kentico. I also suggested future improvements, as well as expansion of the tool implemented for this thesis.

Keywords

Software documentation, Software automation, Lucene, Atlassian Confluence, Kentico, Indexing, Search, Authoring

Language used: English

Date on which the thesis was submitted / produced: 13. 12. 2017

Thesis defence

• Date of defence: 1. 2. 2018
• Supervisor: PhD Bruno Rossi
• Reader: Mgr. Tomáš Nosek

Masaryk University

Faculty of Informatics

Master programme / field:
Applied Informatics / Applied Informatics