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



МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ

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

ОБЩИЕ ТРЕБОВАНИЯ К ТЕКСТОВЫМ ДОКУМЕНТАМ

Unified system for design documentation.

General requirements for textual documents

Дата введения 1996-07-01

1. ОБЛАСТЬ ПРИМЕНЕНИЯ

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

2 НОРМАТИВНЫЕ ССЫЛКИ

1 В настоящем стандарте использованы ссылки на следующие стандарты:

ГОСТ 2.004-88 ЕСКД. Общие требования к выполнению конструкторских и технологических документов на печатающих и графических устройствах вывода ЭВМ

ГОСТ 2.104-2006 ЕСКД. Основные надписи

ГОСТ 2.106-96 ЕСКД. Текстовые документы

ГОСТ 2.109-73 ЕСКД. Основные требования к чертежам

ГОСТ 2.301-68 ЕСКД. Форматы

ГОСТ 2.304-81 ЕСКД. Шрифты чертежные

ГОСТ 2.316-68 ЕСКД. Правила нанесения на чертежах надписей, технических требований и таблиц

ГОСТ 2.321-84 ЕСКД. Обозначения буквенные

ГОСТ 2.503-90 ЕСКД. Правила внесения изменений

ГОСТ 6.38-90 УСД. Система организационно-распорядительной документации. Требования к оформлению документов

ГОСТ 7.32-91 Система стандартов по информации, библиотечному и издательскому делу. Отчет о научно-исследовательской работе. Структура и правила оформления

ГОСТ 8.417-81 ГСИ. Единицы физических величин

ГОСТ 13.1.002-2003 Репрография. Микрография. Документы для микрофильмирования. Общие требования и нормы

ГОСТ 21.101-93 СПДС. Основные требования к рабочей документации

(Измененная редакция. Изм. № 1)

3 ОБЩИЕ ПОЛОЖЕНИЯ

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



Текстовые документы выполняют в бумажной форме и (или) в виде электронного документа (ДЭ)

(Измененная редакция. Изм. № 1)

3.2 Текстовые документы выполняют на формах, установленных соответствующими стандартами Единой системы конструкторской документации (ЕСКД) и Системы проектной документации для строительства (СПДС).

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

1 3.3 Подлинники текстовых документов выполняют одним из следующих способов:

— машинописным, при этом следует выполнять требования ГОСТ 13.1.002. Шрифт пишущей машинки должен быть четким, высотой не менее 2,5 мм, лента только черного цвета (полужирная);

— рукописным — чертежным шрифтом по ГОСТ 2.304 с высотой букв и цифр не менее 2,5 мм. Цифры и буквы необходимо писать четко черной тушью;

— с применением печатающих и графических устройств вывода ЭВМ (ГОСТ 2.004);

— на электронных носителях данных.

(Измененная редакция. Изм. № 1)

1 3.4 Копии текстовых документов выполняют одним из следующих способов:

— типографским — в соответствии с требованиями, предъявляемыми к изданиям, изготовляемым типографским способом;

— ксерокопированием — при этом рекомендуется размножать способом двустороннего копирования;

— светокопированием;

— микрофильмированием;

— на электронных носителях данных.

(Измененная редакция. Изм. № 1)

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

3.6 Расстояние от рамки формы до границ текста в начале и в конце строк — не менее 3 мм.

Расстояние от верхней или нижней строки текста до верхней или нижней рамки должно быть не менее 10 мм.

Абзацы в тексте начинают отступом, равным пяти ударам пишущей машинки (15 — 17 мм).

Пример выполнения текстового документа приведен в приложении А.

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

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

После внесения исправлений документ должен удовлетворять требованиям микрофильмирования, установленным ГОСТ 13.1.002.

3.8 Для размещения утверждающих и согласующих подписей к текстовым документам рекомендуется составлять титульный лист и (или) лист утверждения в соответствии с разделом 6 настоящего стандарта.

Обязательность и особенности выполнения титульных листов оговорены в стандартах ЕСКД и СПДС на правила выполнения соответствующих документов.

3.9 К текстовым документам рекомендуется выпускать лист регистрации изменений в соответствии с ГОСТ 2.503 и ГОСТ 21.101.

3,10 см 1

3.10 Содержательная и реквизитная части ДЭ должны соответствовать требованиям стандартов ЕСКД.

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

(Введено дополнительно. Изм. № 1)

4 ТРЕБОВАНИЯ К ТЕКСТОВЫМ ДОКУМЕНТАМ, СОДЕРЖАЩИМ, В ОСНОВНОМ, СПЛОШНОЙ ТЕКСТ

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

4.1.1 Текст документа при необходимости разделяют на разделы и подразделы.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

(Измененная редакция. Изм. № 1)

Пример

а) ____________________

б) ____________________

1) ________________

2) ________________

в) ____________________

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

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

Заголовки должны четко и кратко отражать содержание разделов, подразделов.

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

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

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

(Измененная редакция. Изм. № 1)

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

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

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

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

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

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

3                  15

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Примеры

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

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

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

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

Примеры

1 От 1 до 5 мм.

2 От 10 до 100 кг.

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

4. От плюс 10 до плюс 40 °С.

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

4.2.12 Приводя наибольшие или наименьшие значения величин следует применять словосочетание «должно быть не более (не менее)».

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

Например, массовая доля углекислого натрия в технической кальцинированной соде должна быть не менее 99,4 %.

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

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

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

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

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

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

 место расположение

На странице                                                               (1)

где т — масса образца, кг;

V — объем образца, м3.

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

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

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

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

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

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

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

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

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

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

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

Примеры

Примечание — ____________________________________________________________

_________________________________________________________________________

Примечания

1 ______________________

2 ______________________

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

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

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

При ссылках на стандарты и технические условия указывают только их обозначение, при этом допускается не указывать год их утверждения при условии записи обозначения с годом утверждения в конце текстового документа под рубрикой «ССЫЛОЧНЫЕ НОРМАТИВНЫЕ ДОКУМЕНТЫ» по форме:

Обозначение документа на который дана ссылка

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

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

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

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

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

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

(Измененная редакция. Изм. № 1)

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

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

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

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

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

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

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

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

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

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

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

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

4.3.5 Приложения могут быть обязательными и информационными.

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

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



Страницы: Первая | 1 | 2 | 3 | ... | Вперед → | Последняя | Весь текст




sitemap
sitemap