Стандарт ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению. Объяснение простым языком

Краткое назначение стандарта ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению

ГОСТ 19.503-79 определяет, как нужно писать и оформлять документ «Руководство системного программиста» (сегодня его чаще называют руководством системного администратора). В стандарте прописаны обязательные разделы: общая информация о программе, её устройство, настройка, проверка работоспособности, дополнительные функции и список системных сообщений. Также документ обязательно должен содержать аннотацию и оглавление.

Область применения стандарта ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению

Требования ГОСТ 19.503-79 распространяются на «Руководства системного программиста» (или руководства системных администраторов) для любых программ и систем, которые разрабатываются по правилам Единой системы программной документации (ЕСПД), независимо от того, где и для чего они будут использоваться.

Основные термины в стандарте ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению

Исходя из ГОСТ 19.503-79 и смежных правил для системных администраторов, в документации выделяются такие ключевые понятия:

• Руководство системного программиста (в современных реалиях – руководство системного администратора) – документ, в котором собрана вся информация для установки, настройки, проверки и обслуживания программы на компьютерах и серверах.
• Информационная часть – аннотация и содержание (их наличие в документе обязательно).
• Общие сведения о программе – обязательный раздел о том, зачем нужна программа, что она делает и какое железо или софт ей требуются для работы.
• Структура программы – обязательный раздел, объясняющий из каких частей состоит программа и как они связаны между собой и с другими программами.
• Настройка программы – обязательный раздел с инструкциями по адаптации ПО под конкретные условия работы.
• Проверка программы – обязательный раздел, где описано, как проверить, работает ли программа (например, с помощью тестовых примеров).
• Дополнительные возможности – раздел о дополнительных функциях (если их нет, раздел можно опустить).
• Сообщения системному программисту – обязательный раздел со списком всех сообщений, которые программа выдаёт при настройке и работе, и подсказками, что делать при их появлении.

Краткое содержание стандарта ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению

ГОСТ 19.503-79 входит в комплекс ЕСПД и задает правила для создания «Руководства системного программиста» (сегодня – руководства сисадмина). Этот стандарт полностью совпадает с международным документом СТ СЭВ 2094-80.

Основные положения и структура документа
* Документ оформляется по общим стандартам ЕСПД.
* В начале обязательно должны быть аннотация и оглавление (информационная часть).
* Разрешается объединять некоторые разделы или добавлять новые, если это оправданно. Раздел «Дополнительные возможности» можно не включать, если таких возможностей нет, а слово «программа» в названиях разделов можно опускать или заменять на реальное имя софта.

Обязательные разделы руководства
По стандарту документ состоит из следующих частей:
1. Общие сведения о программе – назначение, функции и требования к аппаратно-программной среде.
2. Структура программы – из каких модулей она состоит и как они взаимодействуют.
3. Настройка программы – как подготовить ПО к работе под конкретное окружение.
4. Проверка программы – тестовые примеры и способы проверки работоспособности.
5. Дополнительные возможности – описание дополнительных функций (можно опустить при необходимости).
6. Сообщения системному программисту – тексты ошибок и системных уведомлений с инструкциями для администратора.

Часто задаваемые вопросы (FAQ) по стандарту ГОСТ 19.503-79 «ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению»

1. Что представляет собой стандарт ГОСТ 19.503-79 и каково его главное назначение?

Ответ: Это государственный стандарт из системы ЕСПД. Он устанавливает четкие правила к содержанию, структуре и оформлению документа под названием «Руководство системного программиста» (сейчас это аналог руководства системного администратора).

2. С какими международными нормативными документами гармонизирован данный стандарт?

Ответ: ГОСТ 19.503-79 полностью соответствует международному стандарту СТ СЭВ 2094-80.

3. Является ли обязательным включение информационной части в состав руководства системного программиста?

Ответ: Да. Первый пункт стандарта четко говорит, что аннотация и оглавление в этом документе должны быть обязательно.

4. Каковы требования к общей структуре и оформлению документа?

Ответ: Документ должен оформляться по общим правилам стандартов ЕСПД, которые регулируют всю техническую и эксплуатационную документацию.

5. Какой базовый набор разделов должен содержать этот документ согласно стандарту?

Ответ: Согласно пункту 1.2, руководства должно включать шесть разделов:
1. Общие сведения о программе.
2. Структура программы.
3. Настройка программы.
4. Проверка программы.
5. Дополнительные возможности.
6. Сообщения системному программисту.

6. Можно ли изменять стандартный состав разделов или объединять их?

Ответ: Да, стандарт позволяет проявлять гибкость. Разделы можно объединять или дополнять новыми, если это нужно для конкретного проекта. Раздел «Дополнительные возможности» разрешается убрать, а слово «программа» в заголовках – заменить на название самого продукта.

7. Что именно должно быть указано в разделе «Общие сведения о программе»?

Ответ: Здесь прописывают, что делает программа, какие у нее функции, а также какое железо (компьютеры, оборудование) и софт (операционная система, библиотеки) нужны для ее запуска.

8. Каково содержание разделов «Структура программы» и «Настройка программы»?

Ответ:
* В разделе «Структура программы» объясняется архитектура софта: из каких частей он состоит и как связан с другими программами.
* В разделе «Настройка программы» расписано, как адаптировать софт под конкретные задачи и железо.

9. Что описывается в разделах «Проверка программы» и «Дополнительные возможности»?

Ответ:
* В разделе «Проверка программы» дают инструкции, как протестировать софт и убедиться, что он работает правильно (обычно приводят примеры тестов).
* В разделе «Дополнительные возможности» рассказывают про редкие или расширенные функции (если их нет, раздел пропускают).

10. Каково назначение обязательного раздела «Сообщения системному программисту»?

Ответ: Это шпаргалка для сисадмина. В ней собраны все предупреждения и ошибки, которые выдает программа во время работы и настройки, а также четкие указания, что делать при появлении каждого сообщения.