Феллер М.Д., Полторак Ю.Л. Составление текстовых производственных документов

Подождите немного. Документ загружается.

М.Д.Феллер

Ю.Л.Полторак

СОСТАВЛЕНИЕ

ТЕКСТОВЫХ

ПРОИЗВОДСТВЕННЫХ

ДОКУМЕНТОВ

МОСКВА

ИЗДАТЕЛЬСТВО СТАНДАРТОВ

1990

УДК

002.513.3

Феллер

М.Д.,

Полторак

Ю.Л.

Составление текстовых производственных

до-

кументов.

—

М.:

Издательство стандартов,

1990.

—

144 с.

книге

излагаются основные требования

правила

составления

конструкторских, эксплуатационных

орга-

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

позиций норм,

установленных

государственными стандартами.

Материал имеет удобную для пользователей форму

—

ре-

комендации, правила построения документов носят закон-

ченный

характер

сопровождаются необходимыми при-

мерами.

Книга

знакомит читателей

наиболее общими зако-

нами восприятия информации

окажет практическую

по-

мощь широкому

кругу

специалистов, занимающихся

соз-

данием, изучением

использованием производственных

документов. Рассчитана

на

конструкторов, технологов,

других

инженерно-технических работников,

также

мо-

жет

быть

полезна студентам

вузов.

Табл.

Ил.

Библиогр.:

назв.

Рецензенты:

канд. техн. наук В.И. Кокорев

канд. техн. наук

Н.Н.

Федотов

2003000000 - 056

6-90

085

(02) - 90

ISBN

5-7050-0096-0 © М.Д.

Феллер, Ю.Л.

Полторак,

1990

ВВЕДЕНИЕ

работе инженеров, конструкторов, руководителей производства

много

времени отводится изучению, анализу и составлению различной

документации. Это и конструкторская документация, характеризующая

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

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

правилам

использования готовых изделий, и организационно-распоря-

дительные

документы, информационные, рекламные и

многие

другие

виды

документов. Нередко работа с

подобной

документацией ослож-

няется

только потому, что в построении этих документов нет необходи-

мой последовательности, достаточной ясности, четкости, нет необходи-

мых подробностей, или, наоборот, они перегружены несущественными

для

пользователя

сведениями.

Особенно большие трудности возникают, как правило, при разра-

ботке производственных документов, что обусловлено в первую

оче-

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

хорошо

зная

технику,

конструирование, технологию,

организацию

произ-

водства,

нередко

плохо

владеет законами построения и стилистического

оформления

документов. Редактор же, имея эти знания, не может само-

стоятельно

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

том производства.

Вопросами

составления текстовых документов ведает ряд совре-

менных научных дисциплин: прикладная лингвистика и теория стан-

дартизации, инженерная

психология

психолингвистика,

теория и прак-

тика

редактирования и теория управления производством. Однако для

каждой

из них эти вопросы не

являются

центральными, а задачу собрать

воедино и оценить их рекомендации, к тому же нередко противоречи-

вые,

пока

никто

перед собой, насколько известно авторам, не

ставил.

Устранение

непроизводительных затрат времени в процессах состав-

ления

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

лизации и творчества, а это, по мнению авторов, требует, с

одной

сторо-

ны,

ознакомления составителей документов с наиболее общими зако-

нами восприятия документов, с

другой

—

и в этом главная задача настоя-

щего

издания

—

формулирования и систематизации общих правил и норм

составления

основных производственных документов и иллюстрации их

конкретными примерами и схемами.

Предлагаемая

вниманию читателей

книга

состоит из четырех раз-

делов:

,,Документы для разработчика и изготовителя", ,,Документы для

потребителя",

,,Организационно-распорядительные документы", „Прин-

ципы и методика построения текста". Первые три раздела включают опи-

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

щие правила их составления, схемы построения и примеры из маши-

ностроительной и приборостроительной

практики.

В примерах при-

водятся

фрагменты реальных документов,

иногда

значительно перера-

ботанные в соответствии с требованиями стандартов. В четвертом раз-

деле

характеризуются наиболее общие закономерности восприятия

текста документов и вытекающие из них требования к его составле-

нию и оформлению.

Главы

1, 2 и 3 написаны Ю.Л. Полтораком, глава 4 и общая редак-

ция текста принадлежат М.Д.

Феллеру.

ДОКУМЕНТЫ

ДЛЯ

РАЗРАБОТЧИКА

ИЗГОТОВИТЕЛЯ

1.1.

Назначение.

Общие

требования

составлению,

изложению

оформлению*

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

редают информацию о разработке или изготовлении изделия. Они опи-

сывают

состав и устройство изделия, порядок его контроля, приемки,

эксплуатации и ремонта. Они бывают графические и текстовые. К

гра-

фическим

документам относятся разного рода чертежи (сборочный,

общего вида, схема и др.). К текстовым — разного рода перечни

(спе-

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

комплекта, ведомость спецификаций, ведомость ссылочных докумен-

тов

и др.),

подготовка

которых несложна, и пояснительная записка,

технические

условия,

а также эксплуатационные документы (техничес-

кое описание, инструкция по эксплуатации и др.), построение которых

определено стандартами и неписанными правилами.

зависимости от

того,

на

какой

стадии разработки составляются

документы, их подразделяют на проектные (техническое предложение,

эскизный и технический проект) и рабочие

(рабочая

документация).

Конструкторские документы на изделия обычно представляют

собой серию или комплект.

Различают

основной

конструкторский

до-

кумент, который в отдельности или в совокупности с

другими

опре-

деляет

данное изделие и его состав (для деталей — чертеж детали, для

сборочных единиц, комплексов и комплектов

—

спецификация).

Основной комплект

конструкторских

документов изделия

объе-

диняет конструкторские документы, относящиеся ко всему изделию

(составленные

на все данное изделие в целом), например, сборочный

чертеж,

принципиальная эпектрическая схема, технические

условия,

эксплуатационные документы.

Полный

комплект

конструкторских

документов изделия

состав-

ляют

обычно из:

основного комплекта

конструкторских

документов на данное из-

делие;

основных комплектов

конструкторских

документов на все

состав-

ные

части

данного

изделия, примененные по своим основным конст-

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

Текстовые

документы

могут

содержать в основном сплошной

текст (технические

условия,

технические описания, паспорта,

расче-

ты,

пояснительные записки,

инструкции

и т. п.) или текст, разбитый

на графы (спецификации, ведомости, таблицы и т. п). Они выполняют-

ся

одним из трех способов: машинописным, рукописным или типографс-

ким. Машинописные печатаются на

одной

стороне листа через два ин-

тервала,

шрифт пишущей машинки должен

быть

четким, высотой не

менее

2,5 мм, лента только черного цвета.

Эти

требования

относятся

и к

документам

для

потребителей

изделий.

Рукописные — выполняются основным чертежным шрифтом с вы-

сотой букв и цифр не менее 2,5 мм. Цифры и буквы необходимо писать

четко, черной тушью.

Типографские изготовляются в соответствии с техническими усло-

виями

на полиграфическую

продукцию.

1.1.1.

Построение

документов

Каждому документу составитель дает название и обозначение. На-

звание

состоит из наименования изделия (Дизели типа М-750), наиме-

нования вида документа (технические условия) и обозначения

доку-

мента

(АБВГ

318

231.179

ТУ).

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

разделы.

При большом

объеме

документа его допускается разделять на

части

(книги).

Каждую

часть

(книгу)

комплектуют отдельно и нумера-

цию листов документа производят в пределах каждой части

(книги).

Всем

частям

(книгам) присваивают обозначение документа.

Разделы

должны иметь порядковые номера в пределах всего до-

кумента, обозначенные арабскими цифрами с точкой. Подразделы ну-

меруются

в пределах

каждого

раздела. Номера подразделов состоят

из номеров раздела и подраздела, разделенных точкой. В

конце

но-

мера подраздела также должна

ставиться

точка.

Разделы,

как и подраз-

делы,

могут

состоять из

одного

или нескольких пунктов.

Если

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

производится в пределах

каждого

раздела и номер

каждого

пункта дол-

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

це номера пункта также ставится точка.

Пример

НАЗНАЧЕНИЕ

ПРИБОРА

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

ТЕХНИЧЕСКАЯ

ХАРАКТЕРИСТИКА

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

Если

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

пределах подраздела, а номер пункта состоит из номеров раздела,

под-

раздела и пункта, разделенных точками.

Пример

3. УСТРОЙСТВО

ПРИНЦИП

РАБОТЫ

3.1.

Описание электрической схемы

3.1.1

3.1

2.7

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

3.1.3.J

3.2. Конструкция

прибора

3.2.1.1

3.2.2.

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

3.2.3.

документа

Если

раздел или подраздел состоит только из

одного

пункта, этот

пункт

тоже

нумеруется,

например:

СВЕДЕНИЯ

РЕКЛАМАЦИЯХ

16.1. Оформление рекламаций, упаковка

отправка

аппарата

для

ремонта

ремонтные мастерские производится согласно „Положению

поставках про-

дукции

производственно-технического назначения".

Если

же текст документа подразделяется только на пункты, они

нумеруются

порядковыми номерами в пределах документа.

При необходимости пункты

могут

быть разбиты на подпункты,

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

каждого

пункта, например: 3.2.1.1,

3.2.1.2,

3.2.1.3

и т. д. Содержащиеся в тексте

пункта

или

подпункта

перечисления требований, указаний, положе-

ний обозначаются арабскими цифрами со скобкой. Каждый

пункт,

подпункт

и перечисление записывают с абзаца, например:

12.4.

Замена сменных частей, вышедших

из

строя,

производится

установ-

ленной последовательности.

12.4.1.

Замена электронно-лучевой трубки:

а) снимите верхнюю

нижнюю крышки;

б)

отсоедините пружины

лам

по держателя

снимите защитный экран

хвос-

товика трубки;

в)

ослабьте четыре винта, стягивающие крепежные

скобы,

снимите элект-

ронно-лучевую

трубку.

Наименования

разделов и подразделов определяются, как правило,

стандартами на соответствующие виды документов и должны полно от-

ражать

тему раздела или подраздела.

Наименования

разделов записывают в виде заголовков вразрез

текста посередине страницы прописными буквами.

Наименования

подразделов записывают отдельной

строкой

абза-

ца строчными буквами (первая прописная).

Переносы

слов в заголовках не допускаются, точку в

конце

заго-

ловка не ставят.

Если

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

Расстояние

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

та

машинописным способом должно быть равно трем-четырем межстроч-

ным

интервалам, рукописным — 15 мм. Расстояние между заголовками

раздела

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

начинать

с новой страницы.

документе большого объема (от

15—20

страниц) на первой стра-

нице помещают содержание, включающее номера и наименования разде-

лов

и подразделов с указанием номеров страниц, на

которых

они начи-

наются.

Если

документ разбит на части

(книги),

то в

конце

содержания

каждой

книги

следует перечислить обозначения и наименования осталь-

ных

частей.

Содержание включают в общее количество страниц

доку-

мента.

Слово

„СОДЕРЖАНИЕ"

записывают в виде заголовка (вразрез

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

подразделов, включенные в содержание — строчными буквами с аб-

заца.

конце

документа помещается лист

регистрации

изменений. Перед

ним

иногда

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

при составлении документа. В текстовых документах допускаются

ссыл-

ки на стандарты (кроме стандартов предприятий), технические условия

другие

нормативно-технические документы.

Ссылаться

следует на

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

под-

разделы,

пункты, таблицы и иллюстрации не допускаются. При ссылках

на стандарты и технические условия указывают только их обозначения.

При ссылках на

другие

документы указывают наименование докумен-

та.

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

менование,

при повторных ссылках

—

только номер.

Источники в списке следует располагать в порядке появления

ссы-

лок в тексте документа. Библиографические сведения об источниках,

включенных в список, должны приводиться в соответствии с требова-

ниями

ГОСТ

7.1—84

„Библиографическое описание документа". В со-

держание документа в этом

случае

включают строку „Список источни-

ков".

При использовании специфической терминологии или профессио-

нализмов в

конце

документа (перед списком литературы) должен быть

приведен перечень принятых терминов с соответствующими

разъясне-

ниями.

В этом

случае

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

,,Пере-

чень

терминов", помещаемую перед

строкой

,,Список источников".

Условные

буквенные обозначения величин, а также условные

гра-

фические

обозначения должны соответствовать установленным стан-

дартам.

Перед обозначением параметра следует дать пояснение, напри-

мер:

,,Временное сопротивление разрыву а

Числа

с размерностью в тексте документа пишут цифрами, а числа

без

указания размерности — словами, например: ,,Зазор — не более

мм", „Катушку пропитать два раза".

Все

формулы, если их в документе больше одной, нумеруют в

пределах раздела арабскими цифрами. Номер формулы состоит из

номера раздела и

порядкового

номера формулы, разделенных

точ-

кой. Номер указывают с правой стороны листа на уровне формулы

круглых

скобках, например:

= , (3.2)

где U

— выходное напряжение управляемого генератора пилообраз-

ного

напряжения; /

— ток заряда конденсатора генератора. A; t —

текущее

время,

с; С

—

емкость конденсатора генератора, Ф.

Допускается нумерация формул в пределах всего документа.

Ссылки

в тексте на номер формулы дают в скобках, например:

. . . в формуле (3.2)".

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

поясняющие данные.

Если

имеется

одно

примечание, то его не нуме-

руют и после слова „Примечание" ставят точку.

Если

примечаний нес-

колько, то после слова „Примечания" ставят двоеточие. Примечания

нумеруют арабскими цифрами с точкой, например:

Примечания:

Указанная периодичность технического обслуживания предусмотрена для

технически исправных конвейеров.

2. Перечень работ

для

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

веден в таблице.

1.1.2.

Оформление

конструкторских

текстовых

документов

Конструкторские текстовые документы выполняются на формах,

установленных

стандартами

ЕСКД.

Расстояние от рамки формы до

гра-

ниц текста следует

оставлять:

слева

—

не менее 5 мм, справа

—

не менее

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

не

менее 10 мм.

Абзацы

в тексте начинают отступом, равным пяти ударам на пишу-

щей

машинке (13 мм). Вписывать от

руки

в текстовые документы,

изготовленные машинописным способом, отдельные слова, формулы,

условные

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

тушью.

Опечатки,

описки

и графические неточности, обнаруженные в про-

цессе

выполнения документа, можно исправлять подчищая, закрашивая

белой

краской

и нанося на том же месте исправление машинописным

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

документов, помарки и следы не полностью удаленного

прежнего

текста

не

допускаются.

Количество

иллюстраций не ограничивается, оно должно быть дос-

таточным

для пояснения излагаемого текста. Иллюстрации можно рас-

полагать как по тексту документа, возможно ближе к соответствую-

щим его

частям,

так и в

конце

или дать в приложении.

Все

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

пределах раздела арабскими цифрами. Допускается нумерация иллюст-

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

мера

раздела и

порядкового

номера иллюстрации, разделенных точкой,

например: Рис. 1.1, Рис. 2.3. Первую ссылку на иллюстрацию в

бли-

жайшем

тексте дают по типу: ,,рис. 1.1". Ссылки на ранее упомянутые

иллюстрации дают так: ,,см. рис. 3.2".

Иллюстрации

могут

иметь наименование и поясняющие данные (под-

рисуночный текст). Наименование помещают над иллюстрацией, пояс-

няющие

данные

—

под ней. Номер иллюстрации помещают ниже поясняю-

щих данных, например: