Требования к структуре руководства системного программиста по ГОСТ 19 устанавливаются ГОСТ 19.503. В общем случае документ должен состоять из следующих разделов:
1. Структура программы
2. Настройка программы
3. Проверка программы
4. Дополнительные возможности
5. Сообщения системному программисту
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые.
В обоснованных случаях допускается раздел «Дополнительные возможности» не приводить, а в наименованиях разделов опускать слово «программа» или заменять его на «наименование программы».
Примечание
Эти и другие требования к структуре и содержанию руководства системного программиста по ГОСТ 19 подробнее см. ГОСТ 19.503
Документ оформляется в соответствии с правилами предусмотренными ГОСТ 19.105, ГОСТ 19.106 и другими стандартами Единой системы программной документации (ЕСПД).
(по ГОСТ 19.503-79. ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению)
Настоящий стандарт устанавливает требования к
содержанию и оформлению программного документа «Руководство системного
программиста», определённого ГОСТ 19.101-77. Структуру и оформление документа устанавливают в
соответствии с ГОСТ 19.105-78. Составление информационной части (аннотации и
содержания) является обязательным.
==================================
Скачать пример оформления
| .B.00001-01 32 01 (Руководство системного программиста) (пример — .pdf) |
587 421 b | Загрузить |
| A.B.00001-01 32 01 (Руководство системного программиста) (шаблон — .doc) |
26 071 b | Загрузить |
На верх
==================================
Рекомендуемая структура программного документа (по ГОСТ 19.503-79. ЕСПД)
- Лист утверждения
- Титульный лист
- Аннотация
- Содержание
- Основная часть
- Общие сведения о программе
- Назначение программы
- Функции программы
- Минимальный состав технических средств
- Минимальный состав программных средств
- Требования к персоналу (системному программисту)
- Структура программы
- Сведения о структуре программы
- Сведения о составных частях программы
- Сведения о связях между составными частями программы
- Сведения о связях с другими программами
- Настройка программы
- Настройка на состав технических средств
- Настройка на состав программных средств
- Проверка программы
- Описание способов проверки
- Методы прогона
- Контрольные примеры
- Результаты
- Дополнительные возможности (необязательны)
- Описание дополнительных разделов функциональных возможностей программы
- Способы выбора дополнительных возможностей
- Сообщения системному программисту
- Приложения (необязательны)
- Регистрация изменений
На верх
==================================
<Предыдущий>
<Содержание> <Следующий>
ГОСТ 19.503-79 Руководство системного программиста. Требования к содержанию и оформлению
ГОСТ 19.503-79 Руководство системного программиста. Требования к содержанию и оформлению
|
УДК 651.7/.78:681.3.06:002:006.354 |
Группа Т55 |
Г О С У Д А Р С Т В Е Н Н Ы Й С Т А Н Д А Р Т С О Ю З А С С Р
|
Единая система программной документации |
ГОСТ 19.503-79*(СТ СЭВ 2094-80) |
РУКОВОДСТВО СИСТЕМНОГО ПРОГРАММИСТА.
|
|
|
United system for program documentation. |
Постановлением Государственного комитета стандартов Совета Министров СССР от 12 января 1979 г. № 74 срок введения установлен
с 01.01. 1980 г.
Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Руководство системного программиста», определённого ГОСТ 19.101-77.
Стандарт полностью соответствует СТ СЭВ 2094-80.
1. ОБЩИЕ ПОЛОЖЕНИЯ
1.1. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.
Составление информационной части (аннотации и содержания) является обязательным.
1.2. Руководство системного программиста должно содержать следующие разделы:
- общие сведения о программе;
- структура программы;
- настройка программы;
- проверка программы;
- дополнительные возможности;
- сообщения системному программисту.
В зависимости от особенностей документы допускается объединять отдельные разделы или вводить новые.
В обоснованных случаях допускается раздел «Дополнительные возможности» не приводить, а в наименованиях разделов опускать слово «программа» или заменять его на «наименование программы».
(Измененная редакция, Изм. № 1).
2. СОДЕРЖАНИЕ РАЗДЕЛОВ
2.1. В разделе «Общие сведения о программе» должна быть указаны назначение и функции программы и сведения о технических и программных средствах, обеспечивающих выполнение данной программы.
2.2. В разделе «Структура программы» должны быть приведены сведения о структуре программы, ее составных частях, о связях между составными частями и о связях с другими программами.
2.3. В разделе «Настройка программы» должно быть приведено описание действий по настройке программы на условия конкретного применения (настройка на состав технических средств, выбор функций и др.).
При необходимости приводят поясняющие примеры.
2.4. В разделе «Проверка программы» должны быть приведено описание способов проверки, позволяющих дать общее заключение о работоспособности программы (контрольные примеры, методы прогона, результаты).
2.5. В разделе «Дополнительные возможности» должно быть приведено описание дополнительных разделов функциональных возможностей программы и способов их выбора.
2.6. В разделе «Сообщения системному программисту» должны быть указаны тексты сообщений, выдаваемых в ходе выполнения настройки, проверки программы, а также в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
2.7. В приложении к руководству системного программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.).
*Переиздание (Ноябрь 1987 г.) с Изменением № 1, утвержденным в сентябре 1981 г (ИУС 11-81)