Popis algoritmu. Popis algoritmu by měl být pokud možno jasný a relativně "vysokoúrovňový". Jsou v něm důležité myšlenky algoritmu, ne jeho implementace
(a např. názvy proměnných).
Diskuze výběru algoritmu. To je jedna z nejdůležitějších částí dokumentace. V ní ukazujete, jak jste nad problémem přemýšleli a že jste vůbec
přemýšleli nad různými možnostmi. Také je zde důležité popsat, proč jste se rozhodli pro výsledný algoritmus.
(Přičemž není nutně špatně v rozhodování zahrnout i náročnost naprogramování - pokud máte jiné části dostatečně náročné a pokud splníte zadání.)
Diskuze výběru datových struktur. Zde platí to samé jako při výběru algoritmu. V některých zápočťácích však není důvod používat nic speciálního.
Nicméně stejně doporučuji se zamyslet nad možnostmi, které znáte: hashování, stromy, spojové seznamy apod.
Struktura a úprava celého textu, stavba vět + spisovná a srozumitelná čeština/slovenština. Ač to může znít zbytečně, je dobré si dát záležet i na úpravě dokumentace.
Cílem je, aby se dobře četla a byla co nejlépe pochopitelná. To kupodivu není vůbec lehké. Ale umět psát hezké texty je schopnost, která se do života velmi hodí a
není od věci si ji trénovat již od co nejdříve. Na co si dát tedy pozor:
Že dává každá věta smysl a že věty na sebe navazují.
Že v textu nejsou pravopisné chyby, překlepy a že text obsahuje diakritiku. Pro kontrolu překlepů leckdy pomohou různé vestavěné automatické kontroly, jako např. ve
Wordu či Open Office.
Pokud by se někde hodilo schéma či obrázek, bude hodnoceno velmi pozitivně, pokud ho tam dáte. Je to sice trochu práce navíc, ale může to pomoci srozumitelnosti.
Pokud se chcete do budoucna naučit něco praktického např. pro psaní bakalářky/diplomky, není od věci se naučit psát v TeXu či LaTeXu.
Vyžaduje to sice vstupní časovou investici, ale může to člověk brát jako něco, co se mu může dlouhodobě vyplatit. Pokud tedy již tuto dokumentaci napíšete v TeXu,
bude to hodnoceno velmi kladně. (Ale rozhodně to není potřeba, ani to nevynahradí podstatné nedostatky jinde.;))
