Dokumentacja systemu składa się z pisemnego materiału opisującego zastosowania sprzętu komputerowego lub oprogramowania. Dokumentacja może być wyświetlana jako drukowane podręczniki, karty flash, strony internetowe lub tekst pomocy na ekranie. Dokumentacja systemu jest istotnym elementem sukcesu każdego systemu komputerowego. Jednak wielu programistów ma trudności z utworzeniem wystarczającej dokumentacji dla swoich produktów. Różne typy dokumentacji mają różne cele, więc treść jakiejkolwiek dokumentacji będzie zależeć od docelowej grupy odbiorców.
Dokumentacja projektu
Celem dokumentacji projektowej opisuje projekt jako całość. Dokumentacja projektowa zapewnia dyrektorom, menedżerom i pracownikom szeroki wgląd w proponowane metody, zasoby i cele projektu. Dokumenty propozycji projektów pokazują kierownikom cele i budżet projektu. Specyfikacje techniczne określają wymagania sprzętowe i programowe dla projektów. Plan projektu określa kroki, jakie programiści, technicy i projektanci będą podejmować, aby osiągnąć cele projektu.
Dokumentacja testowa
Dokumenty testowe ilustrują plany testowania produktu przed jego wydaniem. Dział zapewnienia jakości opracowuje plany testów zarówno dla wewnętrznych użytkowników "alfa", jak i zewnętrznych testerów wersji beta.Dokumentacja testowa zawiera instrukcje testowania - takie jak określony zestaw kroków, które muszą wykonać testerzy - w celu ustalenia, czy produkt działa zgodnie z planem. Pracownicy działu kontroli jakości również zbierają dzienniki problemów, listy błędów i raporty od testerów.
Dokumentacja zespołu
Wymiana pomysłów pomiędzy członkami zespołu ma kluczowe znaczenie dla powodzenia projektu. Dokumentacja zespołu zapisuje te wymiany do wykorzystania w bieżącym projekcie i przyszłych projektach. Plany zespołu, harmonogramy i aktualizacje statusu są głównymi składnikami dokumentacji zespołu. Listy kontrolne pomagają kierownikom projektów zobaczyć, jakie zadania zakończył zespół. Protokoły z posiedzeń zespołu pozwalają kierownikom śledzić różne problemy, sugestie i zadania członków zespołu.
Dokumentacja użytkownika
Najważniejszym elementem dokumentacji systemu jest treść docierająca do klienta. Dokumentacja użytkownika musi być wolna od zbyt technicznego żargonu i zawierać jasny, zwięzły język. Instrukcja użytkownika jest zazwyczaj głównym elementem dokumentacji użytkownika, ale użytkownicy również polegają na innych źródłach. Materiały szkoleniowe - w tym podręczniki i filmy - mogą pomóc użytkownikom w szybkim i łatwym zrozumieniu działania systemu. Gdy system nie działa zgodnie z oczekiwaniami, przewodnik rozwiązywania problemów może pomóc użytkownikowi znaleźć i rozwiązać problem.
