Системната документация се състои от писмен материал, използван за описание на приложенията на компютърен хардуер или софтуерна система. Документацията може да бъде показана като печатни ръководства, флаш карти, уеб страници или текстов помощен текст. Системната документация е жизненоважен компонент на успеха на всяка компютърна система. Въпреки това, много разработчици имат труден път да създадат достатъчно документация за своите продукти. Различните видове документация имат различни цели, така че съдържанието на всяка документация ще зависи от предназначената за нея аудитория.
Проектна документация
Целта на проектната документация описва проекта като цяло. Проектната документация дава на ръководителите, мениджърите и служителите широк поглед върху предлаганите от проекта методи, ресурси и цели. Документите за проектно предложение показват, че изпълнителите са поставили целите и бюджета на проекта. Техническите спецификации очертават хардуерните и софтуерните изисквания за проектите. Планът на проекта описва подробно стъпките, които програмистите, техниците и дизайнерите ще предприемат, за да постигнат целите на проекта.
Документация за изпитване
Тестовите документи илюстрират плановете за тестване на продукта преди неговото освобождаване. Отделът за осигуряване на качеството разработва планове за тестване както за вътрешни "алфа" потребители, така и за външни "бета" тестери.Документацията за тестване включва инструкции за тестване - като специфичен набор от стъпки, които тестерите трябва да следват - за да се определи дали продуктът функционира както е планирано. Персоналът по осигуряване на качеството също събира журнали за проблеми, списъци с бъгове и доклади от тестери.
Документация на екипа
Обменът на идеи между членовете на екипа е жизненоважен за успеха на проекта. Екипната документация записва този обмен за използване по текущия проект и за бъдещи проекти. Екипните планове, графиците и актуализациите на състоянието са основни компоненти на екипната документация. Контролните списъци помагат на мениджърите на проекти да видят какви задачи е изпълнил екипът. Протоколите от екипните срещи позволяват на мениджърите да проследяват различни въпроси, предложения и задачи между членовете на екипа.
Документация на потребителя
Най-важният елемент на системната документация е съдържанието, което достига до клиента. Потребителската документация трябва да бъде свободна от прекалено технически жаргон и да съдържа ясен и сбит език. Ръководството за потребителя обикновено е основният компонент на потребителската документация, но потребителите също разчитат на други източници. Ресурсите за обучение - включително ръководства и видеоклипове - могат да помогнат на потребителите бързо и лесно да разберат как работи системата. Когато системата не функционира според очакванията, ръководство за отстраняване на неизправности може да помогне на потребителя да намери и реши проблема.
