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

• Общие сведения
• Цели и задачи
• Содержание документа
• Методика и стиль изложения
• Типовая структура

Общие сведения

Цели и задачи

Есть пользователи, операторы, администраторы, которым приходится непосредственно работать с программой. А есть менеджеры (или в каких-то случаях ведущие специалисты), которые сами могут к программе не притрагиваться, но принимают решения относительно приобретения программы и порядка ее применения. Им необходимо понимать, что программа 'умеет', и каких ресурсов она потребует. Проинформировать их об этом - задача таких документов, как описание программы и описание применения.

Содержание документа

В описании программы и описании применения должно быть сказано:

• для чего предназначена программа, какие задачи она позволяет решать;
• какие ресурсы необходимы для выполнения программы;
• какие данные программа принимает на вход;
• что программа выдает в качестве выходных данных.

Описание программы предполагает большую, а описание применения меньшую подробность изложения.

Методика и стиль изложения

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

Типовая структура

Структура описания программы, согласно ГОСТ 19.402-78.

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

Структура описания применения согласно ГОСТ 19.502-78.

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