Navzdory teorii a metodikám vývoje, které považují dokumentaci k softwaru jako jeho nezbytnou součást, prosazuji názor, že software by měl být tak jednoduchý, že dokumentaci nepotřebuje.

Z prvního pohledu na uživatelské rozhraní musí být jasné, jak se software ovládá. Pokud tomu tak není, je ovládání frustrující a uživatelé náš systém nebudou používat. Jak toho dosáhneme?

• Snížíme počet ovládacích prvků (odkazů, tlačítek) na minimum.
• Neaktivní ovládací prvky raději úplně schováme.
• Použijeme velký font a graficky spojíme společné části (barvou, blokem).
• Nejdůležitější ovládací prvky zvýrazníme odlišnou barvou. Pokud třeba máme e-mail software, pořád by mělo být vidět velké tlačítko či odkaz “Napsat e-mail”.

Dokumentace se píše především proto, aby zdůvodnila vysokou cenu software a uspokojila pedantní klienty, které chtějí držet “něco v ruce”. Software je měkký a nelze si ho strčit do tašky, ale 500-stránkovou dokumentaci ano. Pokud klient vymění více dokumentace za méně funkcionality, tak pro takového klienta raději nepišme a najděme si rozumnějšího.

Potíž s dokumentací je její permanentní neaktuálnost a cena. Vývojáři dokumentaci udržovat aktuální nebudou a člověk, který to má na starost to bude dělat nerad, takže podle toho bude dokumentace vypadat.

Neznám člověka, který by dokumentaci četl rád. Je tedy jedno, co obsahuje, hlavně by měla mít hodně stránek, pěknou vazbu a pokud možno barevné obrázky, aby se pěkně výjimala v knihovně, když už ji nikdo číst nebude ;). Praktická zkušenost mě naučila, že dokumentací se také dobře zatápí v kamnech.

Někdy samozřejmě dokumentace musí existovat. Tuto výjimku tvoří vysoce specializované systémy, které používají dokumentaci jako externí odkladiště informací či znalostí. Stále si však myslím, že pokud už dokumentace musí existovat, tak ať je raději součástí systému v té nejjednodušší formě, např. formou častých otázek a odpovědí (FAQ).