Next: Špatné nebo žádné členění
Up: Dokumentace
Previous: Pravopisné chyby
  Obsah
Dokumentace by měla dodržovat všechny slohové zásady jako kterýkoliv jiný psaný
text. Jedněmi z nejčastěstějších chyb jsou příliš dlouhá a šroubovaná
souvětí. Aby byl text srozumitelný, nesmí obsahovat souvětí o více než 2
větách. Samozřejmě se tohoto pravidla nejde držet vždy. Ovšem věta která tvoří
celý odstavec je zcela nepochopitelná (to si může dovolit jenom spisovatel
s kvalitami Bohumila Hrabala - viz Obsluhoval jsem anglického krále :-)).
Další chybou je časté používání stejných výrazů. Pokud musíte často používat
stejný výraz, je dobré jej označit zkratkou. Například místo neustálého
opakování
...genetický algoritmus...genetickém algoritmu...genetického
algoritmu...
je lepší zavést při prvním použití zkratku a tu pak dále používat
...genetický algoritmus (GA)...GA...GA...
David Martinek
2002-10-01