Оформление текстовой документации

РГР И КП

К текстовой документации относят пояснительную записку и спецификацию, которые выполняют на листах формата А4 с нанесением на них рамки и соответствующей основной надписи. При этом для заглавного листа документа или его частей используется основная надпись формы 2 (40185) по ГОСТ 2.104-68, а для остальных – формы 2а (15185). В учебных проектах дополнительные графы могут упускаться.

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

Текст документов выполняется рукописным или машинным способом на одной стороне листа. Расстояние от рамки до границ текста документа сверху при отсутствии заголовка должно быть не менее 10 мм. Абзацы в тексте начинаются отступом, равным 15 мм. В тексте допускаются только общепринятые сокращения слов.

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

Текст записки должен быть выполнен аккуратно на одной стороне листа через полтора или два межстрочных интервала. Допускается применение отдельных листов формата A3 (297420) в последующих страницах текста по ГОСТ 2.301-68.

Текстовые документы курсового проекта (работы) должны быть сброшюрованы в папке формата А4 (210297) по ГОСТ 2301-68. Этикетка оформ­ляется в рамке 10060 мм. Оформление этикетки должно соответствовать рис. 1. За этикеткой следует титульный лист. Титульный лист выполняется на листе белой бумаги формата А4 по ГОСТ 2.301-68. Пример оформления титуль­ного листа показан на рис. 2.

Содержание пояснительной записки разбивают на разделы, подразделы и пункты. Разделы должны иметь порядковые номера, обозначаемые арабскими буквами. Заголовки соответствующих разделов выполняются отдельной строкой пропис­ными буквами и, за исключением ВВЕДЕНИЯ, нумеруются. Разделы, подразделы, пункты, подпункты нумеруются и оформляются согласно требованиям ГОСТ 2.105-81 следующим образом: например, 1.3.4.6, где 1 – номер раздела, 3 – подраздела, 4 – пункта, 6 – подпункта. Очередной раздел желательно начинать с новой страницы. После заголовка раздела или подраздела должна следовать постановка задачи и краткое описание метода ее решения. В конце подразделов результа­ты расчетов свести в таблицы.

Рис. 1. Оформление этикетки пояснительной записки

Начинается пояснительная записка с технического задания, которое является ее первым разделом и оформляется на листе, содержащем основную надпись формы 2 (40185). Расчетная и все остальные разделы пояснительной записки выполняются на листах с основной надписью формы 2а (15185).

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

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

Кроме этого, при оформлении рисунков, таблиц и графиков необходимо соблюдать требования:

• заголовки таблиц помещаются сверху, а рисунков – снизу;

• на каждый рисунок и таблицу должны быть ссылки в тексте;

• рисунки и таблицы размещаются сразу после первого упоминания;

• таблицы предпочтительно располагают вертикально;

• на графике должна быть нанесена размерная сетка с таким масштабом, чтобы кривые занимали не менее 80 % площади;

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

Рис. 2. Оформление титуль­ного листа пояснительной записки

Оформление расчетов в пояснительной записке проводится в следующей последовательности. Перед результатом расчета приводится формула, под которой дается расшифровка символов с указанием размерности. Далее в формулу подставляют численные значения символов, проставленные в последовательности, приведенной в формуле. Каждый символ в пределах пояснительной записки должен иметь только одно значение и расшифровывается один раз. Результаты расчетов должны быть указаны в размерном виде. Как правило, расчеты выполняются с точностью 10^–2 (два знака после запятой). Нумеруются только те формулы, на которые приводятся ссылки по тексту.

Пример

 = ,

где  – угловая скорость, с^–1; n – частота вращения, об/мин.

= 104,67 с^–1.

На все заимствованные из литературы рекомендации, фор­мулы, значения коэффициентов и других величин обязательно должны быть даны ссылки в виде цифры в квадратных скобках, например: [2], где 2 – порядковый номер источни­ка в списке литературы.

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

2. Дунаев П.Ф., Леликов О.П. Конструирование узлов и деталей машин. – М.: Высшая школа, 2007.

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

Приблизительный объем пояснительной записки – 30–40 стра­ниц машинописного текста.