При розробці ПС створюється великий обсяг різноманітної документації. Вона необхідна як засіб передачі інформації між розробниками ПС, як засіб управління розробкою ПС і як засіб передачі користувачам інформації, необхідної для застосування і супроводу ПС. На створення цієї документації доводиться велика частка вартості ПС.
Цю документацію можна розбити на дві групи:
Документи управління розробкою ПС.
Документи, що входять до складу ПС.
Документи управління розробкою ПС. протоколюють процеси розробки та супроводу ПС, забезпечуючи зв'язки всередині колективу розробників і між колективом розробників і менеджерами - особами, які керують розробкою. Ці документи можуть бути наступних типів:
Плани, оцінки, розкладу. Ці документи створюються менеджерами для прогнозування і управління процесами розробки і супроводу.
Звіти про використання ресурсів в процесі розробки. Створюються менеджерами.
Стандарти. Ці документи наказують розробникам, яким принципам, правилам, угодами вони повинні слідувати в процесі розробки ПС. Ці стандарти можуть бути як міжнародними або національними, так і спеціально створеними для організації, в якій ведеться розробка даного ПС.
Робочі документи. Це основні технічні документи, що забезпечують зв'язок між розробниками. Вони містять фіксацію ідей і проблем, що виникають в процесі розробки, опис використовуваних стратегій і підходів, а також робочі (тимчасові) версії документів, які повинні увійти в ПС.
Нотатки і листування. Ці документи фіксують різні деталі взаємодії між менеджерами і розробниками.
Документи, що входять до складу ПС. описують програми ПС як з точки зору їх застосування користувачами, так і з точки зору їх розробників і супровідників (відповідно до призначення ПС). Тут слід зазначити, що ці документи будуть використовуватися не тільки на стадії експлуатації ПС (в її фазах застосування і супроводу), але і на стадії розробки для управління процесом розробки (разом з робочими документами) - у всякому разі вони повинні бути перевірені (протестовані) на відповідність програмам ПС. Ці документи утворюють два комплекти з різним призначенням:
Призначена для користувача документація ПС (П-документація).
Документація по супроводженню ПС (С-документація).
Призначена для користувача документація програмних засобів.
Призначена для користувача документація ПС пояснює користувачам, як вони повинні діяти, щоб застосувати дане ПС. До такої документації належать документи, якими керується користувач при інсталяції ПС (при установці ПС з відповідною настроюванням на середу застосування ПС), при застосуванні ПС для вирішення своїх завдань і при управлінні ПС (наприклад, коли дане ПС взаємодіє з іншими системами).
ординарних користувачів ПС
Ординарний користувач ПС використовує ПС для вирішення своїх завдань (в своїй предметній області). Це може бути інженер, який проектує технічний пристрій, або касир, який продає залізничні квитки за допомогою ПС. Він може і не знати багатьох деталей роботи комп'ютера або принципів програмування.
Адміністратор ПС управляє використанням ПС ординарними користувачами і здійснює супровід ПС, не пов'язане з модифікацією програм. Наприклад, він може регулювати права доступу до ПС між простими користувачами, підтримувати зв'язок з постачальниками ПС або виконувати певні дії, щоб підтримувати ПС в робочому стані, якщо вона була придбана як частина в іншу систему.
Склад користувальницької документації для досить великих ПС:
Загальний функціональний опис ПС. Дає коротку характеристику функціональних можливостей ПС. Призначено для користувачів, які повинні вирішити, наскільки необхідно їм дане ПС.
Керівництво по інсталяції ПС. Призначено для системних адміністраторів. Він повинен детально наказувати, як встановлювати системи в конкретному середовищі. Він повинен містити опис машинно-зчитує носія, на якому поставляється ПС, файли, що представляють ПС, і вимоги до мінімальної конфігурації апаратури.
Інструкція по застосуванню ПС. Призначена для ординарних користувачів. Містить необхідну інформацію щодо застосування ПС, організовану у формі зручній для її вивчення.
Довідник по застосуванню ПС. Призначений для ординарних користувачів. Містить необхідну інформацію щодо застосування ПС, організовану у формі зручній для виборчого пошуку окремих деталей.
Керівництво з управління ПС. Призначено для системних адміністраторів. Воно повинно описувати повідомлення, що генеруються, коли ПС взаємодіє з іншими системами, і як реагувати на ці повідомлення. Крім того, якщо ПС використовує системну апаратуру, цей документ може пояснювати, як супроводжувати цю апаратуру.