Стандарт ГОСТ 19.106-78 ЕСПД. Требования к программным документам, выполненным печатным способом. Объяснение простым языком
Краткое назначение стандарта ГОСТ 19.106-78 ЕСПД. Требования к программным документам, выполненным печатным способом
ГОСТ 19.106-78 определяет, как правильно оформлять распечатанную программную документацию для компьютеров и вычислительных систем. Он описывает структуру документов, требования к тексту, таблицам и приложениям, чтобы все инструкции и руководства выглядели аккуратно и единообразно. При этом на сам «Текст программы» этот стандарт не распространяется.
Область применения стандарта ГОСТ 19.106-78 ЕСПД. Требования к программным документам, выполненным печатным способом
Этот стандарт обязателен для любых программных документов, которые выводятся на печать для компьютеров и систем, независимо от их назначения. Единственное исключение – документ «Текст программы».
Основные термины в стандарте ГОСТ 19.106-78 ЕСПД. Требования к программным документам, выполненным печатным способом
Вот главные понятия, которые используются в стандарте для оформления печатных документов:
- Программный документ, выполненный печатным способом – любой документ из стандартов ЕСПД (кроме самого исходного кода программы), который оформлен на бумаге.
- Форма 1 – специальная разметка для основной части документа, где предусмотрены поля под номер страницы, шифр документа, текст и строку для будущих изменений.
- Форма 2 – другой вариант разметки информационной и основной частей документа.
- Строка изменений – поле №4 в шаблонах документов, куда записывают данные о правках по ГОСТ 19.604-78.
- Р-схема – ориентированный граф с нагрузкой на дугах (упоминается в смежных темах).
Краткое содержание стандарта ГОСТ 19.106-78 ЕСПД. Требования к программным документам, выполненным печатным способом
ГОСТ 19.106-78 входит в Единую систему программной документации (ЕСПД) и задает единые правила для всех печатных документов к ПО, кроме самого «Текста программы».
Основные положения и структура документа
* Состав и структура документов определяются по ГОСТ 19.105-78.
* Если документ слишком большой, его можно разбить на части (начиная с уровня разделов). Каждая часть оформляется отдельно: у нее свой титульный лист, но общий номер (обозначение) по ГОСТ 19.103-77. Страницы, разделы, рисунки и таблицы в каждой части нумеруются заново.
* Основной текст пишется по специальным шаблонам (Форма 1 или Форма 2) со строками для номеров страниц, названий документа и полем для правок по ГОСТ 19.604-78. Рамки вокруг страниц можно не рисовать.
* Аннотацию выносят на отдельную страницу с заголовком «АННОТАЦИЯ», но в общую нумерацию разделов она не входит.
Требования к тексту и перечням
* Приложения, списки терминов, сокращений, картинок и таблиц, а также указатели делают только тогда, когда это действительно нужно.
* Словари терминов, сокращений, списки символов и указатели всегда располагают в алфавитном порядке. Все остальные списки – по возрастанию номеров.
Документы с текстом, разбитым на графы
* В документах с таблицами и графами разделы можно не нумеровать, а линии между ячейками и строками разрешается не проводить.
* Заголовки разделов и подразделов нужно подчеркивать.
* Текст в строках пишется в один ряд и не должен сливаться с линиями. Если в какой-то графе текст занимает несколько строк, в соседних графах его начинают ровно по первой или последней строке.
Часто задаваемые вопросы (FAQ) по стандарту ГОСТ 19.106-78 «ЕСПД. Требования к программным документам, выполненным печатным способом»
1. Что представляет собой стандарт ГОСТ 19.106-78 и каково его главное назначение?
Ответ: Это стандарт ЕСПД, который регулирует правила создания и оформления печатной программной документации для вычислительной техники. Главная цель – сделать все руководства и описания понятными, структурированными и оформленными по единым правилам.
2. На какие виды документов и программного обеспечения распространяется действие данного стандарта?
Ответ: На любые печатные документы из комплексов ЕСПД, независимо от сферы применения ПО. Исключение прямо указано в тексте: ГОСТ не касается документа «Текст программы».
3. Как регламентируется деление печатного программного документа на части?
Ответ: Документы разрешено делить на части, но не мельче, чем на уровне разделов. У каждой части будет свой титульный лист и свой комплект страниц, таблиц и рисунков, но общий шифр документа останется единым (по ГОСТ 19.103-77).
4. Каковы требования к оформлению информационной части и аннотации?
Ответ: Основной текст оформляется по Форме 1 или Форме 2 со специальными служебными полями для номеров страниц и отметок об изменениях. Аннотация идет на отдельной пронумерованной странице с надписью «АННОТАЦИЯ», но разделом документа она не считается.
5. Как формируются различные перечни, указатели и приложения в печатных документах?
Ответ: Их добавляют по необходимости. При этом:
* Словари терминов, сокращений, списки символов и коэффициентов сортируются строго по алфавиту.
* Все остальные перечни выстраиваются по возрастанию номеров.
6. Каковы правила структурирования и оформления документов, содержащих текст, разбитый на графы?
Ответ: В таких документах можно не нумеровать разделы и не чертить линии между ячейками таблиц. Заголовки разделов и подразделов пишутся обычным шрифтом со строчной буквы (первая – заглавная) и обязательно подчеркиваются.
7. Существуют ли специальные требования к размещению записей в таблицах и графах печатных документов?
Ответ: Да. Текст и цифры должны располагаться строго в один ряд и не сливаться с границами ячеек. Если строка многострочная, текст в соседних столбцах выравнивают по верхней или нижней строке. Между разделами обязательно оставляют пустые строки для читаемости.
8. С какими международными стандартами гармонизирован ГОСТ 19.106-78?
Ответ: Этот ГОСТ полностью соответствует требованиям международного стандарта СТ СЭВ 2088-80, который определяет структуру и правила изложения печатных программных документов.