Tvorba uživatelské dokumentace pro Integrovaný testovací nástroj

Monika Tománková

Bachelor's thesis

User documentation of the Integrated testing node

Abstract:

V současné době dospěl vývoj Integrovaného testovacího nástroje, vyvíjeného v rámci Kompetenčního centra Software Quality Assurance na VŠE, do fáze, kdy jsou funkční základní aplikace. Protože tento nástroj poskytuje široké možnosti nastavení, vyvstala tu otázka, jak se naučí uživatelé s tímto nástrojem pracovat. Kvůli tomuto faktu začala vznikat uživatelská dokumentace Integrovaného testovacího nástroje, jejíž částečné vytvoření je také součástí této práce. Hlavním cílem této bakalářské práce je stanovit metodiku pro tvorbu a správu uživatelské dokumentace Integrovaného testovacího nástroje. Díky této metodice bude možné zachovat styl formy a obsahu i v případě změny administrátorů dokumentace. Dále jsou v této práci uvedeny doporučení při tvorbě uživatelských dokumentací čerpané z odborné literatury a stručně popsán samotný Integrovaný testovací nástroj.

Abstract:

Nowadays, the development of the Integrated testing node created within the Competence Centre Software Quality Assurance at the University of Economics in Prague, came to a point where all the basic applications are functional. Since this tool provides a wide range of settings, there arose the question of how to teach users to use this tool. Due to this fact, the creation of user documentation ITN began. Its partial creation is also a part of this thesis. The main objective of this bachelor thesis is to establish a methodology for creating and managing the user documentation for the Integrated testing node. Thanks to this methodology, it will be possible to maintain the same structure and style, which will not be influenced by the changes of administrators throughout time. Furthermore, this paper presents the best practices for technical writing and a brief description of Integrated testing node's applications.

Keywords

technické psaní, ITN, Integrovaný testovací nástroj, MediaWiki, metodika, uživatelská dokumentace

Keywords

MediaWiki, ITN, methodology, Integrated testing node, technical writing, user manual, user documentation

Language used: Czech

Date on which the thesis was submitted / produced: 12. 10. 2015

Thesis defence

• Date of defence: 20. 6. 2016
• Supervisor: Alena Buchalcevová
• Reader: Jan Ženíšek

Vysoká škola ekonomická v Praze

Bachelor programme / field:
Aplikovaná informatika / Informatika