Общие требования к оформлению
При выполнении программного документа машинописным или машинным способом документ выполняется на одной стороне листа, с такими интервалы между строк, которые обеспечивают пригодность к микрофильмированию
При выполнении типографским способом документ выполняется в соответствии с требованиями, предъявляемыми к изданиям, изготовляемым типографским способом
При выполнении части рукописным способом - на одной стороне листа, черными чернилами или тушью, чертежным шрифтом с высотой букв не менее 2,5 мм.
При выполнении программного документа машинописным, машинным или рукописным способами разрешается вписывать в документы отдельные слова, формулы, условные знаки и т.п., а также исправлять опечатки и графические неточности от руки чертежным шрифтом.
Построение документа
При необходимости допускается делить документ на части. Деление на части осуществляется на уровне не ниже раздела и каждую часть комплектуют отдельно, в конце содержания первой части перечисляют обозначения остальных частей. Нумерацию страниц документа, а также нумерацию разделов, рисунков и таблиц производят в пределах каждой части. Каждую часть начинают с титульного листа. Лист утверждения выпускают на весь документ с обозначением первой части.
Если в документ включаются части текста программы то их можно оформлять в соответствии с правилами языка, на котором написан текст программы.
Информационная и основная части программного документа выполняются по форме 1:
Форма 1 |
Форма 2 |
- Поле 1 - порядковый номер страницы.
- Поле 2 - обозначение документа.
- Поле 3 - текст документа.
- Поле 4 - строка изменений.
Рамку формата можно не наносить.
Аннотацию размещают на отдельной пронумерованной странице с заголовком "АННОТАЦИЯ", но не нумеруют как раздел. В аннотации указывают издание программы, кратко излагают назначение и содержание документа, общее количество частей документа (если их больше одной).
Содержание документа размещают на отдельной пронумерованной странице/страницах после аннотации, снабжают заголовком "СОДЕРЖАНИЕ", не нумеруют как раздел и включают в общее количество страниц документа.
В содержание документа включают номера разделов, подразделов, пунктов и подпунктов, имеющих заголовок, их наименование и номера страниц; прочие наименования (перечень рисунков, таблиц и т.п.) и номера страниц. Наименования, включенные в содержание, записывают строчными буквами.
Структурными элементами текста документа являются разделы, подразделы, пункты, подпункты и перечисления.
- Раздел - первая ступень деления, обозначенная номером и снабженная заголовком.
- Подраздел - часть раздела, обозначенная номером и имеющая заголовок.
- Пункт- часть раздела или подраздела, обозначенная номером. Может иметь заголовок.
- Подпункт- часть пункта, обозначенная номером. Может иметь заголовок.
- Внутри подразделов, пунктов, подпунктов могут быть даны перечисления, которые рекомендуется обозначать арабскими цифрами со скобкой: 1), 2) и т.д. Допускается выделять перечисления простановкой дефиса перед текстом. Не рекомендуется делать ссылки на элементы перечисления.
- Абзац - логически выделенная часть текста, не имеющая номера.
Каждый раздел рекомендуется начинать с нового листа.
При машинном способе выполнения документа можно заголовки подразделов и пунктов записывать шрифтом, имеющемся на печатающем устройстве.
Расстояние между основаниями строк заголовка принимают таким, как в тексте. Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой. В пределах раздела должна быть сквозная нумерация по всем подразделам, пунктам и подпунктам, входящим в данный раздел.
Нумерация подразделов включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделенные точкой (2.1, 3..1 и т.д.).
При наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1, 3.1.1.1 и т.д.).
Ниже приведен пример структуры текста программного документа и нумерация его разделов, подразделов, пунктов и подпунктов:
 |
Термины и определения должны быть едиными и соответствовать установленным стандартам, а при их отсутствии - общепринятым в научно-технической литературе, и приводиться в перечне терминов.
Для выделения основных понятий допускается изменять интервалы между словами, а также печатать отдельные слова и части текста шрифтом, отличным от печати основного текста,
Необходимые пояснения к тексту документа могут оформляться сносками. Сноска обозначается цифрой со скобкой, вынесенными на уровень линии верхнего образа шрифта, например, "печатающее устройство2)". Иллюстрации Иллюстрации могут быть расположены в тексте документа и/или в приложениях. Иллюстрации нумеруются арабскими цифрами в пределах всего документа. В приложениях иллюстрации нумеруются в пределах приложения.
Ссылки на иллюстрации дают по типу: "рис.2" или "(рис.2)". Ссылки на ранее упомянутые иллюстрации дают по типу: "см. рис.2".
Иллюстрации могут иметь наименование и подрисуночный текст, поясняющий содержание иллюстрации. Наименование помещают над иллюстрацией, подрисуночный текст - под ней. Номер иллюстрации помещают под поясняющим текстом. Формулы Формулы в документе нумеруются арабскими цифрами , номер ставят с правой стороны страницы, в скобках, на уровне формулы. В пределах всего документа или его частей формулы имеют сквозную нумерацию.
Ссылки в тексте на порядковый номер формулы дают в скобках, например: "в формуле (3)".
Значения символов и числовых коэффициентов, входящих в формулу, должны быть приведены непосредственно под формулой. Значение каждого символа печатают с новой строки в той последовательности, в какой они приведены в формуле.
Первая строка расшифровки должна начинаться со слова "где", без двоеточия после него.
Если в программном документе приведен перечень этих символов и числовых коэффициентов, значения их под формулой допускается не приводить.
Размерность одного и того же параметра в пределах одного документа должна быть постоянной. Ссылки В программных документах допускаются ссылки на стандарты, технические условия и другие документы.. Ссылаться следует на документ в целом или его разделы и приложения (с указанием обозначения и наименования документа, номера и наименования раздела или приложения). При повторных ссылках на раздел или приложение указывают только номер. При ссылках на документ допускается проставлять в квадратных скобках его номер в соответствии с перечнем ссылочных документов.
Ссылки на отдельные подразделы, пункты и иллюстрации другого документа не допускаются. Допускаются ссылки внутри документа на пункты, иллюстрации и отдельные подразделы. Таблицы Цифровой материал для достижения лучшей наглядности и сравнимости показателей рекомендуется оформлять в виде таблицы.
Таблица может иметь заголовок, который следует выполнять строчными буквами.
Сноски к таблицам располагают непосредственно под таблицей. Примечания В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные.
Одно примечание не нумеруется. После слова "Примечание" ставят точку. Несколько примечаний нумеруют по порядку арабскими цифрами с точкой. После слова "Примечания" ставят двоеточие. Сокращения В тексте и надписях под иллюстрациями допускаются сокращения слов, установленные стандартами и/или общепринятые в русском языке, а также сокращения, применяемых для обозначения программ, их частей и режимов работы, в языках управления заданиями, в средствах настройки программы и т.п.
Если в документе принята особая система сокращения слов или наименований, то в нем должен быть приведен перечень сокращений. Приложения В виде приложений можно оформлять иллюстративный материал, таблицы или текст вспомогательного характера.Приложения могут быть продолжением данного документа на последующих страницах или выпускаться в виде отдельного документа. Нумерация страниц документа и приложений, входящих в состав документа, должна быть сквозная, если приложения не выполняются отдельным документом.
Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова "ПРИЛОЖЕНИЕ" прописными буквами и иметь тематический заголовок При наличии в документе более одного приложения все приложения нумеруют в арабскими цифрами (без знака ¦).
Содержание каждого приложения, при необходимости, разбивают на разделы, подразделы, пункты, нумеруемые отдельно по каждому приложению. Иллюстрации и таблицы в приложениях нумеруют в пределах каждого приложения.
На приложения должны быть даны ссылки в основном тексте документа. Все приложения должны быть перечислены в листе "Содержание".
| Оглавление |
