Состав комплекта эксплуатационной документации на программный продукт зависит от архитектуры последнего, назначения его компонентов и особенностей пользовательской аудитории.
Наиболее распространенные типы эксплуатационных документов приведены в табл. 2.
Документ
| Аудитория
| Примерное содержание
|
описание программы
| лица, принимающие решения о приобретении, вводе в эксплуатацию и способах использования программы
| назначение и основные возможности программы, необходимые ей нее системные ресурсы, входные и выходные данные
|
описание применения
|
описание языка
| пользователи языка (программисты, операторы, кодеры, верстальщики)
| основная идея языка, его синтаксис, элементы и конструкции, встроенные функции
|
паспорт
| лица, ответственные за эксплуатацию программы
| краткие сведения о программе и условиях ее поставки
|
руководство администратора
| ответственный пользователь системы, обеспечивающий ее целевое применение
| управление учетными записями пользователей, назначение пользователям прав доступа, ведение нормативно-справочной информации, загрузка и выгрузка данных
|
руководство оператора
| операторы, работающие с системой, частью которой является программа
| порядок выполнения предусмотренных операций, сообщения программы и предписанные оператору способы реакции на них
|
руководство пользователя
| пользователи программы, т.е. лица, применяющие ее для решения собственных прикладных задач
| назначение и возможности программы, ее основные концепции, интерфейс пользователя, порядок решения типовых задач, описание функций программы
|
руководство программиста
| программисты, сопровождающие программу или использующие ее в качестве платформы либо средства разработки при создании собственных программ
| архитектура программы или создаваемых на ее основе приложений, описание программных интерфейсов к ее объектам, протоколов обмена данными и т. п.
|
руководство системного администратора(системного программиста)
| системные администраторы, осуществляющие установку программы и поддерживающие систему в рабочем состоянии
| установка программы, ее интеграция в систему, проверка правильности функционирования, устранение аварийных ситуаций
|
спецификация
| лица, ответственные за эксплуатацию программы
| комплект поставки программы
|
справочная система («хелп»)
| пользователи, операторы, администраторы, системные администраторы, программисты и др.
| материал всех имеющихся руководств и описаний, краткие описания элементов интерфейса пользователя программы
|
формуляр
| лица, ответственные за эксплуатацию программы
| краткие сведения о программе и условиях ее поставки, записи эксплуатационного о возникающих сбоях и прочих событиях такого рода
|