Dimdim SoftWare
Мастерская Dr.dimdim
ГлавнаяПоискНаписать письмо
ГлавнаяМоделированиеПроектированиеТЗРазработкаИнтерфейсСтатьиСсылкиАвтор
Главная > Техническая документация

ГОСУДАРСТВЕННЫЙ СТАНДАРТ СОЮЗА ССР

Единая система программной документации

ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ, ВЫПОЛНЕННЫМ ПЕЧАТНЫМ СПОСОБОМ.

ГОСТ 19.106-78

Настоящий стандарт устанавливает правила выполнения программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения и предусмотренных стандартами Единой системы программной документации (ЕСПД) для печатного способа выполнения.

1. Общие требования.

1.1. Состав и структура программного документа устанавливается по ГОСТ 19.105-78.

1.2. Программный документ выполняют одним из следующих печатных способов:

  • машинописным - на одной стороне листа, через два интервала; допускается через один или полтора интервала, если обеспечивается пригодность к микрофильмированию по ГОСТ 13.102-72 (разд.1);
  • машинным - на одной стороне листа, с расстояниями между основаниями строк, обеспечивающим пригодность к микрофильмированию;
  • типографским - в соответствии с требованиями, предъявленными к изданиям, изготавливаемым типографским способом.

Примечания:

1.1. При выполнении программного документа допускается сочетание печатных способов, указанных в п. 1.2. настоящего стандарта.

1.2. Допускается выполнение документа или его части рукописным способом - на одной стороне листа черными чернилами или тушью, основным чертёжным шрифтом по ГОСТ 2.304-68 с высотой букв не менее 2,5мм.

1.3. Вписывать в программные документы, выполненные машинописным, машинным и рукописным способами, отдельные слова, формулы, условные знаки (от руки чертёжным шрифтом), буквы латинского и греческого алфавитов, а так же выполнять схемы и рисунки необходимо чёрными чернилами или тушью.

1.4. При машинописном, машинном и рукописном способах выполнения документа опечатки и графические неточности, обнаруженные в процессе выполнения допускается исправлять подчисткой некачественно выполненной части текста (чертежа) и нанесением на том же листе исправленного текста (графики) машинописью или чёрной тушью в зависимости от способа выполнения документа.

Повреждение листов документов, помарки и следы неполностью удаленного текста (графики) не допускаются.

1.5. Программные документы оформляют:

  • на листах формата А4 (ГОСТ 2.301-68) при изготовлении документа машинописным или рукописным способом (форма 1). Допускается оформление на листах формата А3 (форма 3). При машинном способе выполнения документа допускаются отклонения размеров листов, соответствующих форматам А4 и А3, определяемые возможностями применяемых технических средств;
  • на листах форматов А4 и А3, предусматриваемых выходными характеристиками устройств вывода данных, при изготовлении документа машинным способом;
  • на листах типографических форматов при изготовлении документа типографским способом.

1.6. Расположение материалов программного документа осуществляется в следующей последовательности:

  • титульная часть:
    • лист утверждения (не входит в общее количество листов документа);
    • титульный лист (первый лист документа);
    • титульный лист (первый лист документа);
    • информационная часть:
    • аннотация;
    • лист содержания;
  • основная часть:
    • текст документа (с рисунками, таблицами и т.п.)
    • перечень терминов и их определений;
    • перечень сокращений;
    • приложения;
    • предметный указатель;
    • перечень ссылочных документов;
  • часть регистрации изменений:
    • лист регистрации изменений.

Перечень терминов и их определений, перечень сокращений, приложения, предметных указатель, перечень ссылочных документов выполняются при необходимости.

2. Требования к программным документам, содержащим в основном сплошной текст.

2.1. Построение документа.

2.1.1. При необходимости допускается делить документ на части. Деление на части осуществляется на уровне не ниже раздела. Каждую часть комплектуют отдельно. Всем частям присваивают обозначение документа в соответствии с ГОСТ 19.103-77.

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

Допускается включение в документ частей текста программы, оформляемых в соответствии с правилами языка, на котором написан текст программы.

Нумерацию страниц документа производят в пределах каждой части, каждую часть начинают с титульного листа. Отдельная нумерация страниц документа в пределах раздела и подраздела не допускается.

2.1.2. Информационная и основная части программного документа выполняются по форме 1 ил 2, где

поле 1 - порядковый номер страницы;
поле 2 - обозначение документа;
поле 3 - текст документа;
поле 4 - строка изменений; заполняется в соответствии с требованиями ГОСТ 19.604 - 78.

Рамку (границы) формата страниц документа допускается не наносить.

2.1.3. Аннотацию размещают на отдельной странице (страницах), снабжают заголовком "АННОТАЦИЯ", нумеруют и включают в содержание документа.

2.1.4. Содержание документа размещают на отдельной странице (страницах), снабжают заголовком "СОДЕРЖАНИЕ" и включают в общее количество страниц документа. В содержании документа дается перечисление наименований разделов и подразделов и номеров страниц.

2.1.5. Текст каждого документа, при необходимости, разбивается на пункты, а пункты - на подпункты, независимо от того, разделён документ на части, разделы и подразделы или нет.

2.1.6. Структурными элементами текста документа являются разделы, подразделы, пункты, подпункты и перечисления.

Раздел - первая ступень деления, обозначенная номером и снабжённая заголовком.
Подраздел - часть раздела, обозначенная номером и имеющая заголовок.
Пункт - часть раздела или подраздела, обозначенная номером. Может иметь заголовок. Каждый пункт текста начинается с абзаца.
Подпункт - часть пункта, обозначенная номером, может иметь заголовок.
Перечисление - логически выделенная часть текста, не имеющая номера.

При отсутствии разделов в тексте документа его первым структурным элементом является пункт. Допускается помещать текст между заголовками раздела и подраздела, между заголовками подраздела и пункта.

2.1.7. Заголовка разделов пишут прописными буквами и размещают симметрично относительно правой и левой границ текста. Заголовки подразделов записывают с абзаца строчными буквами (кроме первой прописной). Допускается при машинном способе выполнения документа заголовки подразделов и подпунктов записывать шрифтом, имеющимся на печатающем устройстве. Переносы слов в заголовках не допускаются. Точку в конце заголовка не ставят. Каждый раздел рекомендуется начинать с нового листа.

2.1.8. Расстояние между заголовком и последующим текстом, а также между заголовками раздела и подраздела должно быть равно:

  • при выполнении документа машинописным способом - двум интервалам;
  • при выполнении рукописным способом - 10 мм;
  • при выполнении машинным способом - не менее трёх высот шрифта.

Для разделов и подразделов, текст которых записывают на одной странице с текстом предыдущего раздела, расстояние между последней строкой текста и последующим заголовком должно быть равно:

  • при выполнении документа машинописным способом - трём интервалам;
  • при выполнении рукописным способом - не менее 15 мм;
  • при выполнении машинным способом - не менее четырёх высот шрифта.

Расстояние между основаниями строк заголовка принимают такие же, как и в тексте. При типографском способе издания документов указанные расстояния оформляют по правилам для типографских изданий.

2.1.9. Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой. Разделы должны иметь порядковый номер (1,2 и т.д.). В пределах раздела должна быть сквозная нумерация по всем подразделам, пунктам и подпунктам, входящим в данный раздел. Нумерация подразделов включает номер раздела и порядковый номер полраздела, входящего в данный раздел, разделённые точкой (2.1; 3.1 и т.д.). При наличии разделов и подразделов к номеру полраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1, 3.1.1.1 и т.д.)

Пример структуры текста программного документа и нумерации его разделов, подразделов, пунктов и подпунктов приведён в обязательном приложении.

2.1.10. Внутри подразделов, пунктов и подпунктов могут быть даны перечисления, которые рекомендуется обозначать арабскими цифрами со скобкой 1), 2) и т.д.

Допускается выделять перечисления простановкой дефиса перед текстом. Не рекомендуется делать ссылки на элементы перечисления.

2.2. Текст документа.

2.2.1. Текст документа должен быть кратким, четким, исключающим возможность неверного толкования.

Термины и определения должны быть едиными и соответствовать установленным стандартам, а при их отсутствии - общепринятым в научно-технической литературе, и приводиться в перечне терминов.

2.2.2. Допускаются сокращения слов в тексте и надписях под иллюстрациями по ГОСТ 2.316-68. Дополнительные сокращения, принятые в документе и не входящие в ГОСТ 2.316-68, следует приводить в перечне принятых сокращений.

2.2.3. Для выделения отдельных понятий допускается изменять интервалы между словами, а также печатать отдельные слова или части текста шрифтом, отличным от печати основного текста, например:

UNCATLG - указывает, что запись каталога, относящаяся к исходному набору данных, должна быть исключена.

ТО - устройство - список - указывает носители данных, на которые осуществляется …

АВС3-91 СИНТАКСИЧЕСКАЯ ОШИБКА

ПРИЧИНА. Указанный в сообщении….

ДЕЙСТВИЯ СИСТЕМЫ. Задание не выполняется….

ДЕЙСТВИЯ ПРОГРАММИСТА. Необходимо обеспечить…

2.2.4. Необходимые пояснения к тексту документа могут оформляться сносками.

Сноска обозначается цифрой со скобкой, вынесенной на уровень линии верхнего обреза шрифта.

Если сноска относится к отдельному слову, знак сноски помещается непосредственно возле этого слова, если же к предложению целом, то в конце предложения. Текст сноски располагают в конце страницы и отделяют от основного текста линией длиной 3 см, проведённой в левой части страницы.

2.3. Иллюстрации.

2.3.1. Иллюстрации могут быть расположены в тексте документа и (или) в приложениях. Иллюстрации, если их в данном документе более одной, нумеруют арабскими цифрами в пределах всего документа. В приложениях иллюстрации нумеруются в пределах каждого приложения в порядке, установленном для основного текста документа. Ссылки на иллюстрации дают по типу: "рис.12" или "(рис.12)". Иллюстрации могут иметь тематический заголовок и подрисуночный текст, поясняющий содержание иллюстрации.

2.4. Формулы.

2.4.1. Формулы в документе, если их более одной, нумеруются арабскими цифрами, номер ставят с правой стороны страницы, в скобках на уровне формулы.

В пределах всего документа или его частей, в случае деления документа на части, формулы имеют сквозную нумерацию.

Ссылки в тексте на порядковый номер формулы дают в скобках, например: "в формуле (3)". При делении документа на части номер части ставится перед порядковым номером формулы и отделяется от последней точкой, например: "в формуле (1.4)"

2.4.2. Значение символов, входящих в формулу, должны быть приведены непосредственно под формулой. Значение каждого символа печатают с новой строки в той последовательности, в какой они приведены в формуле. Первая строка расшифровки должна начинаться со слова "где", без двоеточия после него.

2.4.3. Размерность одного и того же параметра в пределах одного документа должна быть постоянной.

2.5. Ссылки.

2.5.1. В программных документах допускаются ссылки на стандарты и другие документы. Ссылаться следует на документ в целом или на его разделы (с указанием обозначения и наименования документа, номера и наименования раздела или приложения). Допускается указывать только обозначение документа и (или) разделов без указания их наименований. Ссылки на отдельные подразделы, пункты и иллюстрации другого документа не допускаются. Допускаются ссылки внутри документа на пункты, иллюстрации и отдельные подразделы.

2.6. Таблицы

2.6.1. Цифровой материал для достижения лучшей наглядности и сравнимости показателей, как правило, следует оформлять в виде таблицы.

2.6.2. Оформление таблиц должно производиться в соответствии с требованиями ГОСТ 1.5.-68, раздел 1.6.

2.6.3. Сноски к таблицам располагают непосредственно под таблицей. Например:

Наборы данных, используемые для распечатки

Назначение Стандартное имя Используемое устройство
Для информационной распечатки SSSSSSS* Печатающее устройство**
Для распечатки во время выполнения программы РРРРРРРР Печатающее устройство**

* Имя SSSSSSS должно быть задано при настройке операционной системы.

** Для уменьшения простоев центрального процессора из-за операций ввода-вывода может быть использована магнитная лента.

2.7. Примечания.

2.7.1. В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные. Одно примечание не нумеруется. После слова "Примечание" ставят точку. Несколько примечаний следует нумеровать по порядку арабскими цифрами с точкой. После слова "Примечание" ставят двоеточие.

Например:

Примечание:___________________________________________________________________

___________________________________________________________________________________

или

Примечания:

1. ____________________________________________________________________________

___________________________________________________________________________________

2. ____________________________________________________________________________

___________________________________________________________________________________

2.7.2. Текст примечаний допускается печатать только через один интервал.

2.8. Сокращения.

2.8.1. Сокращения слов в тексте и надписях под иллюстрациями не допускаются, за исключением:

  • сокращений, установленных в ГОСТ 2.316-68, и общепринятых в русском языке;
  • сокращений, применяемых для обозначения программ, их частей и режимов работы, в языках управления заданиями, в средствах настройки программы и т.п., обозначаемых буквами латинского алфавита.

2.9. Приложения

2.9.1. Иллюстрированный материал, таблицы или текст вспомогательного характера допускается оформлять в виде приложений. Приложения оформляют как продолжение данного документа на последующих страницах или выпускают в виде отдельного документа.

2.9.2. Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова "Приложение" и иметь тематический заголовок. При наличии в документе более одного приложения все приложения нумеруют арабскими цифрами (без знака №), например:

Приложение 1, Приложение 2 и т.д.

При выпуске приложения отдельным документом, на титульном листе под наименованием документа следует указывать слово "Приложение", а при наличии нескольких приложений указывают также его порядковый номер.

2.9.3. Содержание каждого приложения, при необходимости, разбивают на разделы, подразделы, пункты и подпункты, нумеруемые отдельно по каждому отдельному приложению.

2.9.4. Нумерация страниц документа и приложений, входящих в состав документа, должна быть сквозная, если приложения не выполняются отдельным документом.

2.9.5. На приложения должны быть даны ссылки в основном тексте документа. Все приложения должны быть перечислены в листе "Содержание".

3. Требования к программным документам, содержащим текст, разбитый на графы.

3.1. Программные документы, содержащие текст, разбитый на графы, при необходимости разделяют на разделы и подразделы, которые не нумеруют. Допускается линии, разграничивающие строки и графы, не наносить.

3.2. Наименования разделов и подразделов записывают в виде заголовков строчными буквами (кроме первой прописной) и подчёркивают. Расстояние между заголовком и последующим текстом, между текстом и последующим заголовком и между заголовками должны соответствовать указанным в п. 2.1.8 настоящего стандарта.

3.3. Примечания в документе оформляются в порядке, изложенном в п. 2.7 настоящего стандарта.

3.4. В таблицах и формах, имеющих строки, все записи размещают на каждой строке в один ряд. Записи не должны сливаться с линиями, разграничивающими строки и графы. Следует оставлять свободные строки между разделами и подразделами, а в документах большого объёма - также внутри разделов и подразделов.

Вверх

<<Назад

Главная| ИС.. | Моделирование | Проектирование | ТД| Разработка | Интерфейс | Статьи | Ссылки | Автор
DimDim SoftWare Мастерская Dr. dimdim Copyright 2003-2004
Администратор info-system@mail.ru
Последнее обновление 26-Дек-2003