Co je softwarová dokumentace?
Software se týká rutin a programů vyvinutých pro počítačový systém, které umožňují použití k provádění úkolů nebo k jiným interakcím s počítačem. Software by mohl být poskytován výrobcem jako komponenta systému, nebo vytvořen jako samostatné aplikace výrobcem nebo třetími stranami. Dokumentace je popis produktu a jeho použití. Softwarová dokumentace popisuje softwarové aplikace a jejich použití.
Tištěná softwarová dokumentace, někdy označovaná jako softwarové manuály, je často nastavena jako kniha s titulní stránkou, obsahem, tělem a indexem a často mají některé typické komponenty. První komponentou, kterou většina uživatelů potřebuje, je instalační příručka a pro různé operační systémy, na kterých software pracuje, jsou uvedeny samostatné průvodce, podle potřeby. Instalační příručka uvádí specifikace, které jsou potřebné ke spuštění softwaru, včetně počítačových operačních systémů, RAM, místa na pevném disku, připojení k internetu a dalších požadavků nebo doplňků, jako jsou periferie. Následuje postupná instalace, která může být například z disku CD-ROM, DVD nebo ke stažení. Obecně jsou vysvětleny všechny neobvyklé funkce instalačního programu a vysvětlení vlastních možností instalace, jako jsou alternativní umístění nebo zjednodušená instalace.
Příručka „rychlého startu“ je často další částí použité tištěné softwarové dokumentace. Průvodce rychlým startem, který vyzvedne, kde instalační příručka odpadne, pomůže uživateli začít se softwarem a jeho základními operacemi. Tato část může být uspořádána různými způsoby, jak se hodí pro konkrétní software. Jednou z populárních metod pro aplikace zaměřené na úkoly je projektový úvod, ve kterém se uživatel učí základní funkčnost softwaru při absolvování některých lekcí.
Mezi další prvky, které by se dalo očekávat v tištěné softwarové dokumentaci, patří úplné shrnutí funkcí s důrazem na funkce nové v nejnovější verzi; seznam aktualizací od předchozích verzí, případně včetně opravených chyb; informace o tom, jak získat technickou podporu; vysvětlení chybových zpráv; a informace pro pokročilé nebo „mocné“ uživatele. Hry a další softwarové aplikace mohou ve své dokumentaci obsahovat cheatové listy nebo rady.
Dokumentace tištěného softwaru není jediným druhem. V první řadě může být tištěná dokumentace k dispozici také online nebo jako pdf. Další dokumentace může být k dispozici také ve formě tipů na nástroje a obrazovek nápovědy v samotné aplikaci, FAQs - seznamy často kladených otázek spolu s odpověďmi, články, které lze prohledávat, školení na webu, videa a další formáty.
Kvalifikace softwarové dokumentace se velmi liší, a to platí zejména pro softwarové manuály. Ty dobré mohou být vynikající, zatímco ty, které nejsou dobře provedené, mohou uživatelům ponechat mnoho otázek. Existují také uživatelé, kteří se neobtěžují prohledávat dokumentaci dříve, než položí otázky na fórech výrobce softwaru.