Степанов_Подготовка_инженерной_документации_метод_2014

Министерство образования и науки Российской Федерации

Санкт-Петербургский государственный архитектурно-строительный университет

Автомобильно-дорожный факультет

Кафедра транспортных систем

ПОДГОТОВКА ИНЖЕНЕРНОЙ ДОКУМЕНТАЦИИ

Методические указания

Санкт-Петербург

2014

УДК 378.147.85:744.4:625.7/

Рецензент: канд. техн. наук, доцент А. Г. Башкардин (СПбГАСУ)

Подготовка инженерной документации: метод. указания /

сост. В. Н. Степанов; СПбГАСУ. – СПб., 2014. – 96 с.

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

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

Табл. 13. Ил. 2. Библиогр.: 11 назв.

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

Санкт-Петербургский государственный архитектурно-строительный университет, 2014

ВВЕДЕНИЕ

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

Опыт работы со студентами показывает, что они часто не

всостоянии самостоятельно освоить требования, предъявляемые к разработке и содержанию инженерной (технической) документации (ИД). Однако уже с первого курса обучения в вузе учебный процесс связан с написанием отчётов о лабораторных работах, написанием рефератов, пояснительных записок к курсовым работам и отчётов о практике. В процессе обучения студентам приходится неоднократно писать пояснительные записки к курсовым проектам, участвовать в выполнении научно-исследовательских работ (НИР) и в составлении отчётов о НИР. Завершающим этапом обучения в вузе является разработка дипломного проекта (дипломной работы) и написание соответствующей пояснительной записки (ПЗ).

Формы и правила выполнения ПЗ и расчетов (РР) конструкторских документов изделий машиностроения и приборостроения регламентированы ГОСТ 2.106 [1].

Общие требования к выполнению текстовых документов на изделия машиностроения, приборостроения и строительства регламентированы ГОСТ 2.105 [2]. В соответствии с этим стандартом текстовые документы подразделяют на документы, содержащие,

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

Одна из первых попыток обобщения требований соответствующих стандартов, норм и правил к текстовым документам была реализована в методических указаниях [3].

Общие требования к структуре и правилам оформления научных и технических отчётов, а также правила для тех случаев, когда единая процедура оформления будет содействовать обмену информацией, совершенствуя обработку отчёта в информационной системе, изложены в ГОСТ 7.32 [4].

Виды конструкторских документов, их определения и наименования, а также комплектность документов на изделия всех отраслей промышленности приведены в ГОСТ 2.102 [5]. В соответствии с этим стандартом конструкторские документы в зависимости от стадии разработки подразделяются на проектные (техническое предложение, эскизный проект и технический проект) и рабочие (рабочая документация).

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

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

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

1. Общие положения

Всоответствии с ГОСТ Р 51141–98 документ – это материальный объект с закрепленным созданным человеком способом для передачи его во времени и пространстве. Документ выступает одновременно и как предмет труда инженера или управленческого работника, и как результат этого труда.

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

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

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

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

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

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

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

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

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

Все названные виды текстовых документов (кроме отчёта о НИР) составляют на формах 9 и 9а (приложение А). Необходимые в документе схемы, таблицы и чертежи допускается выполнять на листах любых форматов, установленных ГОСТ 2.301– 2006.

В соответствии с требованиями ГОСТ 2.104 [6] основную надпись для заглавного листа текстового документа выполняют по форме 2, для всех последующих листов – по форме 2а (приложение Б).

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

1.1 Виды конструкторских документов

Применительно к конструкторским документам всех отраслей промышленности в ГОСТ 2.102 [5] приведены, в частности, следующие определения с указанием в скобках их кода обозначения.

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

Расчёт (РР)– документ, содержащий расчеты параметров и величин, например, расчет размерных цепей, расчет на прочность и др.

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

Примечание – Код обозначения схемы указывается по ГОСТ 2.701 [7].

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

Технические условия (ТУ) – документ, содержащий требования (совокупность всех показателей, норм, правил и положений) к изделию, его изготовлению, контролю, приемке и поставке, ко-

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

Эксплуатационные документы – документы, предназна-

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

Примечание – Код обозначения эксплуатационных документов указывается по ГОСТ 2.601–2006.

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

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

1.1.1 Пояснительная записка (ПЗ)

Всоответствии с ГОСТ 2.106 [1] ПЗ должна содержать следующие разделы:

-введение (с указанием, на основании каких документов разработан проект);

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

-техническую характеристику;

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

-расчеты, подтверждающие работоспособность и надежность конструкции;

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

-ожидаемые технико-экономические показатели.

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

Вучебном процессе ПЗ составляется применительно к курсовым и дипломным проектам (работам). Содержание разделов ПЗ определяется темой, целью и задачами проекта (работы). В этом случае ПЗ дополнительно должна содержать такие разделы как за-

ключение (обобщение полученных результатов) и список литературы (список использованных источников).

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

1.1.2 Расчет (РР)

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

В соответствии с ГОСТ 2.106 [1] расчет в общем случае должен содержать:

-эскиз или схему рассчитываемого изделия;

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

-данные (исходные данные) для расчета;

-условия расчета;

-расчет;

-заключение.

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

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

1.2 Реферат

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

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

Реферат является формой предоставления результатов документального преобразования информации, то есть процесса анали- тико-синтетического изучения документов (текстов) и подготовки

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

Как правило, реферат имеет научно-информационное назначение.

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

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

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

Обычными составляющими плана реферата являются:

-тема, предмет (объект) и цель работы;

-метод проведения работы;

-результаты работы;

-выводы (оценки, предложения), принятые и отвергнутые гипотезы;

-области применения.

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

1.3 Отчёт

1.3.1 Отчёт о НИР Требования к отчёту о НИР изложены в ГОСТ 7.32 [4]. На-

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

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

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

По результатам выполнения НИР составляется заключительный отчёт о работе в целом. Кроме того, по отдельным этапам НИР могут быть составлены промежуточные отчёты, что отражается в техническом задании на НИР и в календарном плане выполнения НИР.

Ответственность за достоверность данных, содержащихся в отчёте, и за соответствие его требованиям настоящего стандарта несет организация-исполнитель.

Отчёт о НИР подлежит обязательному нормоконтролю в ор- ганизации-исполнителе. При проведении нормоконтроля рекомендуется руководствоваться требованиями ГОСТ 2.111–68.

1.3.2 Отчёт о лабораторной работе Лабораторная работа выполняется с целью приобретения на-

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

Отчёт о лабораторной работе составляется с учётом требований, предъявляемых к структуре, содержанию и оформлению отчёта о НИР.

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

Содержание разделов ВВЕДЕНИЕ и ЗАКЛЮЧЕНИЕ определяется целью лабораторной работы.

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

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

Графики и диаграммы должны быть четкими и наглядно иллюстрировать полученные результаты. Допускается изображать графические зависимости на листах миллиметровой бумаги формата А4, выполненные по форме 9а (рисунок А.2).

1.3.3 Отчёт о практике Практика представляет собой вид учебных занятий, непо-

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

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

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

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

Пример оформления титульного листа отчёта о практике показан на рисунке В.9.

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

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

-участвовать в проведении научных исследований или выполнении технических разработок;

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

-составлять отчеты (разделы отчета) по теме или ее разделу (этапу, заданию);

- выступить с докладом на конференции (семинаре).

Отчёт о практике составляется с учётом требований, предъявляемых к структуре, содержанию и оформлению отчёта о НИР.

Содержание разделов ВВЕДЕНИЕ и ЗАКЛЮЧЕНИЕ определяется видом практики, её целью и задачами.

Основное содержание отчёта должно включать ответы на вопросы, поставленные в программе практики.

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

В соответствии с ГОСТ 2.105 [2] текстовые документы выполняют на формах, приведенных в приложении А.

Расстояние от рамки формы до границ текста в начале и в конце строк – не менее 3 мм, а расстояние от верхней или нижней строки текста до верхней или нижней рамки должно быть не менее 10 мм.

ГОСТ 7.32 [4], определяющий требования к структуре и правилам оформления научных и технических отчётов, не предусматривает выполнения отчётов на формах с рамками. Определяющим

вэтом случае является требование к полям листа стандартного размера, на котором размещается текст документа: слева 30 мм, справа 10 мм, сверху 20 мм, снизу 20 мм.

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

Абзацы в тексте начинают отступом, равным пяти ударам пишущей машинки (15–17 мм). При наборе текста на клавиатуре компьютера абзацный отступ (расстояние от начала строки до первого символа) должен составлять 12,5 мм, что соответствует пяти пробелам при размере шрифта 12–14.

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

Рекомендуемый междустрочный интервал – полуторный. Опечатки, описки и графические неточности, обнаруженные

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

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

После внесения исправлений документ должен удовлетво-

рять требованиям микрофильмирования, установленным ГОСТ 13.1.002–2003.

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

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

Требования к выполнению конструкторских, технологических и проектных документов на бумажных носителях, получаемых с использованием устройств вывода ЭВМ установлены ГОСТ 2.004 [8].

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

При выполнении документов на бумажных носителях при помощи устройств вывода ЭВМ следует различать:

-документы, получаемые при помощи алфавитно-цифровых печатающих устройств (АЦПУ);

-документы, получаемые при помощи графических устройств вывода ЭВМ (графические устройства).

Примечание – Документы могут быть выполнены на комбинированных устройствах вывода ЭВМ. На такие документы распространяются требования, предъявляемые к документам, получаемым при помощи АЦПУ.

В документе, полученном при помощи АЦПУ и (или) графического устройства, допускается часть информации (текст, таблицы, рисунки, чертежи) выполнять рукописным, машинописным и типографским способами, а также любым сочетанием этих способов.

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

16:все структурные разделы – прописным шрифтом, а названия разделов основного содержания – строчным, с прописной буквы.

Названия подразделов и пунктов (при наличии) пишутся также строчным шрифтом с прописной буквы: подразделов – шрифтом размером 15, а подразделов – шрифтом размером 14.

Для основного текста всех структурных элементов и основного содержания документа рекомендуется шрифт размером 13.

2.1 Рубрикация

Требования к построению инженерных документов, их стилю и содержанию установлены ГОСТ 2.105 [2].

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

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

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

-БР – бакалаврская работа;

-ГР – графическая работа;

-ДП – дипломный проект;

-КП – курсовой проект;

-КР – курсовая работа;

-ЛР – лабораторная работа;

-МД – магистерская диссертация;

-РГР – расчётно-графическая работа;

-РК – контрольная работа

-РР – расчётная работа;

-Рф – реферат;

-ПД – практика преддипломная;

-ПО – практика ознакомительная;

-ПП – практика производственная;

-ПТ – практика технологическая;

-ПУ – практика учебная.

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

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

Следующая далее в обозначении двухзначная позиция отводится для номера сборочной единицы (узла) или номера лабораторной работы. Расположенная на последнем месте трёхзначная позиция предназначена для номера детали в сборочной единице. Значащие цифры в эту позицию записываются только для чертежей деталей.

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

Примечание – Примеры оформления названия документов и их обозначений приведены в приложениях В и Г.

Листы документа нумеруют в пределах каждой части, каждую часть начинают на листах с основной надписью по форме ГОСТ 2.104 [6] (приложение Б). Основная надпись – совокупность сведений о документе, содержащихся в графах таблицы установленной формы, помещаемой на листах проектной и рабочей документации.

Основными структурными элементами пояснительной записки, реферата, отчёта являются:

-титульный лист;

-СОДЕРЖАНИЕ;

-ВВЕДЕНИЕ;

-основное содержание;

-ЗАКЛЮЧЕНИЕ;

-СПИСОК ЛИТЕРАТУРЫ (СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ);

-ПРИЛОЖЕНИЯ.

Примечания

1.Структурные элементы располагают в документе в указанной последовательности.

2.Структурные элементы, набранные прописным шрифтом, имеют названия, совпадающие с написанием соответствующего структурного элемента. Такие названия не нумеруют. В тексте до-