Obecné principy pro tvorbu dokumentace

Návrh zadání

Navrhnete a vytvorte výukový webový systém zpracovávající zásady pro tvorbu dokumentace pri tvorbe programového díla. Rozdelení typu dokumentace, prehled soucasných systému pro generování dokumentace (javadoc, doxygen, Docbook, ...). Vytvorení vzorových projektu v C, Jave, (C++, atd.) se vzorovou dokumentací, které budou pouzitelné v kurzech Základy programování, Jazyk C, Seminár C++, Seminár Java, prípadne dalsích.

Implementace by spocívala ve vytvorení jednoduchých vzorových projektu v C, C++, Jave (podle znalostí autora) a webové aplikace, prípadne s vyuzitím JSP, PHP, Java Appletu nebo Javascriptu (mozná i Flash), která bude sumarizovat zásady pro tvorbu dokumentace v projektech a zároven poskytne ukázky správného/spatného prístupu (interaktivní, animované, fantazii se meze nekladou).

Klícová slova

Webová aplikace, dokumentacní systémy, JSP, PHP, C, Java

Implementacní jazyk

PHP, JSP, C, Java, ...

Pozadované znalosti

Zkusenosti s programováním. Zkusenosti s vytvárením dokumentace a tvorbou webových aplikací jsou výhodou, nikoli podmínkou.

Obtíznost

Vhodné zejména jako bakalárský projekt.

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