Описание программы и описание применения


Единая информация

Документация принадлежит к типу программно-эксплуатационной. Объединяет в себе пакеты документов по программе, комплексу и программным компонентам системы или комплекса. Создается для людей, от которых зависит принятие решения о покупке, настройке и вариантах применения программы. Все документы соответствуют стандартам 19.402-78 и 19.502-78.

Предмет и назначение

Персонал, соприкасающийся в своей работе с программой, подразделяется на тех, кто с ней работает (пользователи, администраторы, операторы и т.д.) и тех, от кого зависит принятие решения по ее покупке и использованию (ведущие специалисты, менеджеры и т.д.). Специалисты в полной мере владеют информацией о возможностях программы и ее функционале. Эти сведения они получают из документации: описание программы и ее применение.

Содержание

1. Цель программы, ее функциональные возможности;
2. Требуемые ресурсы для эксплуатации;
3. Вводимая информация;
4. Выходные сведения.
При описании программы текст максимально подробный, применение же описывается структурно.

Методология и язык написания

Не принципиальные подробности в данных документах не допустимы, т.к. они не дают пользователю понять главную суть документа. Акцент делается на перечне задач, решаемых при помощи данной программы и средствах их решения.

Стандартная структура - согласно ГОСТ 19.402-78.

1. Общие сведения.
2. Функциональное назначение.
3. Описание логической структуры.
4. Применяемые технические устройства.
5. Вызов и загрузка.
6. Входные данные.
7. Выходные данные.

Стандартная структура - согласно ГОСТ 19.502-78.

1. Назначение программы.
2. Условия применения.
3. Описание задачи.
4. Входные и выходные данные.