Systémová dokumentácia pozostáva z písaného materiálu, ktorý sa používa na opis aplikácií počítačového hardvéru alebo softvérového systému. Dokumentáciu možno zobraziť ako tlačené príručky, karty Flash, webové stránky alebo text nápovedy na obrazovke. Systémová dokumentácia je dôležitou súčasťou úspechu počítačového systému. Mnoho vývojárov však má náročný čas vytvárať dostatočnú dokumentáciu pre svoje produkty. Rôzne typy dokumentácie majú rôzne ciele, takže obsah každej dokumentácie bude závisieť od jej zamýšľaného publika.
Dokumentácia projektu
Účelom projektovej dokumentácie je projekt ako celok. Projektová dokumentácia poskytuje manažérom, manažérom a zamestnancom široký pohľad na navrhované metódy, zdroje a ciele projektu. Dokumenty o návrhu projektu ukazujú výkonným pracovníkom ciele a rozpočet projektu. Technické špecifikácie vymedzujú hardvérové a softvérové požiadavky na projekty. Plán projektu podrobne popisuje kroky, ktoré programátori, technici a dizajnéri urobia na dosiahnutie cieľov projektu.
Testovacia dokumentácia
Skúšobné dokumenty znázorňujú plány na testovanie výrobku pred jeho uvoľnením. Oddelenie zabezpečenia kvality vyvíja testovacie plány pre interných užívateľov "alfa" aj externých testerov "beta".Testovacia dokumentácia obsahuje pokyny na testovanie - ako napríklad špecifická sada krokov, ktorú musia testeri dodržiavať - aby zistili, či produkt funguje podľa plánu. Zamestnanci QA zhromažďujú denníky problémov, zoznamy chýb a správy od testerov.
Tímová dokumentácia
Výmena názorov medzi členmi tímu je nevyhnutná pre úspech projektu. Tímová dokumentácia zaznamenáva tieto výmeny na použitie v súčasnom projekte a na budúcich projektoch. Tímové plány, plány a aktualizácie stavu sú hlavnými komponentmi tímovej dokumentácie. Kontrolné zoznamy pomáhajú projektovým manažérom zobraziť, ktoré úlohy dokončili tím. Zápisy z tímových stretnutí umožňujú manažérom sledovať rôzne problémy, návrhy a úlohy medzi členmi tímu.
Dokumentácia používateľa
Najdôležitejším prvkom systémovej dokumentácie je obsah, ktorý sa dostane k zákazníkovi. Užívateľská dokumentácia nesmie obsahovať príliš technický žargón a musí obsahovať jasný a stručný text. Používateľská príručka je zvyčajne hlavnou súčasťou používateľskej dokumentácie, ale používatelia sa tiež spoliehajú na iné zdroje. Zdroje školení - vrátane príručiek a videí - môžu používateľom pomôcť rýchlo a ľahko pochopiť, ako funguje systém. Ak systém nepracuje podľa očakávania, môže pomôcť užívateľovi nájsť a vyriešiť problém.
