Руководство программиста информационной системы: назначение документа, его разделы и их содержание.
Руководство программиста (ГОСТ 19.504-79) должно содержать след разделы:
1. Назначение и условия применения программы.
Указывается назначение и функции, выполняемые программой; условия необходимые для выполнения программы: объем оперативной памяти, требования к составу и параметрам ПУ, требования к ПО и т.д.
2. Характеристики программы.
Описываются основные характеристики и особенности программы: режимы работы, средства контроля правильности выполнения и самовосстановления программы и др.
3. Обращение к программе.
Рассматриваются процедуры вызова программы (способы передачи управления и параметры данных). При необходимости приводятся поясняющие примеры.
4. Входные и выходные данные.
Описываются: организация используемой входной и выходной информации, при необходимости – кодирование данной информации.
5. Сообщения.
Приводятся тексты сообщений, выдаваемых программисту или пользователю в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
Руководство пользователя информационной системы: назначение документа, его разделы и их содержание.
Руководство пользователя должно содержать след разделы:
1. Введение.Указывается:
- область применения и краткое описание возможностей;
- уровень подготовки пользователя;
- перечень документации, с которыми нужно ознакомиться пользователю.
|
|
2. Назначение и условия применения.Описываются:
- виды деятельности; задачи(функции), для решения которых предназначена программа;
- условия, при которых обеспечивается работа программы в соответствии с назначением.
3. Подготовка к работе.Рассматриваются:
- состав и содержание дистрибутивного носителя данных;
- порядок загрузки данных и программ;
- порядок проверки работоспособности разработанного ПО.
4. Описание операций.Указывают:
- описание всех выполняемых функций, задач, процедур;
- описание операций, которые необходимы для выполнения функций, задач, процедур.
Для операции приводят: наименование; условия выполнения операции; подготовительные действия; последовательность основных действий; заключительные действия; ресурсы, расходуемые на операцию. В описании действий допускаются ссылки на файлы подсказок.
5. Аварийные ситуации.Рассматриваются:
- действия в случае несоблюдения условий выполнения;
- действия по восстановлению программ и или данных при отказе носителей данных или обнаружении ошибок в данных;
- действия в случае обнаружения несанкционированного вмешательства в данные;
- действия в других аварийных ситуациях.
Рекомендации по освоению.
Приводятся: рекомендации по освоению и эксплуатации разработанного ПО.
Дата добавления: 2018-05-02; просмотров: 234; Мы поможем в написании вашей работы! |
Мы поможем в написании ваших работ!