- •Государственный стандарт союза сср Единая система программной документации общие положения
- •1. Назначение еспд.
- •2. Область распространения и состав еспд.
- •3. Классификация и обозначение стандартов еспд.
- •Г о с у д а р с т в е н н ы й с т а н д а р т с о ю з а с с р
- •1. Правила выполнения схем
- •2. Правила применения символов
- •Г о с у д а р с т в е н н ы й с т а н д а р т с о ю з а с с р
- •1. Виды программ
- •2. Виды программных документов
- •Г о с у д а р с т в е н н ы й с т а н д а р т с о ю з а с с р
- •Г о с у д а р с т в е н н ы й с т а н д а р т с о ю з а с с р
- •Г о с у д а р с т в е н н ы й с т а н д а р т с о ю з а с с р
- •1. Основные положения
- •2. Основные надписи листа утверждения (лу)
- •3. Основные надписи титульного листа
- •4. Основные надписи в тексте документа.
- •Информационные данные о соответствии гост 19.104-78 ст сэв 2088-80
- •Пример заполнения листа утверждения
- •Пример заполнения титульного листа
- •Г о с у д а р с т в е н н ы й с т а н д а р т с о ю з а с с р
- •1. Общие требования
- •2. Титульная часть
- •3. Информационная часть
- •4. Основная часть
- •5. Часть регистрации изменений
- •Информационные данные о соответствии гост 19.105-78 ст сэв 2088-80
- •Г о с у д а р с т в е н н ы й с т а н д а р т с о ю з а с с р
- •1. Общие требования
- •2. Требования к программным документам, содержащим в основном сплошной текст.
- •2.1. Построение документа.
- •2.1.3, 2.1.4. (Измененная редакция, Изм. № 1).
- •2.1.10. (Исключен, Изм. № 1)
- •2.2. Текст документа.
- •2.3. Иллюстрации.
- •2.4. Формулы.
- •2.5. Ссылки.
- •2.6. Таблицы
- •2.7. Примечания.
- •2.8. Сокращения.
- •2.9. Приложения
- •3. Требования к программным документам, содержащим текст, разбитый на графы.
- •Информационные данные о соответствии гост 19.106-78 ст сэв 2088-80
- •Структура текста программного документа
- •Г о с у д а р с т в е н н ы й с т а н д а р т с о ю з а с с р
- •1. Общие положения
- •2. Содержание разделов
- •Г о с у д а р с т в е н н ы й с т а н д а р т с о ю з а с с р
- •Форма спецификации
2. Требования к программным документам, содержащим в основном сплошной текст.
2.1. Построение документа.
2.1.1. При необходимости допускается делить документ на части. Деление на части осуществляется на уровне не ниже раздела. Каждую часть комплектуют отдельно. Всем частям присваивают обозначение документа в соответствии с ГОСТ 19.103-77.
Части оформляют в соответствии с требованиями настоящего стандарта, при этом в конце содержания первой части следует перечислять названия остальных частей.
Допускается включать в документ частей текста программы, оформляемых в соответствии с правилами языка, на котором написан текст программы.
Нумерацию страниц документа производят, а также нумерацию разделов, рисунков и таблиц производят в пределах каждой части. Каждую часть начинают с титульного листа.
Отдельная нумерация страниц документа в пределах раздела и подраздела не допускается.
Лист утверждения выпускают на весь документ с обозначением первой части.
(Измененная редакция, Изм. № 1).
2.1.2. Информационная и основная части программного документа выполняются по форме 1 или 2, где:
поле 1 - порядковый номер страницы;
поле 2 - обозначение документа;
поле 3 - текст документа;
поле 4 - строка изменений; заполняется в соответствии с требованиями ГОСТ 19.604-78.
Рамку (границы) формата страниц документа допускается не наносить.
2.1.3. Аннотацию размещают на отдельной (пронумерованной) странице с заголовком «АННОТАЦИЯ» и не нумеруют как раздел.
В аннотации указывают издание программы, кратко излагают назначение и содержание документа. Если документ состоит из нескольких частей, в аннотации указывают общее количество частей.
2.1.4. Содержание документа размещают на отдельной (пронумерованной) странице (страницах) после аннотации, снабжают заголовком «СОДЕРЖАНИЕ», не нумеруют как раздел и включают в общее количество страниц документа.
В содержании документа включают номер разделов, подразделов, пунктов и подпунктов, имеющих заголовок, их наименование и номера страниц; номера и наименование (при наличии) приложений программного документа и номера страниц; прочие наименования (перечень рисунков, таблиц и т.п.) и номера страниц.
Наименования, включенные в содержание, записывают строчными буквами. Прописными должны печататься заглавные буквы и аббревиатуры.
2.1.3, 2.1.4. (Измененная редакция, Изм. № 1).
2.1.5. Текст каждого документа, при необходимости, разбивается на пункты, а пункты - на подпункты, независимо от того, разделён документ на части, разделы и подразделы или нет.
2.1.6. Структурными элементами текста документа являются разделы, подразделы, пункты, подпункты и перечисления.
Раздел - первая ступень деления, обозначенная номером и снабженная заголовком.
Подраздел - часть раздела, обозначенная номером и имеющая заголовок.
Пункт - часть раздела или подраздела, обозначенная номером. Может иметь заголовок.
Подпункт - часть пункта, обозначенная номером, может иметь заголовок.
Абзац - логически выделенная часть текста, не имеющая номера.
При отсутствии разделов в тексте документа его первым структурным элементом является пункт.
Допускается помещать текст между заголовками раздела и подраздела, между заголовками подраздела и пункта.
Внутри подразделов, пунктов и подпунктов могут быть даны перечисления, которые рекомендуется обозначать арабскими цифрами со скобкой: 1), 2) и т. д. Допускается выделять перечисления простановкой дефиса перед текстом.
Не рекомендуется делать ссылки на элементы перечисления.
Каждый структурный элемент начинается с абзацного отступа.
(Измененная редакция, Изм. № 1).
2.1.7. Заголовки разделов пишут прописными буквами и размещают симметрично относительно правой и левой границ текста.
Заголовки подразделов записывают с абзаца строчными буквами (кроме первой прописной).
Допускается при машинном способе выполнения документа заголовки подразделов и пунктов записывать шрифтом, имеющимся на печатающем устройстве.
Переносы слов в заголовках не допускаются. Точку в конце заголовка не ставят.
Если заголовок состоит из двух предложений, их разделяют точкой.
Каждый раздел рекомендуется начинать с нового листа.
(Измененная редакция, Изм. № 1).
2.1.8. Расстояние между заголовком и последующим текстом, а также между заголовками раздела и подраздела должно быть равно:
при выполнении документа машинописным способом - двум интервалам;
при выполнении рукописным способом - 10 мм;
при выполнении машинным способом - не менее трёх высот шрифта.
Для разделов и подразделов, текст которых записывают на одной странице с текстом предыдущего раздела, расстояние между последней строкой текста и последующим заголовком должно быть равно:
при выполнении документа машинописным способом - трём машинописным интервалам;
при выполнении рукописным способом - не менее 15 мм;
при выполнении машинным способом - не менее четырёх высот шрифта.
Расстояние между основаниями строк заголовка принимают такие же, как в тексте.
При типографском способе издания документов указанные расстояния оформляют по правилам для типографских изданий.
2.1.9. Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой.
Разделы должны иметь порядковый номер (1, 2 и т. д.).
В пределах раздела должна быть сквозная нумерация по всем подразделам, пунктам и подпунктам, входящим в данный раздел.
Нумерация подразделов включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделённые точкой (2.1; 3.1 и т. д.).
При наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1, 3.1.1.1 и т.д.).
Пример структуры текста программного документа и нумерации его разделов, подразделов, пунктов и подпунктов приведён в справочном приложении 2.
(Измененная редакция, Изм. № 1).