Co je dokumentace?

Pokyny pro používání počítačového zařízení nebo programu. Dokumentace se může objevit v různých formách, nejběžnější jsou manuály. Když si kupujete počítačový produkt (hardware nebo software), dodává se téměř vždy s jedním nebo více manuály, které popisují, jak produkt nainstalovat a provozovat. Mnoho softwarových produktů navíc obsahuje online verzi dokumentace, kterou můžete zobrazit na obrazovce nebo vytisknout na tiskárně. Speciální typ online dokumentace je systém nápovědy, který má dokumentaci zabudovanou do programu. Systémy nápovědy se často nazývají kontextové, protože zobrazují různé informace v závislosti na poloze (kontextu) uživatele v aplikaci.

Dokumentace je často rozdělena do následujících kategorií:

instalace: Popisuje, jak nainstalovat program nebo zařízení, ale ne jak je používat.

odkaz: Podrobný popis jednotlivých položek v abecedním pořadí. Referenční dokumentace je určena pro lidi, kteří již produkt trochu znají, ale potřebují připomenutí nebo velmi konkrétní informace o konkrétním tématu.

tutorial: Učí uživatele, jak produkt používat. Výukové programy se pohybují pomalejším tempem než referenční příručky a obecně obsahují méně podrobností.

Uživatelé počítačů často naráží na to, že jejich dokumentace je nevyzpytatelná. Naštěstí se tato situace zlepšuje, a to především díky pokroku v systémech nápovědy a online výukovým programům. Tyto formy dokumentace výrazně usnadňují poskytování konkrétních informací, které uživatel potřebuje, když je potřebuje.