Руководство Системного программиста Гост 19.503-79 пример

Руководство Системного программиста Гост 19.503-79 пример.rar
Закачек 574
Средняя скорость 4308 Kb/s

разработка техдокументации

Главное меню

Руководство системного программиста по ГОСТ 19.503-79

/>

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

Составление информационной части (аннотации и содержания) является обязательным [из п. 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]

Г О С У Д А Р С Т В Е Н Н Ы Й С Т А Н Д А Р Т С О Ю З А С С Р

Единая система программной документации

(СТ СЭВ 2094-80)

РУКОВОДСТВО СИСТЕМНОГО ПРОГРАММИСТА.
ТРЕБОВАНИЯ К СОДЕРЖАНИЮ И ОФОРМЛЕНИЮ

United system for program documentation.
System programmer’s guide. Requirements to contents and form of presentation

Постановлением Государственного комитета стандартов Совета Министров СССР от 12 января 1979 г. № 74 срок введения установлен

Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Руководство системного программиста», определённого ГОСТ 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)

В этом разделе собраны шаблоны документов для разработки технической документации согласно ГОСТ 19, ГОСТ 34 и др. Надеемся они Вам пригодятся. Обсудить все тонкости разработки технической документации согласно ГОСТ вы можете на форуме разработчиков технической документации или в комментариях под каждым из шаблонов.

Все шаблоны предоставляются бесплатно!

Если не нашли шаблона, то пишите здесь

Если у Вас есть шаблоны документов, которых еще нет в этом каталоге, то просим прислать их на нашу почту. Помогите своим коллегам!

Благодарность за помощь в пополнении коллекции выражаем: Максиму Казначееву

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

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

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

Настоящий шаблон устанавливает состав и требования к содержанию программного документа «Руководство системного программиста». Разделы шаблона соответствуют требованиям ГОСТ 19.503-79.

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

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

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

Допускается содержание разделов иллюстрировать пояснительными примерами, таблицами, схемами, графиками.


Статьи по теме