Obecné principy pro tvorbu dokumentace

Návrh zadání

Navrhněte a vytvořte výukový webový systém zpracovávající zásady pro tvorbu dokumentace při tvorbě programového díla. Rozdělení typů dokumentace, přehled současných systémů pro generování dokumentace (javadoc, doxygen, Docbook, ...). Vytvoření vzorových projektů v C, Javě, (C++, atd.) se vzorovou dokumentací, které budou použitelné v kurzech Základy programování, Jazyk C, Seminář C++, Seminář Java, případně dalších.

Implementace by spočívala ve vytvoření jednoduchých vzorových projektů v C, C++, Javě (podle znalostí autora) a webové aplikace, případně s využitím JSP, PHP, Java Appletů nebo Javascriptu (možná i Flash), která bude sumarizovat zásady pro tvorbu dokumentace v projektech a zároveň poskytne ukázky správného/špatného přístupu (interaktivní, animované, fantazii se meze nekladou).

Klíčová slova

Webová aplikace, dokumentační systémy, JSP, PHP, C, Java

Implementační jazyk

PHP, JSP, C, Java, ...

Požadované znalosti

Zkušenosti s programováním. Zkušenosti s vytvářením dokumentace a tvorbou webových aplikací jsou výhodou, nikoli podmínkou.

Obtížnost

Vhodné zejména jako bakalářský projekt.

Autor: David Martinek. Poslední modifikace: 28. February 2006. Pokud v tomto dokumentu narazíte na chybu, dejte mi prosím vědět.