Systémová dokumentace se skládá z písemného materiálu používaného k popisu aplikací hardwarového nebo softwarového systému počítače. Dokumentaci lze zobrazit jako tištěné příručky, karty flash, webové stránky nebo text nápovědy na obrazovce. Systémová dokumentace je zásadní součástí úspěchu libovolného počítačového systému. Nicméně, mnoho vývojářů má obtížné vytvářet dostatečnou dokumentaci pro své produkty. Různé typy dokumentace mají různé cíle, takže obsah jakékoli dokumentace bude záviset na předpokládaném publiku.
Dokumentace projektu
Účel projektové dokumentace popisuje projekt jako celek. Projektová dokumentace poskytuje manažerům, manažerům a zaměstnancům široký přehled o navrhovaných metodách, zdrojích a cílech projektu. Dokumenty o návrhu projektu ukazují vedoucím pracovníkům cíle a rozpočet projektu. Technické specifikace vymezují požadavky na hardware a software pro projekty. Plán projektu podrobně popisuje kroky, které programátoři, technici a projektanti přijmou k dosažení cílů projektu.
Testovací dokumentace
Testovací doklady znázorňují plány testování výrobku před jeho uvolněním. Oddělení zabezpečování jakosti vyvíjí plány testování jak pro interní uživatele "alfa", tak pro externí testy "beta".Testovací dokumentace obsahuje zkušební instrukce - například konkrétní sadu kroků, které musí testeři dodržovat - aby zjistili, zda produkt funguje podle plánu. Pracovníci QA také sbírají protokoly o problémech, seznamy chyb a zprávy od testery.
Dokumentace týmu
Výměna názorů mezi členy týmu je zásadní pro úspěch projektu. Týmová dokumentace zaznamenává tyto výměny pro použití v aktuálním projektu a v budoucích projektech. Týmové plány, plány a aktualizace stavu jsou hlavními součástmi týmové dokumentace. Kontrolní seznamy pomáhají projektovým manažerům zobrazit úkoly, které tým dokončil. Zápisy z týmových setkání umožňují manažerům sledovat různé problémy, návrhy a úkoly mezi členy týmu.
Uživatelská dokumentace
Nejdůležitějším prvkem systémové dokumentace je obsah, který dosáhne zákazníka. Uživatelská dokumentace musí obsahovat neomezený technický žargon a musí obsahovat jasný a stručný jazyk. Uživatelská příručka je obvykle hlavní součástí uživatelské dokumentace, ale uživatelé také spoléhají na jiné zdroje. Zdroje pro školení - včetně příruček a videí - mohou uživatelům pomoci rychle a snadno pochopit, jak funguje systém. Pokud systém nepracuje podle očekávání, může průvodce uživatelem pomoci najít a vyřešit problém.
