Best Practices for Form and Appearance of Automatically Generated Documentation
| Thesis title: | Principy pro formu a vzhled automaticky generovaných dokumentací |
|---|---|
| Author: | Svobodová, Kateřina |
| Thesis type: | Diplomová práce |
| Supervisor: | Bruckner, Tomáš |
| Opponents: | Doležel, Michal |
| Thesis language: | Česky |
| Abstract: | Nedostatečná uživatelská přívětivost automaticky generovaných dokumentací odrazuje programátory od jejich využívání. Zlepšení uživatelské přívětivosti může pomoci jak začátečníkům tak expertům během vývoje software. Výsledkem práce je soubor principů pro automaticky generované dokumentace ze zdrojového kódu, aplikace principů a výsledky měření účinnosti změn. Práce je zpracována dle metody Design Science Research zaručující kvalitní design založený na konstruktivním výzkumu. Univerzální principy pro formu a vzhled automaticky generovaných dokumentací byly sestaveny pro vyřešení problémů odhalených expertním posudkem a neformálním posudkem a problémů zjištěných z rešerše odborných článků. Identifikované principy jsou aplikovány na dokumentaci knihovny Requests4J pro programovací jazyk Java. Dokumentace po aplikaci principů byla podle uživatelského testování přívětivější než původní dokumentace, což potvrzuje aplikovatelnost sestavených principů. |
| Keywords: | generátor dokumentace; HCI; softwarová dokumentace |
| Thesis title: | Best Practices for Form and Appearance of Automatically Generated Documentation |
|---|---|
| Author: | Svobodová, Kateřina |
| Thesis type: | Diploma thesis |
| Supervisor: | Bruckner, Tomáš |
| Opponents: | Doležel, Michal |
| Thesis language: | Česky |
| Abstract: | Insufficient usability of automatically generated documentations discourages programmers from using them. Improving usability can help both beginners and experts during software development. The result of this thesis is a set of best practices for automatically generated documentation from source code, application of those best practices and the results of measuring effectiveness of the changes. The thesis is conducted according to the Design Science Research method guaranteeing quality design based on constructive research. Universal best practices for the form and appearance of automatically generated documentation were compiled to address the problems found by an expert review and an informal review and the problems identified from a literature review of peer-reviewed articles. The identified best practices are applied to documentation from the Requests4J library for the Java programming language. The modified documentation was, according to the user testing, more user-friendly than the original documentation, confirming the applicability of the compiled best practices. |
| Keywords: | software documentation; documentation generator; HCI |
Information about study
| Study programme: | Kognitivní informatika |
|---|---|
| Type of study programme: | Magisterský studijní program |
| Assigned degree: | Ing. |
| Institutions assigning academic degree: | Vysoká škola ekonomická v Praze |
| Faculty: | Faculty of Informatics and Statistics |
| Department: | Department of Information Technologies |
Information on submission and defense
| Date of assignment: | 4. 10. 2022 |
|---|---|
| Date of submission: | 1. 5. 2023 |
| Date of defense: | 1. 6. 2023 |
| Identifier in the InSIS system: | https://insis.vse.cz/zp/82218/podrobnosti |