Automatizovaná kontrola technické dokumentace

Bc. Pavel Vomáčka

Diplomová práce

Technical documentation validator

Anotace:

Tato diplomová práce se zabývá dokumentací, její tvorbou, používanými formáty a zejména jejím testováním. Z~pohledu testování ukazuje způsob, jakým zapojit kontinuální integraci do práce s dokumentací. V práci je popsán framework Emender, který je vhodný pro deklaraci a tvorbu testů dokumentace. Dále jsou detailně popsány tři testy a jejich implementace - konkrétně se jedná o testy existence balíčků, funkčnosti externích odkazů a správnosti přepínačů příkazů uvedených v dokumentační knize. Diplomová práce dále popisuje dotazník, který zjišťoval chyby, se kterými se autoři dokumentace nejčastěji setkávají.

Abstract:

This thesis covers the topic of documentation - how it is usually created, which formats are commonly used and how it is tested. It shows how documentation testing can be used for continuous integration purposes. The framework Emender is described with the aim to show how to create documentation tests with it. A set of three different tests is shown alongside with their implementation. These include tests of package existence, hyperlinks functionality and tests of command options of commands in a documentation book. Results of an inquiry form about most common mistakes seen by documentation authors.

Klíčová slova

Testování, dokumentace, Emender, DocBook, balíčky, odkazy, přepínače, příkazy, kontinuální integrace

Jazyk práce: čeština

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

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

• Obhajoba proběhla 10. 2. 2017
• Vedoucí: RNDr. Adam Rambousek, Ph.D.
• Oponent: Radek Bíba

Masarykova univerzita

Fakulta informatiky

Magisterský studijní program / obor:
Aplikovaná informatika / Služby - výzkum, řízení a inovace