Техническая документация

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

Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.

Составление информационной части (аннотации и содержания) является обязательным [из п. 1.1 ГОСТ 19.503-79]

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

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

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

В обоснованных случаях допускается раздел «Дополнительные возможности» не приводить, а в наименованиях разделов опускать слово «программа» или заменять его на «наименование программы» [из п. 1.2 ГОСТ 19.503-79]

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

Общие сведения о программе

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

Структура программы

В разделе «Структура программы» должны быть приведены сведения о структуре программы , ее составных частях , о связях между составными частями и о связях с другими программами [из п. 2.2 ГОСТ 19.503-79]

Настройка программы

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

При необходимости приводят поясняющие примеры [из п. 2.3 ГОСТ 19.503-79]

Проверка программы

В разделе «Проверка программы» должно быть приведено описание способов проверки, позволяющих дать общее заключение о работоспособности программы (контрольные примеры , методы прогона , результаты ) [из п. 2.4 ГОСТ 19.503-79]

Дополнительные возможности

В разделе «Дополнительные возможности» должно быть приведено описание дополнительных разделов функциональных возможностей программы и способов их выбора [из п. 2.5 ГОСТ 19.503-79]

Сообщения системному программисту

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

Приложения

В приложении к руководству системного программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.) [из п. 2.7 ГОСТ 19.503-79]