9 Описание содержания разделов документа «Руководство программиста»

9.1. Руководство программиста должно содержать следующие разделы:

• назначение и условие применения программы;

• характеристики программы;

• обращение к программе;

• сообщения;

• приложения.

9.2. Обозначение документа «Руководство программиста»:

ДП.230105.XX.YY. 33

где 33 – код документа «Руководство программиста».

9.3. Структура и оформление, содержание документа должны устанавливаться по ГОСТ 19.504-79.

9.4. В разделе «Назначение и условие применения программы» должны быть указаны: цели, основные задачи, назначения и функции, выполняемые программой, условия, необходимые для выполнения программы (минимальная конфигурация ЭВМ, объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программному обеспечению и т.п.), полная информация обо всех возможных вариантах работы программы;

9.5. В разделе «Характеристики программы» должно быть приведено описание основных характеристик и особенности программы (тип носителя информации, временные характеристики, режим работы, средств контроля правильности выполнения, само восстанавливаемость программы и т.п.); детальное изложение языковых средств, служащих для описания данных и запросов на обработку; описание исходных, промежуточных и основных массивов, обрабатываемых и составляемых программой; организация и обновление массивов данных; сведения о процедурах работы с данными, можно описать таблицы, которые будут хранить данные с подробным указанием свойств и идентификаторов каждого поля (атрибута).

9.6. В разделе «Обращение к программе» должно быть приведено описание процедуры вызова программы (способы передачи управления и параметров данных и др.). В зависимости от темы диплома данный раздел может отсутствовать.

9.7. Раздел «Сообщения» содержит описание появляющихся диалоговых окон с соответствующими сообщениями о возникающих ошибках, недопустимых значениях, об окончании заполнения форм и прочее.

9.8. В приложении к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и структуры баз данных, схемы взаимодействия программы и др.).

10 Описание и содержания разделов документа «Руководство пользователя»

10.1. Руководство пользователя или оператора должно иметь следующие разделы:

• назначение программы;

• условия выполнения программы;

• выполнение программы;

• сообщение пользователю.

10.2. Обозначение документа:

ДП.230105.XX.YY. 34

где 34 – код документа «Руководство пользователя».

10.3. Содержание документа определяется ГОСТ 19.505-79.

10.4. В разделе «Назначение программы» должны быть указаны сведения, необходимые для эксплуатации программы: требования к операционной системе, требования минимальной конфигурации для установки и эксплуатации программы.

10.5. В разделе «Выполнение программы» должны быть указаны последовательные действия работы созданного программного комплекса и описание имеющихся кнопок (или других элементов управления); порядок работы в появляющихся окнах. Т.е. должна быть указана подробная инструкция по эксплуатации программы и взаимодействие с ней группы пользователей, последовательность действий пользователя, обеспечивающих вызов программы, приведено описание функций, форматы и возможные варианты команд, с помощью которых пользователь осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды.

10.6. В разделе «Сообщение пользователю» должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия пользователя в случае сбоя, возможность повторного запуска программы и т.п., описание всех диагностических сообщений, выдаваемых системой, и действия пользователя по устранению той или иной ошибки.

10.7. Допускается содержание разделов дополнять соответствующими иллюстрациями, пояснительными примерами, таблицами, схемами и графиками.

10.8. В приложении к руководству пользователя допускается включать различные материалы, которые не целесообразно включать в разделы руководства.