Приложение 14. Руководство системного программиста (ГОСТ 19.503-79)
|
Составление информационной части (аннотации и содержания) является обязательным.
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые.
В обоснованных случаях допускается раздел "Дополнительные возможности" не приводить, а в наименованиях разделов опускать слово "программа" или заменять его на "наименование программы".
1. ОБЩИЕ СВЕДЕНИЯ
В разделе должны быть указаны назначение и функции программы и сведения о технических и программных средствах, обеспечивающих выполнение данной программы.
2. СТРУКТУРА ПРОГРАММЫ
В разделе должны быть приведены сведения о структуре программы, ее составных частях, о связях между составными частями и о связях с другими программами.
3. НАСТРОЙКА ПРОГРАММЫ
В разделе должно быть приведено описание действий по настройке программы на условия конкретного применения (настройка на состав технических средств, выбор функций и др.).
При необходимости приводят поясняющие примеры.
4. ПРОВЕРКА ПРОГРАММЫ
В разделе должно быть приведено описание способов проверки, позволяющих дать общее заключение о работоспособности программы (кон трольные примеры, методы прогона, результаты).
5. ДОПОЛНИТЕЛЬНЫЕ ВОЗМОЖНОСТИ
В разделе должно быть приведено описание дополнительных разделов функциональных возможностей программы и способов их выбора.
6. СООБЩЕНИЯ СИСТЕМНОМУ ПРОГРАММИСТУ
В разделе должны быть указаны тексты сообщений, выдаваемых в хо де выполнения настройки, проверки программы, а также в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
В приложении к документу могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.).