ГОСТ 19.503—79 Единая система программной документации. Руководство системного программиста. Требования к содержанию и оформлению. Unified system for program documentation. System programmer's guide. Requirements for contents and form of presentation. УДК 651.7/.78:681.3.06:002:006.354 МКС 35.080. Редакция от 07.11.2023.
1 Общие положения ГОСТ 19.503-79
1.1 Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105—78.
Составление информационной части (аннотации и содержания) является обязательным [из 1.1 ГОСТ 19.503—79]
1.2 Руководство системного программиста должно содержать следующие разделы:
- общие сведения о программе (1);
- структура программы (2);
- настройка программы (3);
- проверка программы (4);
- дополнительные возможности (5);
- сообщения системному программисту (6).
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые.
В обоснованных случаях допускается раздел «Дополнительные возможности» не приводить, а в наименованиях разделов опускать слово «программа» или заменять его на «наименование программы» [из 1.2 ГОСТ 19.503—79]
2 Содержание разделов ГОСТ 19.503-79
2.1 В разделе «Общие сведения о программе» должна быть указаны назначение (1.1) и функции программы (1.2) и сведения о технических и программных средствах, обеспечивающих выполнение данной программы (1.3) [из 2.1 ГОСТ 19.503—79]
2.2 В разделе «Структура программы» должны быть приведены сведения о структуре программы (2.1), ее составных частях (2.2), о связях между составными частями (2.3) и о связях с другими программами (2.4) [из 2.2 ГОСТ 19.503—79]
2.4 В разделе «Проверка программы» должно быть приведено описание способов проверки, позволяющих дать общее заключение о работоспособности программы (4.1) (контрольные примеры (4.2), методы прогона (4.3), результаты (4.4)) [из 2.4 ГОСТ 19.503—79]
2.5 В разделе «Дополнительные возможности» должно быть приведено описание дополнительных разделов функциональных возможностей программы (5.1) и способов их выбора (5.2) [из 2.5 ГОСТ 19.503—79]
2.6 В разделе «Сообщения системному программисту» должны быть указаны тексты сообщений, выдаваемых в ходе выполнения настройки (6.1), проверки программы (6.2), а также в ходе выполнения программы (6.3), описание их содержания и действий, которые необходимо предпринять по этим сообщениям (6.4) [из 2.6 ГОСТ 19.503—79]
2.7 В приложении (7) к руководству системного программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.) [из 2.7 ГОСТ 19.503—79]
