3. Выполнение текстовой документации

3.1. Способы выполнения текстовой документации.

3.1.1. Машинописный. На одной стороне листа через два интервала. Шрифт машинки должен быть четким, лента - черной. Вписывать формулы, условные знаки, выполнять схемы и иллюстрации необходимо тушью.

3.1.2. Рукописный. На одной стороне листа основным чертежным шриф­том с высотой букв не менее 2,5 мм в соответствии с ГОСТ 2.304 - 81.

3.1.3. Каждый лист текстовой документации должен иметь рамку по ГОСТ 2.301 - 68 и основную надпись по форме 2 или 2а. расстояние от рамки до границ текста рекомендуется оставлять: в начале строки не менее 5, в конце строки не менее 3 мм; от верхней и нижней строки до верхней или нижней внутренней рамки не менее 10 мм. Каждый раздел рекомендуется начинать с новой страницы. Каждый пункт записывают с абзаца, цифры номеров пунктов не должны выходить за границы абзаца.

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

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

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

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

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

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

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

3.3. Изложение текста.

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

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

3.3.3. Сокращение слов в надписях к иллюстрациям, таблицам, в тексте, как правило не допускается. Исключение оговаривается в стандартах.

3.3.4. Буквенные обозначения величин, а также условные графические обозначения должны соответствовать установленным стандартам. В тексте пе­ред первым буквенным обозначением величины следует давать его пояснение, например: «Диаметр делительного цилиндра зубчатого колеса D».

3.3.5. Не следует применять синонимы для обозначения одного и того же понятия, обороты речи, произвольные словообразования, математические сим­волы и знаки без цифр для пояснения текста; индексы стандартов без регистра­ционного номера.

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

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

3.3.8. Формулы в тексте располагают на листе симметрично. Если в тек­сте больше одной формулы они пронумеровываются арабскими цифрами в пределах раздела. Допускается нумерация формул в пределах всего документа. Значение символов и числовые значения величин приводятся непосредственно под формулой в той последовательности, в какой они приведены в формуле. Каждый символ и его значение записываются с новой строки, а первая строка расшифровки начинается со слова «где» без двоеточия после него.

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

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

3.4.2. Рисунок помещают в тексте возможно ближе к месту первого упо­минания.. Возможно приводить рисунки в конце текста или в приложениях.

3.4.3. Рисунок должен иметь наименование, помещенное симметрично над рисунком. Расстояние между наименованием рисунка и предыдущим тек­стом не менее 15 мм.

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

3.4.5. Иллюстрации, если их в тексте больше одной имеют нумерацию в пределах раздела, например, «Рис. З.1.». эта надпись помещается ниже рисунка и ниже под рисуночного текста, расстояние до последующего текста не менее 10 мм. Допускается нумерация иллюстраций в пределах всего текста.

3.5. Построение и оформление таблиц.

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

3.5.2. В приложении показаны примеры построения и оформления таб­лиц.

3.5.3. Все таблицы, если их в документе более одной нумеруются в пре­делах раздела арабскими цифрами. Допускается нумерация таблиц в пределах документа. Над первым верхним углом таблицы помещают надпись «Таблица ...» с указанием номера таблицы, например, «Таблица З.1.». При наличии заго­ловка слово «таблица» пишут выше заголовка.

3.5.4. Правила построения таблиц изложены в ГОСТ 2.108-79. Здесь при­водятся лишь наиболее общие правила.

3.5.4.1. Высота строк в таблице не менее 8 мм.

3.5.4.2. Графа п/п в таблицу не включается.

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

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

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

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

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

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

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

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

3.5.4.11. Если цифровые или иные данные в строке не приводятся, то в соответствующих графах ставят прочерки.

3.6. Ссылки в текстовой документации.

3.6.1. При упоминании в тексте одного или сразу нескольких литератур­ных источников можно указать только порядковый номер этой литературы в перечне литературы по типу «как указано в [1], [6]». Ссылки на подраздел или страницу не приводят. В учебных проектах желательны ссылки на подраздел или страницу.

3.6.2. Ссылку на формулы, ранее приведенные в тексте, делают по типу «см. формулу (3.1.)» при нумерации по разделам или «см. формулу (42)» при сквозной нумерации. Возможна ссылка в тексте по форме «... в формуле (3.1.)» или «... в соответствии с формулой (3.1.)».

3.6.3. Ссылки на иллюстрации (рисунки) дают в тексте технической до­кументации первый раз по типу «Рис. 4.1.», а второй и последующие по типу «см. рис. 4.1.». При наличии в тексте ссылок на отдельные части рисунка дела­ется запись по типу «позиция 5 рис. 4.1......

3.6.4. При ссылке в тексте на таблицы слово «Таблица» пишется полно­стью, если таблица не имеет номера и сокращенно, если таблица имеет номер, например, «... в табл. З.1.».

3.6.5. При ссылке на приложения в тексте делается запись типа «... при­ведены в приложении 3».

3.7. Оформление списка литературы.

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

3.7.2. Запись ссылочного документа делают в списке литературы по фор­ме:

1. Левицкий B.C. Машиностроительное черчение, М., Высшая школа, 1988. 351с.:Ил.

2. Справочное руководство по черчению/ Богданов В.И., Малежик И.Ф. и др. М., Машиностроение, 1989. 864с.:Ил.

3.8. Оформление ведомости проекта.

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

3.8.2. Ведомость различают по стадиям проектирования: ПТ - стадия тех­нического предложения, ЭП - стадия эскизного проекта, ТП - стадия техниче­ского проекта.

3.8.3. Запись документов по разделам:

• документация общая;

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

Каждый раздел должен состоять из подразделов:

-вновь разработанная;

- примененная.

Наименование разделов и подразделов записывают в графу «наименова­ние» в виде заголовков. Заголовки подчеркивают.

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

3.8.4. В приложении ... приведен пример выполнения ведомости проекта.

3.8.4.1. В графе «Формат» указывают формат, на котором выполнен гра­фическим или текстовой документ.

3.8.4.2. В графе «Обозначения» указывают обозначения документа.

3.8.4.3. В графе «Наименование» указывают:

в разделе «Документация общая» - наименование документов, на­пример, «Чертеж общего вида», «Габаритный чертеж», «Пояснительная запис­ка»;

в разделе «Документация по сборочным единицам» - наименование документа в соответствии с основной надписью, например, «Ограничитель гру­зоподъемности. Чертеж общего вида».

3.8.4.4. В графе «Количество листов» указывают количество листов, на которых выполнен документ.

3.8.4.5. В графе «экз.» указывают номер экземпляра копии. При отсутст­вии копий делают в графе прочерк.

3.8.4.6. В графе «Примечания» указывают дополнительные сведения