Руководство системного программиста
Руководство системного программиста относится к эксплуатационно-технической документации. Документ предоставляет сведения для проверки, обеспечения функционирования и конфигурирования программы, если данные возможности обусловлены системным кодом ПО.
Во многих компаниях установка и глубокая настройка некоторых программ обычным пользователям запрещена. Данная работа входит в список обязанностей системного программиста, который проверяет логи, обеспечивает автоматическое резервное копирование данных, ведет статистику производительности и устраняет технические неполадки.
Все перечисленные функции отображаются в документе «Руководство системного программиста». Данный документ разрабатывается и оформляется в соответствии с нормативами ГОСТ 19.503-79, а также сопутствующими ГОСТ 19.101-77 (Виды программных документов) и ГОСТ 19.105-78 (Общие требования к программным документам).
Структура документа
Руководство системного программиста должно включать всю необходимую информацию, чтобы разработчик имел возможность настраивать и поддерживать функциональность программного обеспечения (системы). Типовая структура документа приведена в ГОСТ 19.503-79 и включает:
1. Общие сведения о программе.
— Описывается назначение и функции программы.
2. Структура программы.
— Составные части, компоненты, их связь и структура программы.
3. Настройка программы.
— Отображаются необходимые действия по настройке программы в конкретных условиях применения, с использованием примеров.
4. Проверка программы.
— Описываются способы проверки, которые устанавливают работоспособность программы;
5. Дополнительные возможности.
— Описание дополнительного функционала и разделов программы.
6. Сообщения системному программисту.
— Указываются тексты сообщений, которые выдаются во время проверки и настройки программы.
7. Приложения.
— Иллюстрации, графики, таблицы и примеры.
Содержание руководства
Если руководство разрабатывается на простую монолитную программу, то документ получается относительно необъемным. Однако крупные аппаратно-программные комплексы требуют описания каждого компонента, чтобы обеспечить их интеграцию, а также работоспособность со сторонним ПО.
В зависимости от типа программы и способа ее настройки также может включаться другая информация (интерфейс, утилиты командной строки, язык для скриптов и т.д.).
Оформите заявку и задавайте все интересующие вас вопросы по телефону +7(499)755-74-33 e-mail Этот адрес электронной почты защищён от спам-ботов. У вас должен быть включен JavaScript для просмотра. или через форму заказа.
|
УДК |
Группа |
Г О С У Д А Р
С Т В Е Н Н Ы Й С Т А Н Д А Р Т С О Ю
З А С С Р
|
Единая |
ГОСТ 19.503-79*(СТ СЭВ 2094-80) |
РУКОВОДСТВО
|
|
|
United system for |
Постановлением Государственного
комитета стандартов Совета Министров
СССР от 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)
Конец
формы
Руководство
32 — РУКОВОДСТВО СИСТЕМНОГО ПРОГРАММИСТА по ГОСТ 19.503-79 (пример, образец)
- Документы
- Программные
Пример (образец) документа Руководство системного программиста по ГОСТ 19.503-79, взаимоувязанный разделами (подразделами, пунктами и подпунктами) с комплектом программных документов, выполненным согласно требованиям Единой системы программной документации (ЕСПД). Редакция от 01.02.2023.
- 32 — РУКОВОДСТВО СИСТЕМНОГО ПРОГРАММИСТА по ГОСТ 19.503-79
- Руководство ☠ Системный ☠ Программист ☠ Пример ☠ Образец
- Открыть в новой вкладке
33 — РУКОВОДСТВО ПРОГРАММИСТА по ГОСТ 19.504-79 (пример, образец)
- Документы
- Программные
Пример (образец) документа Руководство программиста по ГОСТ 19.504-79, взаимоувязанный разделами (подразделами, пунктами и подпунктами) с комплектом программных документов, выполненным согласно требованиям Единой системы программной документации (ЕСПД). Редакция от 01.02.2023.
- 33 — РУКОВОДСТВО ПРОГРАММИСТА по ГОСТ 19.504-79
- Руководство ☠ Программист ☠ Пример ☠ Образец
- Открыть в новой вкладке
34 — РУКОВОДСТВО ОПЕРАТОРА по ГОСТ 19.505-79 (пример, образец)
- Документы
- Программные
Пример (образец) документа Руководство оператора по ГОСТ 19.505-79, взаимоувязанный разделами (подразделами, пунктами и подпунктами) с комплектом программных документов, выполненным согласно требованиям Единой системы программной документации (ЕСПД). Редакция от 01.02.2023.
- 34 — РУКОВОДСТВО ОПЕРАТОРА по ГОСТ 19.505-79
- Руководство ☠ Оператор ☠ Пример ☠ Образец
- Открыть в новой вкладке
Высшее руководство (top management) по ГОСТ ISO 9000-2011
- Терминология
Лицо или группа работников, осуществляющих руководство и управление организацией на высшем уровне [из 3.2.7 ГОСТ ISO 9000-2011]
- Из ГОСТ ISO 9000-2011 Системы менеджмента качества. Основные положения и словарь
- Management ☠ Top ☠ Высший ☠ Руководство
⇪В 17360 💥
- Открыть в новой вкладке
Высшее руководство (top management) по ГОСТ Р 54147-2010
- Терминология
Лицо или группа работников, осуществляющих направление деятельности и управление организацией на высшем уровне [из 3.2.12 ГОСТ Р 54147-2010]
- Из ГОСТ Р 54147-2010 Стратегический и инновационный менеджмент. Термины и определения
- Высший ☠ Руководство ☠ Top ☠ Management
⇪В 32354 💥
- Открыть в новой вкладке
Высшее руководство (top management) по ГОСТ Р ИСО 37100-2018
- Терминология
Лицо или группа лиц, осуществляющие руководство и управление организацией на высшем уровне.
Примечания
- Высшее руководство имеет власть делегировать полномочия и предоставлять ресурсы в рамках своей организации.
- Под высшим руководством следует понимать группу лиц в организации, отвечающую за принятие решений, которой сообщество официально или неофициально поручает имплементацию системы менеджмента.
- В случае если область применения системы менеджмента охватывает только часть организации, тогда высшее руководство относится к тем, кто руководит и управляет данной частью организации.
[из 3.3.2 ГОСТ Р ИСО 37100-2018]
- Из ГОСТ Р ИСО 37100-2018 Устойчивое развитие и адаптивность сообществ. Словарь
- Management ☠ Top ☠ Высший ☠ Руководство
⇪В 21186 💥
- Открыть в новой вкладке
Документация руководств (guidance documentation) по ГОСТ Р ИСО/МЭК 15408-1-2012
- Терминология
Документация, описывающая поставку, установку, конфигурирование, эксплуатацию, управление и (или) использование ОО (TOE) [из 3.1.36 ГОСТ Р ИСО/МЭК 15408-1-2012]
- Из ГОСТ Р 15408-1-2012 Информационная технология. Методы и средства обеспечения безопасности. Критерии оценки безопасности информационных технологий. Часть 1. Введение и общая модель
- Documentation ☠ Guidance ☠ Документация ☠ Руководство
⇪В 28372 💥
- Открыть в новой вкладке
Интерактивное электронное техническое руководство по ГОСТ Р 53394-2017
- Терминология
Обобщенное название для взаимосвязанной совокупности эксплуатационных документов, выполненных в форме интерактивного электронного документа по ГОСТ 2.051 и, как правило, содержащихся в одной общей базе данных эксплуатационной документации.
Примечание — Английский эквивалент термина «интерактивное электронное техническое руководство» — interactive electronic technical manual [из 3.40 ГОСТ Р 53394-2017]
- Из ГОСТ Р 53394-2017 Интегрированная логистическая поддержка. Термины и определения
- Интерактивный ☠ Руководство ☠ Технический ☠ Электронный
⇪В 26574 💥
- Открыть в новой вкладке
Интерактивное электронное техническое руководство, ИЭТР по ГОСТ 2.601-2013
- Терминология
Обобщенное название для взаимосвязанной совокупности эксплуатационных документов, выполненных в форме интерактивного электронного документа по ГОСТ 2.051 и, как правило, содержащихся в одной общей базе данных эксплуатационной документации [из 3.1.5 ГОСТ 2.601-2013]
- Из ГОСТ 2.601-2013 Единая система конструкторской документации. Эксплуатационные документы
- Интерактивный ☠ Электронный ☠ Технический ☠ Руководство ☠ ИЭТР
⇪В 27811 💥
⇪В 30069 💥
- Открыть в новой вкладке
Интерактивное электронное техническое руководство, ИЭТР по ГОСТ Р 54088-2017
- Терминология
Совокупность электронных документов, технических данных и программно-технических средств, предназначенная для информационного обеспечения процессов использования по назначению и технической эксплуатации изделия и (или) его составных частей и предоставляющая пользователям возможность прямой и обратной связи между пользователем и руководством в режиме реального времени с помощью интерфейса электронной системы отображения.
Примечания
- Интерактивность отражает способность электронной системы отображения информации обеспечивать диалог с пользователем через пользовательский интерфейс системы путем генерации взаимных запросов пользователем и системой и выдачей ответов на эти запросы. Интерактивность обеспечивается наличием в электронной системе отображения необходимых элементов управления (кнопки, «флажки», поля для ввода данных и т.д.).
- Английский эквивалент термина «интерактивное электронное техническое руководство» — interactive electronic technical manual.
- Программно-технические средства в составе интерактивного электронного технического руководства включают электронную систему отображения и другие необходимые средства (например, драйверы, утилиты шифрования и др.).
[из 3.1.1 ГОСТ Р 54088-2017]
- Из ГОСТ Р 54088-2017 Интегрированная логистическая поддержка. Эксплуатационная и ремонтная документация в форме интерактивных электронных технических руководств. Основные положения и общие требования
- Интерактивный ☠ ИЭТР ☠ Руководство ☠ Технический ☠ Электронный
⇪В 24360 💥
- Открыть в новой вкладке
Страницы
- 1
- 2
- 3
- следующая ›
- последняя »
ГОСТ 19.503-79
Группа Т55
МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ
Единая система программной документации
РУКОВОДСТВО СИСТЕМНОГО ПРОГРАММИСТА
Требования к содержанию и оформлению
Unified system for program documentation. System programmer’s guide. Requirements for contents and form of presentation
МКС 35.080
Дата введения 1980-01-01
Постановлением Государственного комитета CCCР по стандартам от 12 января 1979 г. N 74 дата введения установлена 01.01.80
ИЗДАНИЕ (январь 2010 г.) с Изменением N 1, утвержденным в сентябре 1981 г. (ИУС 11-81).
Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Руководство системного программиста», определенного ГОСТ 19.101-77.
Стандарт полностью соответствует СТ СЭВ 2094-80*.
(Измененная редакция, Изм. N 1).
1. ОБЩИЕ ПОЛОЖЕНИЯ
1.1. Структура и оформление программного документа устанавливаются в соответствии с ГОСТ 19.105-78.
Составление информационной части (аннотации и содержания) является обязательным.
1.2. Руководство системного программиста должно содержать следующие разделы:
общие сведения о программе;
структура программы;
настройка программы;
проверка программы;
дополнительные возможности;
сообщения системному программисту.
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые.
В обоснованных случаях допускается раздел «Дополнительные возможности» не приводить, а в наименованиях разделов опускать слово «программа» или заменять его на «наименование программы».
(Измененная редакция, Изм. N 1).
2. СОДЕРЖАНИЕ РАЗДЕЛОВ
2.1. В разделе «Общие сведения о программе» должны быть указаны назначение и функции программы и сведения о технических и программных средствах, обеспечивающих выполнение данной программы.
2.2. В разделе «Структура программы» должны быть приведены сведения о структуре программы, ее составных частях, о связях между составными частями и о связях с другими программами.
(Измененная редакция, Изм. N 1).
2.3. В разделе «Настройка программы» должно быть приведено описание действий по настройке программы на условия конкретного применения (настройка на состав технических средств, выбор функций и др.).
При необходимости приводят поясняющие примеры.
2.4. В разделе «Проверка программы» должно быть приведено описание способов проверки, позволяющих дать общее заключение о работоспособности программы (контрольные примеры, методы прогона, результаты).
2.5. В разделе «Дополнительные возможности» должно быть приведено описание дополнительных разделов функциональных возможностей программы и способов их выбора.
2.6. В разделе «Сообщения системному программисту» должны быть указаны тексты сообщений, выдаваемых в ходе выполнения настройки, проверки программы, а также в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
2.7. В приложении к руководству системного программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.).
2010/04/29 13:40:51
ГОСТ Стандарт документирования программного обеспечения
ГОСТ при разработке программных продуктов дает возможность:
- унифицировать программные изделия для взаимного обмена и применения ранее разработанных программ в новых разработках;
- снизить трудоемкость и повысить эффективность разработки, сопровождения, изготовления и эксплуатации программных продуктов;
- автоматизировать изготовление и хранение программной документации.
Единая система документации программной продукции – ЕСПД – относится к ГОСТ класса 19 и подразделяется на 10 групп:
1. Основополагающие стандарты.
2. Правила выполнения документации разработки.
3. Правила выполнения документации изготовления.
4. Правила выполнения документации сопровождения.
5. Правила выполнения эксплуатационной документации.
6. Правила обращения программной документации.
Стандарт с номером 0 содержит общие положения, стандарты 7 и 8 являются зарезервированными и к номеру 9 относятся прочие стандарты, не вошедшие в первые 6.
Это краткие описания ГОСТов класса 19, для более подробного ознакомления с ними необходимо обратиться к справочникам.
- ГОСТ 19.001-77 – единая система программной документации.
- ГОСТ 19.101-77 – виды программ и программных документов.
- ГОСТ 19.102-77 – стадии разработки программ и программной документации.
- ГОСТ 19.105-78 – требования к оформлению программных документов, комплексов и систем независимо от их назначения и области применения. ГОСТ 19.105-78 содержит полный перечень документации, которая должна сопровождать законченный программный продукт.
Перечень документации, декларируемой ГОСТ 19.105-78:
1. Документы, содержащие сведения, необходимые для разработки программного продукта, его изготовления.
1.1. Спецификация – состав программы и документации на нее.
1.2. Ведомость держателей подлинников – перечень предприятий, на которых хранятся подлинники программной документации.
1.3. Текст программы – запись текста программы с необходимыми комментариями.
1.4. Описание программы – сведения о логической и функциональной структуре программы.
1.5. Программа и методика испытаний – требования, подлежащие проверке при испытании программы, порядок и методы их контроля.
1.6. Техническое задание – назначение и область применения программы, технические и специальные требования, необходимые стадии и сроки разработки, виды испытаний.
1.7. Пояснительная записка – схема алгоритма, общее описания алгоритма, выполняемая программой функция. Объяснение принятых технических решений.
2. Документы, используемые при эксплуатации программного продукта.
Ведомость эксплуатационных документов – перечень эксплуатационных документов на программу.
Формуляр – основные характеристики программы, комплектность, общие сведения об эксплуатации программы.
Описание применения – сведения о назначении программы, области применения, классе решаемых задач, ограничения на применение, необходимая конфигурация технических средств.
Руководство системного программиста – сведения для проверки и обеспечения функциональности, настройки программы.
Руководство программиста – сведения для эксплуатации настроенной программы.
Руководство оператора – сведения для обеспечения процедуры общения оператора с ЭВМ в процессе выполнения программы.
Описание языка – описание синтаксиса и семантики языка, используемого в программе.
Руководство по техническому обслуживанию – сведения для применения тестовых программ при обслуживании технических средств.
Другие ГОСТы класса 19:
- ГОСТ 19.201-78 – порядок построения и оформления технического задания на разработку программы или программного изделия.
- ГОСТ 19.202-78 – форма и порядок составления спецификации на программные продукты, определяемые в ГОСТ 19.101-77.
- ГОСТ 19.301-79 – программа и методика испытаний программных продуктов.
- ГОСТ 19.401-78 – порядок построения и оформления текста программы при разработке программных продуктов.
- ГОСТ 19.402-78 – описание программы.
- ГОСТ 19.403-79 – форма заполнения и содержание ведомости держателей подлинников, определяемой в ГОСТ 19.105-78.
- ГОСТ 19.404-79 – форма заполнения и содержание пояснительной записки, определяемой в ГОСТ 19.105-78.
- ГОСТ 19.501-78 – форма заполнения и содержание формуляра на программный продукт, определяемый в ГОСТ 19.105-78.
- ГОСТ 19.502-78 – форма заполнения и содержание описания применения, определяемого в ГОСТ 19.105-78.
- ГОСТ 19.503-79 – форма заполнения и содержание руководства системного программиста, определяемого в ГОСТ 19.105-78.
- ГОСТ 19.504-79 – форма заполнения и содержание руководства программиста, определяемого в ГОСТ 19.105-78.
- ГОСТ 19.505-79 – форма заполнения и содержание руководства оператора, определяемого в ГОСТ 19.105-78.
- ГОСТ 19.506-79 – форма заполнения и содержание описания языка, определяемого в ГОСТ 19.105-78.
- ГОСТ 19.507-79 – форма заполнения и содержание ведомости эксплуатационных документов, определяемой в ГОСТ 19.105-78.
- ГОСТ 19.508-79 – форма заполнения и содержание руководства по техническому обслуживанию, определяемому в ГОСТ 19.105-78.
- ГОСТ 19.701-90 – схемы алгоритмов, программ, данных и систем.