Единая система программной документации. ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ, ВЫПОЛНЕННЫМ ПЕЧАТНЫМ СПОСОБОМ
Авторы: ГОСТ
Жанры: Технические науки, Программирование
Циклы: не входит в цикл
Формат: Полный
Всего в книге 4 страницы. У нас нет данных о годе издания книги.
Unified system for program documentation. Requirements for printed documents
Настоящий стандарт устанавливает правила выполнения программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения и предусмотренных стандартами Единой системы программной документации (ЕСПД) для печатного способа выполнения.
Стандарт не распространяется на программный документ «Текст программы».
Стандарт соответствует СТ СЭВ 2088-80 в части установления структуры и требований к изложению программных документов (см. справочное приложение 1).
Читать онлайн Единая система программной документации. ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ, ВЫПОЛНЕННЫМ ПЕЧАТНЫМ СПОСОБОМ
1. ОБЩИЕ ТРЕБОВАНИЯ
1.1. Состав и структура программного документа устанавливаются по ГОСТ 19.105-78.
1.2. Программный документ выполняют одним из следующих печатных способов:
машинописным — на одной стороне листа, через два интервала; допускается через один или полтора интервала, если обеспечивается пригодность к микрофильмированию по ГОСТ 13.1.002-80 (разд. 1);
машинным — на одной стороне листа, с расстоянием между основаниями строк, обеспечивающим пригодность к микрофильмированию;
типографским — в соответствии с требованиями, предъявляемыми к изданиям, изготовляемым типографским способом.
Примечания:
1. При выполнении программного документа допускается сочетание печатных способов, указанных в п. 1.2 настоящего стандарта.
2. Допускается выполнение документа или его части рукописным способом — на одной стороне листа черными чернилами или тушью, основным чертежным шрифтом по ГОСТ 2.304-81 с высотой букв не менее 2,5 мм.
1.3. Вписывать в программные документы, выполненные машинописным, машинным и рукописным способами, отдельные слова, формулы, условные знаки (от руки чертежным шрифтом), буквы латинского и греческого алфавитов, а также выполнять схемы и рисунки необходимо черными чернилами или тушью.
1.4. При машинописном, машинном и рукописном способах выполнения документа опечатки и графические неточности, обнаруженные в процессе выполнения, допускается исправлять подчисткой некачественно выполненной части текста (чертежа) и нанесением на том же листе исправленного текста (графики) машинописью «ли черной тушью в зависимости от способа выполнения документа.
Повреждения листов документов, помарки и следы не полностью удаленного прежнего текста (графики) не допускаются.
1.5. Программные документы оформляют:
на листах формата А4 (ГОСТ 2.301-68) — при изготовлении документа машинописным или рукописным способом (форма 1). Допускается оформление на листах формата A3 (форма 2);
на листах форматов А4 и A3, предусматриваемых выходными характеристиками устройств вывода данных — при изготовлении документа машинным способом. Допускаются отклонения размеров листов, соответствующих форматам А4 и A3, определяемые возможностями применяемых технических средств;
на листах типографских форматов — при изготовлении документа типографским способом.
1.6. Материалы программного документа располагают в следующей последовательности:
титульная часть:
лист утверждения (не входит в общее количество листов документа);
титульный лист (первый лист документа);
информационная часть:
аннотация;
лист содержания;
основная часть:
текст документа (с рисунками, таблицами и т. п.);
приложения;
перечень терминов;
перечень сокращений;
перечень рисунков;
перечень таблиц;
предметный указатель;
перечень ссылочных документов;
перечень символов и числовых коэффициентов;
часть регистрации изменений;
лист регистрации изменений.
Приложения, перечни терминов, сокращений, рисунков и таблиц, предметный указатель, перечни ссылочных документов, символов и числовых коэффициентов выполняются при необходимости.
(Измененная редакция, Изм. № 1).
1.7. Перечни терминов и сокращений, предметный указатель, перечень символов и числовых коэффициентов следует составлять в алфавитном порядке.
Остальные перечни составляют в порядке возрастания номеров.
(Введен дополнительно. Изм. № 1).
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. Содержание документа размещают на отдельной (пронумерованной) странице (страницах) после аннотации, снабжают заголовком „СОДЕРЖАНИЕ“, не нумеруют как раздел и включают в общее количество страниц документа.
