Документирование программных изделий ЕСПД

       

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


Аннотация и содержание обязательны.

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

  • Общие сведения о программе - назначение и функции программы и сведения о технических и программных средствах, обеспечивающих выполнение данной программы.
  • Структура программы - сведения о структуре программы, ее составных частях, о связях между составными частями и о связях с другими программами.
  • Настройка программы - описание действий по настройке программы на условия конкретного применения (настройка на состав технических средств, выбор функций и др.).
  • Проверка программы - описание способов проверки, позволяющих дать общее заключение о работоспособности программы (контрольные примеры, методы прогона, результаты).
  • Дополнительные возможности - описание дополнительных разделов функциональных возможностей программы и способов их выбора.
  • Сообщения системному программисту - тексты сообщений, выдаваемых в ходе выполнения программы, описания их содержания и действий, которые необходимо выполнять по этим сообщениям.
В зависимости от особенностей документа допускается объединять отдельные разделы и вводить новые.
В обоснованных случаях допускается раздел "Дополнительные возможности" не приводить, а в наименованиях разделов опускать слово "программа" или заменять его на "наименование программы".

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

Перечень документов

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