Госстандарт СССР - Единая система программной документации. ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ, ВЫПОЛНЕННЫМ ПЕЧАТНЫМ СПОСОБОМ
- Название:Единая система программной документации. ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ, ВЫПОЛНЕННЫМ ПЕЧАТНЫМ СПОСОБОМ
- Автор:
- Жанр:
- Издательство:неизвестно
- Год:неизвестен
- ISBN:нет данных
- Рейтинг:
- Избранное:Добавить в избранное
-
Отзывы:
-
Ваша оценка:
Госстандарт СССР - Единая система программной документации. ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ, ВЫПОЛНЕННЫМ ПЕЧАТНЫМ СПОСОБОМ краткое содержание
Настоящий стандарт устанавливает правила выполнения программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения и предусмотренных стандартами Единой системы программной документации (ЕСПД) для печатного способа выполнения.
Стандарт не распространяется на программный документ «Текст программы».
Стандарт соответствует СТ СЭВ 2088-80 в части установления структуры и требований к изложению программных документов (см. справочное приложение 1).
Единая система программной документации. ТРЕБОВАНИЯ К ПРОГРАММНЫМ ДОКУМЕНТАМ, ВЫПОЛНЕННЫМ ПЕЧАТНЫМ СПОСОБОМ - читать онлайн бесплатно полную версию (весь текст целиком)
Интервал:
Закладка:
Раздел — первая ступень деления, обозначенная номером и снабженная заголовком.
Подраздел — часть раздела, обозначенная номером и имеющая заголовок.
Пункт — часть раздела или подраздела, обозначенная номером. Может иметь заголовок.
Подпункт — часть пункта, обозначенная номером, может иметь заголовок.
Абзац — логически выделенная часть текста, не имеющая номера.
При отсутствии разделов в тексте документа его первым структурным элементом является пункт.
Допускается помещать текст между заголовками раздела и подраздела, между заголовками подраздела и пункта.
Внутри подразделов, пунктов и подпунктов могут быть даны перечисления, которые рекомендуется обозначать арабскими цифрами со скобкой: 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).
2.1.10. (Исключен, Изм. № 1).
2.2. Текст документа
2.2.1. Текст документа должен быть кратким, четким, исключающим возможность неоднозначного толкования.
Термины и определения должны быть едиными и соответствовать установленным стандартами, а при их отсутствии — общепринятым в научно-технической литературе, и приводиться в перечне терминов.
2.2.2. Допускаются сокращения слов в тексте и надписях под иллюстрациями по ГОСТ 2.316-68. Дополнительные сокращения, принятые в документе и не входящие в ГОСТ 2.316-68, следует приводить в перечне принятых сокращений.
2.2.3. Для выделения отдельных понятий допускается изменять интервалы между словами, а также печатать отдельные слова или части текста шрифтом, отличным от печати основного текста, например:
UNGATLG — указывает, что запись каталога, относящаяся к исходному набору данных, должна быть исключена.
ТО=устройство=список — указывает носители данных, на которые осуществляется…
ABC3091 СИНТАКСИЧЕСКАЯ ОШИБКА
ПРИЧИНА. Указанный в сообщении…
ДЕЙСТВИЯ СИСТЕМЫ. Задание не выполняется…
ДЕЙСТВИЯ ПРОГРАММИСТА. Необходимо обеспечить…
2.2.4. Необходимые пояснения к тексту документа могут оформляться сносками.
Сноска обозначается цифрой со скобкой, вынесенными на уровень линии верхнего обреза шрифта, например: „печатающее устройство 2)…“ или „бумага 5)…“.
Если сноска относится к отдельному слову, знак сноски помещается непосредственно у этого слова, если же к предложению в целом, то в конце предложения. Текст сноски располагают в конце страницы и отделяют от основного текста линией длиной 3 см, проведенной в левой части страницы.
2.3. Иллюстрации
2.3.1. Иллюстрации могут быть расположены в тексте документа и (или) в приложениях.
Иллюстрации, если их в данном документе более одной, нумеруют арабскими цифрами в пределах всего документа.
В приложениях иллюстрации нумеруются в пределах каждого приложения в порядке, установленном для основного текста документа.
Ссылки на иллюстрации дают по типу: „рис. 12“ или „(рис. 12)“.
Ссылки на ранее упомянутые иллюстрации дают с сокращенным словом „смотри“, например, „см. рис. 12“.
Иллюстрации могут иметь тематический заголовок и подрисуночный текст, поясняющий содержание иллюстрации.
Тематический заголовок (наименование) помещают над иллюстрацией, подрисуночный текст — под ней. Номер иллюстрации помещают под поясняющими данными.
(Измененная редакция, Изм. № 1).
2.4. Формулы
2.4.1. Формулы в документе, если их более одной, нумеруются арабскими цифрами, номер ставят с правой стороны страницы, в скобках, на уровне формулы.
В пределах всего документа или ею частей, в случае деления документа на части, формулы имеют сквозную нумерацию.
Ссылки в тексте на порядковый номер формулы дают в скобках, например: „в формуле (3)“.
При делении документа на части номер части ставится перед порядковым номером формулы и отделяется от последней точкой, например: „в формуле (1.4)“.
2.4.2. Значения символов и числовых коэффициентов, входящих в формулу, должны быть приведены непосредственно под формулой. Значение каждого символа печатают с новой строки в той последовательности, в какой они приведены в формуле. Первая строка расшифровки должна начинаться со слова „где“, без двоеточия после него.
Если в программном документе приведен перечень этих символов и числовых коэффициентов, значения их под формулой допускается не приводить.
Читать дальшеИнтервал:
Закладка: