Другие разделы

Данный комплекс стандартов и руководящих документов предусматривает описание требований и к другим видам обеспечения:

– Требования к содержанию документов с решениями по техническому обеспечению

– Требования к содержанию документов с решениями по информационному обеспечению

– Требования к содержанию документов с решениями по математическому обеспечению

Принципы разработки руководства программиста

Требования к содержанию руководства программиста изложены в ГОСТ 19.504-79. Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Руководство программиста».

Общие положения

Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78. Составление информационной части (аннотации и содержания) является обязательным. Руководство программиста должно содержать следующие разделы:

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

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

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

– входные и выходные данные;

– сообщения.

В зависимости от особенностей документы допускается объединять отдельные разделы или вводить новые.

Содержание разделов

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

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

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

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

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

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

Разработка руководства пользователя