Jak získat 8 bodů? Tento článek může pomoci. Doufám, že to pomůže.
Nejlepší možností by bylo rozdělit dokumentaci na 3 části.
1. Popis úlohy: (Full task)
2. Uživatelská příručka: (Description of website functionality)*
(Web UI samples)*
3. Popis implementace: (Description of the main features of the program)*
(Generated documentation from source code)*
*Dokumentaci jsem napsal v angličtině.
Kroky.
Vytvořte 5 souborů na Google disku ve formátu doc.
Full task — Do tohoto souboru je potřeba napsat Zadání semestrální práce, který jste poslali svému cvičícímu do 3. výukového týdne. Přikládám vzorové zadání.
Description of website functionality — V tomto dokumentu jsem přidal screenshot hlavní stránky (ale myslím, že to není nutné). Hlavně je potřeba napsat k čemu váš web je a popsat funkce stránek. Měl jsem jich asi 20.
Web UI samples — Zde jsem udělal screenshoty, jak se zaregistrovat, přihlásit. Také jsem ukázal screenshoty toho, co se stane, když zadáte špatné znaky, jaký je rozdíl mezi přihlašeným uživatelem a nepřihlašeným uživatelem.
Description of the main features of the program — Zde musíte popsat svůj projekt. Z čeho se skládá a k čemu každý soubor slouží. Dále je nutné popsat architekturu, které frameworky byly použity (nepoužity), obsluhu formulářů, zabezpečení atd. Pokud jste použili MVC, napište o tom.
Dokumentace ve zdrojovém kódu
Budete muset popsat své vlastní funkce, které používáte. Například, jedna z mých funkcí kontroluje zadané uživatelské jméno (login). Děláme to proto, abychom později vygenerovali správný kód. Je potřeba napsat, co funkce dělá, jaké parametry obsahuje a co vrací.
Například:
/**
*
* Get string length.
*
* Returns Boolean True if the length matches our requirement.
*
* @param string $login The `string` being measured for length.
* @return bool `True` if the `string` on success,
* and `False` if the `string` is not success.
*
*/
Generated documentation from source code — Např. PHPDoc, PHPDocumentor, Doxygen, Apigen…
Použil jsem Doxygen.
1. krok.
2. krok. (odkaz zde)
Poté program nainstalujte.
3. krok
Popis práce v Doxygen
Bude vygenerována dokumentace. Až nahrajete dokumentaci na server, stačí na ni zadat odkaz.
Good job.
Vytvořte na svém webu novou stránku: document.php. A na tuto stránku vytvořte odkazy na své dokumenty z GoogleDrive.
<a href=»https://docs.google.com/document/d/neco-neco/»> Full task</a>
Toto je jedna z možností, jak vytvořit dokumentaci. Můžete to použít pro inspiraci.
Pokud máte nějaké dotazy, nebo máte nápad, co bychom mohli přidat, můžete mi napsat sem. Odpovím co nejdříve.
