Analýza nástrojů pro tvorbu dokumentace a nápovědy aplikací

Jakub Libík

Bakalářská práce

Analysis of documentation and help authoring tools

Anotace:

Tato práce poskytuje základní přehled v oblasti dokumentace a nápovědy aplikací, předkládá návrh a srovnání nástrojů vhodných pro jejich tvorbu a nástin možností jejich využití. Je rozdělena do tří hlavních částí. První část seznamuje čtenáře s pojmem dokumentace, jejím účelem, jednotlivými druhy, strukturou a fázemi budování. Uvádí také rozdíly přístupu rigorózních a agilních metodik k její tvorbě a závěr je věnován pozici autora dokumentace a popisuje předpoklady pro úspěšné vykonávání role dokumentátora. Další kapitola se zabývá nápovědou aplikací, uvádí její účel a charakteristiky jednotlivých druhů. Dále jsou rozděleny prostředky, kterými je nápověda uskutečňována, a sice na grafické elementy, systémy nápovědy a Web help. Poslední, hlavní část, je věnována analýze nástrojů pro tvorbu dokumentace a nápovědy aplikací. Obsahuje popis postupu při analýze a vyhledávání nástrojů, jejich kategorizaci a kritéria použitá pro výběr nástrojů k hodnocení. U každého je uveden jeho obecný popis, základní parametry, přehled hlavní funkcionality, hodnocení možností využití a kombinace s dalšími nástroji. V závěru jsou shrnuty výsledky analýzy a navržena oblast využití jednotlivých nástrojů. Práce by měla pomoci čtenáři při orientaci v dostupných nástrojích pro tvorbu dokumentace a nápovědy a poskytnout vodítko při výběru konkrétního řešení.

Abstract:

This work offers essential overview of the area of documentation and online help, suggests the tools suitable for their production and outlines the possibilities of their use. Document is divided into three sections. First part acquaints the reader with the term documentation, its purpose, particular kinds, structure and stages of development. It shows the difference between the rigorous and agile methodology used for its creation and finally presents the position of the author of documentation and describes prerequisites for the successful documentator. Next chapter deals with online help, shows its purpose and characteristics of particular kinds. Then the division of the means of help creating is listed, namely graphic elements, help systems and web help. The last part includes the analysis of documentation and help authoring tools. It contains the description of procedure used for analyzing, categorization of discovered tools and criteria for their selection. General description, fundamental parameters, overview of main functions and the evaluation of possibilities of usage and combination with other applications are listed for each tool. Finally the analysis results are summarized and the area of particular tool usage is suggested. This work should help the reader with orientation in available tools for documentation and help authoring and offer the guidance in selection of particular solution.

Klíčová slova

nástroje pro tvorbu dokumentace a nápovědy, nápověda aplikací, dokumentace

Keywords

documentation adn help authoring tools, online help, documentation

Jazyk práce: čeština

Datum vytvoření / odevzdání či podání práce: 1. 2. 2008

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

• Obhajoba proběhla 20. 1. 2009
• Vedoucí: Alena Buchalcevová
• Oponent: Vladimír Tichý

Vysoká škola ekonomická v Praze

Bakalářský studijní program / obor:
Aplikovaná informatika / Informatika