Б5 ЕСПД. Общие требования к текстовым документам

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

Б5.1.1 Построение документа

Б5.1.1.1 Текст документа при необходимости разделяют на разделы и подразделы. При большом объеме документа допускается разделять его на части, а в случае необходимости, на книги. Каждую часть и книгу комплектуют отдельно. Всем частям дают наименования и присваивают обозначение документа. Начиная со второй части, этому обозначению добавляют порядковый номер, например ХХХХ.331112.032ФО. Всем книгам дают названия и присваивают порядковый номер. Пример заполнения поля 4 титульного листа на книгу

приведен в приложении Б.

Листы документа нумеруют в пределах каждой части, каждую часть начинают на листах с основной надписью по форме ГОСТ 2.104 и форме 3 ГОСТ Р 21.1101.

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

Б5.1.1.3 Если документ не имеет подразделов, то нумерация пунктов в нем должна быть в пределах каждого раздела, и номер пункта должен состоять из номеров раздела и пункта, разделенных точкой. В конце номера пункта точка не ставится, например:

1 Типы и основные размеры

1.1 Нумерация пунктов первого раздела документа

1.2

1.3

2 Технические требования

2.1 Нумерация пунктов второго раздела документа

2.2

2.3

Если документ имеет подразделы, то нумерация пунктов должна быть в пределах подраздела и номер пункта должен состоять из номеров раздела, подраздела и пункта, разделенных точками, например:

3 Методы испытаний

3.1 Аппараты, материалы и реактивы

3.1.1 Нумерация пунктов первого подраздела третьего раздела документа

3.1.2

3.1.3

3.2 Подготовка к испытанию

3.2.1 Нумерация пунктов второго подраздела третьего раздела документа

3.2.2

3.2.3

Б5.1.1.4 Если раздел или подраздел состоит из одного пункта, он также нумеруется.

Б5.1.1.5 Если текст документа подразделяется только на пункты, они нумеруются порядковыми номерами в пределах документа.

Б5.1.1.6 Пункты, при необходимости, могут быть разбиты на подпункты, которые должны иметь порядковую нумерацию в пределах каждого пункта, например 1.2.1.1, 1.2.1.2 и т.д.

Б5.1.1.7 Внутри пунктов или подпунктов могут быть приведены перечисления.

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

Пример

а)________________

б)________________

1)______________

2)______________

в)________________

Б5.1.1.8 Каждый пункт, подпункт и перечисление записывают с абзацного отступа.

Б5.1.1.9 Разделы, подразделы должны иметь заголовки. Пункты, как правило, заголовков не имеют. Заголовки должны четко и кратко отражать содержание разделов, подразделов.

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

Расстояние между заголовком и текстом при выполнении документа машинописным способом должно быть равно 3, 4 интервалам, при выполнении рукописным способом - 15 мм. Расстояние между заголовком раздела и подраздела - 2 интервала, при выполнении рукописным способом - 8 мм.

Б5.1.1.10 Каждый раздел текстового документа рекомендуется начинать с нового листа (страницы).

Б5.1.1.11 В документе (части, книге) большого объема на первом (заглавном) листе и, при необходимости, на последующих листах помещают содержание, включающее номера и наименования разделов и подразделов с указанием номеров листов, страниц.

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

Слово "Содержание" записывают в виде заголовка (симметрично тексту) с прописной буквы. Наименования, включенные в содержание, записывают строчными буквами, начиная с прописной буквы.

Б5.1.1.12 В конце текстового документа перед листом регистрации изменений допускается приводить список литературы, которая была использована при его составлении. Выполнение списка и ссылки на него в тексте - по ГОСТ 7.32. Список литературы включают в содержание документа.

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

3 15

раздел страница

Б5.1.2 Изложение текста документов

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

В последующем тексте порядок слов в наименовании должен быть прямой, т.е. на первом месте должно быть определение (имя прилагательное), а затем - название изделия (имя существительное); при этом допускается употреблять сокращенное наименование изделия. Наименования, приводимые в тексте документа и на иллюстрациях, должны быть одинаковыми.

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

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

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

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

Б5.1.2.3 В тексте документа не допускается:

- применять обороты разговорной речи, техницизмы, профессионализмы;

- применять для одного и того же понятия различные научно-технические термины, близкие по смыслу (синонимы), а также иностранные слова и термины при наличии равнозначных слов и терминов в русском языке;

- применять произвольные словообразования;

- применять сокращения слов, кроме установленных правилами русской орфографии, соответствующими государственными стандартами, а также сокращений, установленных в данном документе;

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

Б5.1.2.4 В тексте документа, за исключением формул, таблиц и рисунков, не допускается:

- применять математический знак минус (-) перед отрицательными значениями величин (следует писать "минус");

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

- применять без числовых значений математические знаки, например > (больше), < (меньше), = (равно), >= _(больше или равно), <= (меньше или равно), <> (не равно), а также знаки № (номер), % (процент);

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

Б5.1.2.5 Если в документе приводятся поясняющие надписи, наносимые непосредственно на изготовляемые изделия (например, на планки, таблички к элементам управления и т.п.), их выделяют шрифтом (без кавычек), например ВКЛ., ОТКЛ., или кавычками - если надпись состоит из цифр и (или) знаков.

Наименования команд, режимов, сигналов и т.п. в тексте следует выделять кавычками, например, "Сигнал +27 включено".

Б5.1.2.6 Пречень допускаемых сокращений слов установлен в ГОСТ 2.316. Если в документе принята особая система сокращения слов или наименований, то в нем должен быть приведен перечень принятых сокращений, который помещают в конце документа перед перечнем терминов.

Б5.1.2.7 Условные буквенные обозначения, изображения или знаки должны соответствовать принятым в действующем законодательстве и государственных стандартах. В тексте документа перед обозначением параметра дают его пояснение, например "Временное сопротивление разрыву Qв".

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

Б5.1.2.8 В документе следует применять стандартизированные единицы физических величин, их наименование и обозначения в соответствии с ГОСТ 8.417.

Наряду с единицами СИ, при необходимости, в скобках указывают единицы ранее применявшихся систем, разрешенных к применению. Применение в одном документе разных систем обозначения физических величин не допускается.

Б5.1.2.9 В тексте документа числовые значения величин с обозначением единиц физических величин и единиц счета следуют писать цифрами, а числа без обозначения единиц физических величин и единиц счета от единицы до девяти - словами.

Б5.1.2.10 Дробные числа необходимо приводить в виде десятичных дробей, за исключением размеров в дюймах, которые следует записывать 1/4"; 1/2".

При невозможности выразить числовое значение в виде десятичной дроби, допускается записывать его в виде простой дроби в одну строку через косую черту, например, 5/32; (50А - 4С)/ (40В+20).

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

Пример:

Плотность каждого образца р, кг/м*, вычисляют по формуле

р=m/V, (I)

где m - масса образца, кг;

V - объем образца, м*.

Формулы, следующие одна за другой и не разделенные текстом, разделяют запятой.

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

Б5.1.2.13 В документах, издаваемых не типографским способом, формулы могут быть выполнены машинописным, машинным способами или чертежным шрифтом высотой не менее 2,5 мм. Применение машинописных и рукописных символов в одной формуле не допускается.

Б5.1.2.14 Формулы, за исключением формул, помещаемых в приложение, должны нумероваться сквозной нумерацией арабскими цифрами, которые записывают на уровне формулы справа в круглых скобках. Одну формулу обозначают - (I).

Ссылки в тексте на порядковые номера формул дают в скобках, например, ... в формуле (I).

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

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

Б5.1.2.15 Порядок изложения в документах математических уравнений такой же, как и у формул.

Б5.1.2.16 Примечания приводят в документах, если необходимы пояснения или справочные данные к содержанию текста, таблиц или графического материала.

Примечания не должны содержать требований.

Б5.1.2.17 Примечания следует помещать непосредственно после текстового, графического материала или в таблице, к которым относятся эти примечания, и печатать с прописной буквы с абзаца. Если примечание одно, то после слова "Примечание" ставится тире и примечание печатается тоже с прописной буквы. Одно примечание не нумеруют. Несколько примечаний нумеруют по порядку арабскими цифрами. Примечание к таблице помещают в конце таблицы над линией, обозначающей окончание таблицы.

Примеры

Примечание - _____________ __________________________

П р и м е ч а н и я 1 ________________________ 2 ________________________

Б5.1.3 Оформление иллюстраций и приложений

Б5.1.3.1 Количество иллюстраций должно быть достаточно для пояснения излагаемого текста. Иллюстрации могут быть расположены как по тексту документа (возможно ближе к соответствующим частям текста), так и в конце его. Иллюстрации должны быть выполнены в соответствии с требованиями стандартов ЕСКД и СПДС. Иллюстрации, за исключением иллюстраций приложений, следует нумеровать арабскими цифрами сквозной нумерацией. Если рисунок один, то он обозначается "Рисунок 1".

Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Например - Рисунок А.3.

Допускается нумеровать иллюстрации в пределах раздела. В этом случае номер иллюстрации состоит из номера раздела и порядкового номера иллюстрации, разделенных точкой. Например - Рисунок 1.1. При ссылках на иллюстрации следует писать "... в соответствии с рисунком 2" при сквозной нумерации и "... в соответствии с рисунком 1.2" при нумерации в пределах раздела.

Иллюстрации, при необходимости, могут иметь наименование и пояснительные данные (подрисуночный текст). Слово "Рисунок" и наименование помещают после пояснительных данных и располагают следующим образом: Рисунок 1 - Детали прибора.

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

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

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

Для схем расположения элементов конструкций и архитектурно-строительных чертежей зданий (сооружений) указывают марки элементов.

При ссылке в тексте на отдельные элементы деталей (отверстия, пазы, канавки, буртики и др.) их обозначают прописными буквами русского алфавита. Указанные данные наносят на иллюстрации согласно ГОСТ 2.109.

Б5.1.3.3 На приводимых в документе электрических схемах около каждого элемента указывают его позиционное обозначение, установленное соответствующими стандартами, и, при необходимости, номинальное значение величины.

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

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

Б5.1.3.5 Приложения могут быть обязательными и информационными. Информационные приложения могут быть рекомендуемого или справочного характера.

Б5.1.3.6 В тексте документа на все приложения должны быть даны ссылки. Степень обязательности приложения при ссылках не указывается. Приложения располагают в порядке ссылок на них в тексте документа, за исключением информационного приложения "Библиография", которое располагают последним.

Б5.1.3.7 Каждое приложение следует начинать с новой страницы с указанием наверху посередине страницы слова "Приложение" и его обозначения, а под ним в скобках для обязательного приложения пишут слово "обязательное", а для информационного - "рекомендуемое" или "справочное".

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

Б5.1.3.8 Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Е, З, Й, О, Ч, Ь, Ы, Ъ.

Допускается обозначение приложений буквами латинского алфавита, за исключением букв I и O.

В случае полного использования букв русского и латинского алфавитов допускается обозначать приложения арабскими цифрами.

Если в документе одно приложение, оно обозначается "Приложение А".

Б5.1.3.9 Приложения, как правило, выполняют на листах формата А4. Допускается оформлять приложения на листах формата А3, А4/3, А4/4, А2 и А1 по ГОСТ 2.301.

Б5.1.3.10 Текст каждого приложения, при необходимости, может быть разделен на разделы, подразделы, пункты, подпункты, которые нумеруют в пределах каждого приложения. Перед номером ставится обозначение этого приложения.

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

Б5.1.3.11 Все приложения должны быть перечислены в содержании документа (при наличии) с указанием их номеров и заголовков.

Б5.1.3.12 Приложения, выпускаемые в виде самостоятельного документа, оформляют по общим правилам - первый лист с основной надписью по форме 2, последующие листы - по форме 2а по ГОСТ 2.104, ГОСТ 21.1101.

При необходимости такое приложение может иметь "Содержание".

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

Б5.1.3.14 Допускается в качестве приложения к документу использовать другие самостоятельно выпущенные конструкторские документы (габаритные чертежи, схемы и др.).

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

Опись составляют по форме 4 и 4а ГОСТ 2.106. Первым в нее записывают документ, для которого в качестве приложения применены другие конструкторские документы. Далее документы записывают в порядке их комплектования в альбом. При необходимости к альбому составляют титульный лист.

Б5.1.4 Построение таблиц

Б5.1.4.1 Таблицы применяют для лучшей наглядности и удобства сравнения показателей. Название таблицы, при его наличии, должно отражать ее содержание, быть точным, кратким. Название следует помещать над таблицей.

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

Цифровой материал, как привило, оформляют в виде таблиц в соответствии с рисунком Б5.1.

Таблица _________ - ____________________

номер название таблицы

Рисунок Б5.1

Б5.1.4.2 Таблицы, за исключением таблиц приложений, следует нумеровать арабскими цифрами сквозной нумерацией.

Таблицы каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Если в документе одна таблица, она должна быть обозначена "Таблица 1" или "Таблица В.1", если она приведена в приложении В.

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

Б5.1.4.3 На все таблицы документа должны быть приведены ссылки в тексте документа. При ссылке следует писать слово "Таблица" с указанием ее номера.

Б5.1.4.4 Заголовки граф строк таблицы следует писать с прописной буквы, а подзаголовки граф - со строчной буквы, если они составляют одно предложение с заголовком, или с прописной буквы, если они имеют самостоятельное значение. В конце заголовков и подзаголовков таблицы точки не ставятся. Заголовки и подзаголовки граф указывают в единственном числе.

Б5.1.4.5 Таблицы слева, справа и снизу, как правило, ограничивают линиями.

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

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

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

Головка таблицы должна быть отделена линией от остальной части таблицы.

Высота строк таблицы должна быть не менее 8 мм.

Б5.1.4.6 Таблицу, в зависимости от ее размера, помещают под текстом, в котором впервые дана ссылка на нее, или на следующей странице, а, при необходимости, в приложении к документу.

Допускается помещать таблицы вдоль длинной стороны документа.

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