Документація системи складається з письмового матеріалу, що використовується для опису програм комп'ютерної апаратної або програмної системи. Документацію можна відображати у вигляді друкованих посібників, флеш-карт, веб-сторінок або екранного довідкового тексту. Документація системи є важливою складовою успіху будь-якої комп'ютерної системи. Проте багато розробників мають важкий час створення достатньої документації для своєї продукції. Різні типи документації мають різні цілі, тому зміст будь-якої документації буде залежати від його цільової аудиторії.
Проектна документація
Метою проектної документації є опис проекту в цілому. Документація проекту дає керівникам, керівникам та співробітникам широке уявлення про запропоновані в проекті методи, ресурси та цілі. Документи проектної пропозиції показують керівникам цілі та бюджет проекту. Технічні характеристики описують апаратні та програмні вимоги до проектів. У плані проекту детально описуються кроки, які програмісти, технічні фахівці та дизайнери візьмуть для досягнення цілей проекту.
Тестова документація
Тестові документи ілюструють плани тестування продукту до його випуску. Відділ забезпечення якості розробляє плани тестування як для внутрішніх користувачів "alpha", так і для зовнішніх "бета-тестерів".Документація з тестування включає в себе інструкції з тестування, такі як певний набір кроків, яким повинні дотримуватися тестери, щоб визначити, чи продукт функціонує як заплановано. Співробітники QA також збирають журнали випуску, списки помилок і звіти тестувальників.
Командна документація
Обмін ідеями між членами команди є життєво важливим для успіху проекту. Командна документація фіксує ці обміни для використання на поточному проекті та на майбутніх проектах. Командні плани, графіки та оновлення статусу є основними компонентами командної документації. Контрольні списки допомагають менеджерам проектів бачити, які завдання завершила команда. Протоколи зустрічей команди дозволяють менеджерам відстежувати різні питання, пропозиції та завдання серед членів команди.
Документація користувача
Найбільш важливим елементом документації системи є вміст, який досягає клієнта. Документація користувача повинна бути вільною від надмірно технічного жаргону та містити чітку, лаконічну мову. Посібник користувача зазвичай є основним компонентом документації користувача, але користувачі також покладаються на інші джерела. Навчальні ресурси, включаючи посібники та відео, можуть допомогти користувачам швидко і легко зрозуміти, як працює система. Якщо система не працює належним чином, керівництво з усунення несправностей допоможе користувачеві знайти та вирішити проблему.
