Требования к текстовым документам, содержащим

В основном, сплошной текст

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

Документ состоит из разделов. Каждый раздел начинается с нового листа.

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

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

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

Поле 1 – порядковый номер страницы (оформляется шрифтом Times New Roman 12 размера);

Поле 2 – обозначение документа (оформляется шрифтом Times New Roman 12 размера);;

Поле 3 – текст документа.

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

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

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

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

Раздел – первая ступень деления, обозначенная номером и снабженная заголовком.

Подраздел – часть раздела, обозначенная номером и имеющая заголовок.

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

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

Абзац – логически выделенная часть текста, не имеющая номера.

При отсутствии разделов в тексте документа его первым структурным

элементом является пункт.

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

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

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

Не рекомендуется делать ссылки на элементы перечисления. Каждый структурный элемент начинается с абзацного отступа.

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

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

Каждый раздел начинать с нового листа.

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

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

Разделы должны иметь порядковый номер (1, 2 и т.д., шрифт 16пт жирный Times New Roman). В пределах раздела должна быть сквозная нумерация по всем подразделам, пунктам и подпунктам, входящим в данный раздел.

Нумерация подразделов включает номер раздела, и порядковый номер подраздела входящего в данный раздел, разделённые точкой (1.1, 1.2, 1.3 и т.д., шрифт 14 - 16пт жирный Times New Roman). при наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый номер пункта и подпункта (1.1.1, 1.2.1, 1.2.2 и т.д.) в конце номера пункта или подпункта точку не ставят.

Формирование разделов, подразделов,

пунктов и подпунктов

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

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

Пример:

а)_________________________

б) ________________________

1) _____________________

2)_____________________

в) _________________________

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

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

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

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

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

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

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

Список литературы включают в содержание документа.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Если в документе приводятся поясняющие надписи, нано­симые непосредственно на изготовляемое изделие (например, на планки, таблички к эле

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

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

Перечень допускаемых сокращений слов установлен в ГОСТ 2.316.

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

Условные буквенные обозначения, изображения или знаки должны соответствовать принятым в действующем законода­тельстве и государственных стандартах. В тексте документа перед обозначением параметра дают его пояснение, например «Времен­ное сопротивление разрыву σ_в».

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

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

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

Применение в одном документе разных систем обозна­чения физических величии не допускается.

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

Пример:

1 Провести испытания пяти труб, каждая длиной 5м.

2 Отобрать 15 труб для испытаний на давление.

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

Если в тексте приводится ряд числовых значений, выраженных в одной и той же единице физической величины, то ее указывают только после последнего числового значения, например 1,50; 1,75; 2,00м.

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

Пример:

1 От 1 до 5мм.

2 От 10 до 100кг.

3 От плюс 10 до минус 40°С.

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

Округление числовых значений величин до первого, второго, третьего и т. д. десятичного знака для различных типоразмеров, марок и т. и. изделий одного наименования должно быть одина­ковым. Например, если градация толщины стальной горячеката­ной ленты 0,25мм, то весь ряд толщин ленты должен быть указан с таким же количеством десятичных знаков, например 1,50; 1.75; 2,00.

Дробные числа необходимо приводить в виде десятичных дробей, за исключением размеров в дюймах, которые следует записывать 1\2'';1\3''.

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

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

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

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

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

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

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

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

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

Пример:

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

Р = m\v, (3.1)

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

v - объем образца, м³.

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

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

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

Пример:

Примечание - __________________________________________

______________________________________________________

Примечания

1 __________________________________________________

2 __________________________________________________

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

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

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

При ссылках на другие документы в графе «Обозначение документа» указывают также и наименование документа. При ссылках на раздел или приложение указывают его номер.

Оформление иллюстраций

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

Иллюстрации должны быть выполнены в соответствии с требованиями стандартов ЕСКД и СПДС.

Иллюстрации, за исключением иллюстраций приложений, следует нумеровать арабскими цифрами сквозной нумерацией. Если рисунок один, то он обозначается «Рисунок 1».

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

Пример:

Рисунок 1.1 - Автомобиль ГАЗ 2705 (Газель)

При ссылках на иллюстрации следует писать «...в соответствии с рисунком 2» при сквозной нумерации и «...в соответствии с рисунком 1.2» при нумерации в пределах раздела.

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

Слово «Рисунок» и наименованиепомещают после пояснительных донных и распо­лагают следующим образом: Рисунок 1- Детали прибора.

Допускается не нумеровать мелкие иллюстрации (мелкие рисунки), размещенные непосредственно в тексте и на которые в дальнейшем нет ссылок.

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

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

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

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

Указанные данные наносят на иллюстрациях согласно ГОСТ 2.109.

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

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

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

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

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

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

1 – Головки

2 – Заголовки граф

3 – Подзаголовки граф

4 – Строки (горизонтальные ряды)

5 – Боковик (графа для заголовков)

6 – Графы колонки

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

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

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

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

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

На все таблицы документа должны быть приведены ссыл­ки в тексте документа, при ссылке следует писать слово «таблица» с указанием ее номера.

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

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

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

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

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

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

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

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

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

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

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

Таблица 1

Номинальный диаметр резьбы винта	Внутренний диаметр шайбы	Толщина шайбы (мм)
легкой	нормальной	тяжелой
a	b	a	b	a	b
2,0	2,1	0,5	0,8	0,5	0,5	-	-
2,5	2,5	0,6	0,8	0,6	0,6	-	-

Продолжение таблицы 1

Номинальный диаметр резьбы винта	Внутренний диаметр шайбы	Толщина шайбы
легкой	нормальной	тяжелой
a	b	a	b	a	b
	4,1	1,0	1,2	1,0	1,2	1,2	1,6
…	…	…	…	…	…	…	…
…	…	…	…	…	…	…	…
42,0	42,5	-	-	9,0	9,0	-	-

Пример переноса таблицы на другой лист

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

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

Таблица 1

Диаметр стержня крепежной детали, мм	Масса 1000 шт. стальных шайб, кг		Диаметр стержня крепежной детали, мм	Масса 1000 шт. стальных шайб, кг
1,1 1,2 1,4	0,045 0,043 0,111		2,05 2,50 3,50	0,192 0,350 0,553

Пример деления таблицы на части

Для сокращения текста заголовков и подзаголовков граф от­дельные понятия заменяют буквенными обозначениями, установ­ленными ГОСТ 2.321, или другими обозначениями, если они пояс­нены в тексте или приведены на иллюстрациях, например D- диаметр, Н- высота, L- длина.

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

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

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

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

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

При отсутствии отдельных данных в таблице следует ставить прочерк (тире) в соответствии с рисунком.