Co je to 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 jinak interakce s počítačem. Tento software by mohl výrobce poskytnout jako systémová součást nebo vytvořen jako samostatné aplikace výrobcem nebo třetími stranami. Dokumentace je popis produktu a jak jej používat. Softwarová dokumentace popisuje softwarové aplikace a jak je používat. 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 podle potřeby uvedeny samostatné průvodce. Instalační příručka uvádí specifikace, které jsou potřebné ke spuštění softwaru, včetně počítačového operačního systému (systémů), RAM, pevného disku, internetového připojenín a jakékoli další požadavky nebo doplňky, jako jsou periferie. Následuje pokyny krok za krokem pro instalaci, které mohou být například z CD-ROM, DVD nebo ke stažení. Obecně jsou vysvětleny jakékoli neobvyklé funkce instalátoru a vysvětlení vlastních instalačních možností, jako jsou alternativní umístění nebo zefektivněné instalace.
Příručka „Quick Start“ je často další částí použité tištěné softwarové dokumentace. Průvodce rychlým startem, který se zvedne, kde odchází s instalační příručkou, pomáhá 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, protože vyhovuje konkrétnímu softwaru. Jednou z populárních metod pro aplikace zaměřené na úkoly je úvod založený na projektu, ve kterém se uživatel učí základní funkčnost softwaru při dokončování některých mini-ležů.
Další prvky, které by člověk vyloučilT v tištěné softwarové dokumentaci zahrnuje úplný rozběh funkcí s důrazem na nové funkce pro nejnovější verzi; Seznam aktualizací od předchozích verzí, možná včetně chyb; informace o tom, jak získat technickou podporu; vysvětlení chybových zpráv; a informace pro pokročilé nebo „energetické“ uživatele. Hry a další softwarové aplikace mohou do jejich dokumentace zahrnovat cheat listy nebo rady.
tištěná dokumentace softwaru není jediný druh. Nejprve může být tištěná dokumentace k dispozici také online nebo jako PDF. Další dokumentace může být také k dispozici ve formě tipů na nástroje a obrazovky nápovědy v rámci samotné aplikace, FAQ - seznamy často kladených otázek spolu s odpověďmi, prohledávatelnými články, webovými školeními, videi a dalšími formáty.
Softwarová dokumentace se liší v kvalitě, a to platí zejména pro softwarové příručky. Ty dobří mohou být vynikající, zatímco zapnutíES, které nejsou dobře provedené, mohou uživatelům nechat mnoho otázek. Existují také uživatelé, kteří se nebudou obtěžovat prohledat dokumentaci, než se zeptají na fóra výrobce softwaru.