Руководство системного программиста

Руководство системного программиста — документ в составе комплекта программной документации. Предусмотрен ЕСПД. Разрабатывается на стадии рабочего проекта.

Стандарты

ГОСТ 19.503—79

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

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

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

• общие сведения о программе;
• структура программы;
• настройка программы;
• проверка программы;
• дополнительные возможности;
• сообщения системному программисту.
  

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

(Измененная редакция, Изм. № 1).

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

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

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

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

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

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

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

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

Практика

Руководство системного программиста в современной линейке документов соответствует, скорее, руководству системного администратора, чем руководству программиста.

Шаблоны

Шаблон	Описание
Филогост	Комплект шаблонов и пустографок для Microsoft Word