Оформление текстовых документов

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

4.1 Требования к содержанию пояснительной записки изложены ГОСТ 2.106-96.

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

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

– задание на дипломное проектирование;

– аннотация по проекту;

– содержание (оглавление);

– введение;

– обзор литературы и постановка задачи;

– основной материал по специальной части;

– технологический раздел;

– раздел по использованию ЭВМ, САПР и т.п.;

– исследовательско-экспериментальный раздел;

– организационно-экономический раздел;

– раздел охраны труда;

– раздел гражданской обороны;

– заключение;

– список использованной литературы;

– приложения.

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

4.2 Текст пояснительной записки выполняется по ГОСТ 2.304-81 рукописным способом черными чернилами или пастой на одной стороне листа белой бумаги формата 210x297 мм.

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

Высота букв и цифр не менее 2,4 мм. С разрешения руководителя проекта пояснительная записка может быть отпечатана через два интервала. Формулы в машинописный текст вносятся от руки.

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

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

4.3 Рамку на листах пояснительной записки курсовых и дипломных проектов следует выполнять по форме 5 и 5а ГОСТ 2.106-96 с основными надписями соответственно по формам 2 и 2а ГОСТ 2.104-68 (см. рисунки А.2 и А.З приложения А, с. 31 и 32). В форме 2а (рисунок А.4 приложения А, с. 32) допускается опускать графы (14), (15), 16). (17) и (18).

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

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

4.5. Записка должна разделяться на разделы в подразделы. Каждому разделу пояснительной записки присваивается номер, обозначаемый арабскими цифрами без точки. При наличии подразделов их номера состоят из номера раздела и порядкового номера подраздела с точкой между ними. В конце точка не ставится (например: 2.3).

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

Наименования разделов и подразделов должны быть краткими и соответствовать содержанию. Записывают эти наименования в виде заголовков с абзаца (отступление на 15-17 мм) строчными буквами (кроме первой прописной).

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

4.6 Расстояние между заголовками и последующим текстом должно быть равно 15 мм. Расстояние между заголовками раздела и подраздела – 8 мм.

Расстояние между последней строкой текста и последующим заголовком рекомендуется 10-15 мм. Пример выполнения текста пояснительной записки дан в приложении Г (см. с. 35).

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

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

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

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

– данные для расчета;

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

– расчет;

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

4.9 Условные буквенные обозначения математических, физических и других величин, а также сокращения слов в тексте и подписях под рисунками должны соответствовать государственным стандартам (ГОСТ 2.321-84).

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

4.10 Наименование изделия на титульном листе, в основной надписи ПЗ и при первом упоминании в тексте записки, должно быть полным и одинаковым с наименованием его в основном графическом документе (ГОСТ 2.105-95).

В последующем тексте допускается употреблять сокращенное наименование изделия и произвольный порядок слов в наименовании, например, "Рама трактора ДЭТ-250 в сборе", "Робот сварочный" – при первом упоминании, "Рама

трактора", "Сварочный робот" – в дальнейшем.

4.11 Значения символов и числовых коэффициентов, входящих в формулы, должны быть приведены непосредственно под соответствующими формулами, например:

S=V*t. (1)

где S – пройденный путь, м;

V – скорость движения, м/с;

t – время, с.

Все формулы должны быть пронумерованы арабскими цифрами в скобках, которые располагают против формулы в крайнем правом положении. Ссылки в тексте на номер формулы дают в скобках, например, "... в формуле (1)...".

4.12 Когда в тексте записки приводится ряд числовых величин одной размерности, единица измерения указывается только в конце ряда, например: 10, 15, 47 кВ.

Единицы измерения в тексте следует приводить в единицах международной системы (СИ) – по ГОСТ 8.417.

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

4.13 Все иллюстрации в ПЗ (эскизы, схемы, графики) называются рисунками и их нумеруют в пределах раздела. Номер рисунка в разделе, например: Рисунок 1.1, Рисунок 1.2.

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

документа, например: Рисунок 1.

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

4.14 Иллюстрации, таблицы, программы и другие документы для расчетов на ЭВМ или тексты вспомогательного характера допускается давать в виде приложений к ПЗ с указанием наверху посередине страницы слова "Приложение" с прописной буквы и его обозначения. Строкой ниже записывается тематический заголовок приложения также с прописной буквы. Приложения обозначают заглавными буквами русского алфавита, начиная с А, кроме букв Ё, 3, И, О, Ч, Ь, Ы, Ъ. Например, Приложение А (см. с. 31 и 32). Иллюстрации и таблицы в приложениях нумеруют в пределах каждого приложения. Например – Рисунок А.З, таблица Д.2.

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

Если в приложение включают распечатки (листинги) программ с ЭВМ, которые складываются "гармошкой", то каждую программу следует рассматривать как один лист документа.

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

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

Основную надпись (форма 2) помешают на странице, следующей за титульным листом, а на последующих страницах – надпись по форме 2а (см. приложение А, рисунки А.З и А.4, с. 32). Альбом приложений должен иметь самостоятельную нумерацию листов, таблиц и иллюстраций, при необходимости альбом может иметь "Содержание".

4.15 Цифровой материал записки оформляется в виде таблиц по ГОСТ 2.105-95 к приложению Д, рисунки Д.1–Д.5 (см. с. 36 и 37).

Таблицы нумеруют арабскими цифрами. Слово "Таблица" и ее номер помешают слева над таблицей, например "Таблица 1". Если в ПЗ одна таблиц, она должна быть обозначена "Таблица 1" или "Таблица В.1", если она приведена в приложении В (см. с. 34). Допускается нумеровать таблицы в пределах раздела.

Таблица может иметь заголовок, который следует выполнять строчными буквами (кроме первой прописной) и помещать над таблицей после слова "Таблица" и ее номера. Заголовок должен быть кратким и полностью отражать содержание таблицы (см. приложение Д, рисунок Д.2, с. 36).

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

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

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

Слово "Таблица", ее номер и заголовок (при его наличии) указывают один раз слева над первой частью таблицы. Над другими частями пишут слова "Продолжение таблицы" с указанием ее номера (приложение Д, рисунок Д.2). Графу "№ п/п" в таблицу не включают.

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

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

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

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

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

Числовые значения величин в одной графе должны иметь, как правило, одинаковое количество десятичных знаков (см. приложение Д, рисунки Д.2 и Д.5, с. 36 и 37).

При указании в таблицах последовательных интервалов значений величин, охватывающих все значения ряда, перед ними пишут "От... до... включ.", "Св. … до... включ." (см. приложение Д, рисунок Д.5, с. 37). В интервале, охватывающем числа ряда между крайними числами ряда, в таблице допускается ставить тире.

Интервалы чисел в тексте записывают со словами "от" и "до" (имея в виду "от... до... включительно''). Например "... толщина слоя должна быть от 0,5 до 2,0 мм" или через дефис, например "п.п. 7-12", "рисунок 1-14". Пределы размеров указывают от меньших размеров к большим размерам.

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

4.17 Правила выполнения диаграмм, изображающих функциональную зависимость двух или более переменных величин в системе координат, устанавливают рекомендации ЕСКД Р50-77-88. Диаграммы для информационного изображения функциональных зависимостей допускается выполнять без шкал значений величин (приложение Е, рисунок Е.1).

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

В диаграмме без шкал оси координат следует заканчивать стрелками, указывающими направления возрастания значений величин. Допускается применять такие стрелки также и в диаграммах со шкалами – за пределами школ, или самостоятельные стрелки после обозначения величины – параллельно оси координат (см. приложение Е, рисунки Е.1– Е.З, с. 38 и 39). В полярной системе координат начало отсчета углов (угол 0°) должно находиться на горизонтальной или вертикальной оси, положительное направление угловых координат должно соответствовать направлению вращения против часовой стрелки.

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

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

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

Делительные штрихи, соответствующие кратным графическим интервалам, допускается удлинять (см. приложение Е, рисунки Е.2 и Е.З, с. 38 и 39).

Числа у шкал следует размешать вне поля диаграммы и располагать горизонтально. Допускается при необходимости наносить числа у шкал внутри поля диаграммы. Многозначные числа предпочтительно выражать как кратные 10n, где n – целое число. Коэффициент 10n следует указывать для данного диапазона шкалы.

Диаграммы следует выполнять линиями по ГОСТ 2.30368. Оси координат, оси шкал, ограничивающие поле диаграммы, следует выполнять сплошной линией. Линии координатной сетки и делительные штрихи следует выполнять

сплошной тонкой линией.

Единицы измерения следует наносить в конце шкалы между последним и предпоследним числами шкалы (при недостатке места допускается не наносить предпоследнее число).

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

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

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

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

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

4.19 Титульный лист является первым листом пояснительной записки. В приложении Ж (см. с. 40) дан титульный лист для курсового проекта, а в приложении И (см. с. 41) – для дипломного проекта.

4.20 Аннотация помещается на третьем листе пояснительной записки, имеющем основную надпись по форме 2 ГОСТ 2.104-68 (см. приложение К, с. 42)). Аннотация (в соответствии с ГОСТ 7.0-99) представляет краткую характеристику проекта с точки зрения содержания, назначения, формы и других особенностей. Она включает основную тему проблемы, цели работы.

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

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

4.22 В конце ПЗ приводится список литературы, нормативно-технической и другой документации, использованной при вычерчивании чертежей, схем и составлении записки. Литература записывается и нумеруется в порядке ее упоминания в тексте. Согласно ГОСТ 7.1-84 в списке литературы приводятся фамилия и инициалы автора, название книги, издательство, место издания и год издания.

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

Примеры библиографического описания материалов и документов согласно ГОСТ 7.1-84, СТП ЮУрГУ 17-04 приведен в приложении Н (см. с. 45).

Ссылки в тексте на литературные источники приводятся в наклонных скобках в порядке их перечисления по списку. При цитировании текста из источника указывается номер источника и номер страницы в нем. Например. "При сварке термически упрочняемых соединений неизбежно разупрочнение /4/", или " … с повышением толщины разупрочнение сварного соединения снижается благодаря появлению контактного упрочнения /1, с. 94/".

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

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

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

– документация;

– комплексы;

– сборочные единицы;

– детали;

– стандартные изделия;

– прочие изделия;

– материалы;

– комплекты.

Каждый раздел записывается в виде заголовка в графе спецификации "Наименование" и подчеркивается, Пример заполнения спецификации приведен в приложении М (см. с. 44).

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

Отступают еще одну строку и записывают следующий раздел, подчеркивая его. С отступлением в одну строку вписывают элементы этого раздела и т. д.

В спецификациях учебных проектов допускается после записи всех наименований элементов данного раздела (особенно в разделах "Стандартные изделия" и "Материалы") пропускать две-три строки для дополнительных записей. Можно резервировать и номера позиции, которые проставляют в спецификацию при заполнении резервных строк. Допускается совмещение сборочного чертежа и спецификации, но при условии их размещения на листе формата А4.

4.24 К технологическим документам (ГОСТ 3.1102-81) относятся графические и текстовые документы, которые определяют технологический процесс изготовления изделия и содержат необходимые данные для организации производства. Названный стандарт регламентирует следующие виды технологических документов:

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

– маршрутная карта;

– операционная карта;

– карта эскизов;

– технологическая инструкция;

– ведомость материалов;

– ведомость оснастки;

– ведомость технологических документов.

Комплектность, формы и содержание технологических документов должны соответствовать межотраслевым системам стандартов ЕСТД, ЕСТПП и для учебных целей определяются кафедрами ЮУрГУ соответствующего профиля.

4.25 Виды программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения установлены ГОСТ 19.00177. Описание применения, требования к содержанию и

оформлению даны в ГОСТ 19.502-78, руководство программиста установлено ГОСТ 19-504-79.

Программные документы оформляются в соответствии с требованиями ГОСТ 19.701-90 и другими стандартами ЕСПД на соответствующие документы: ГОСТ 19.005-85, ГОСТ 19.101-77, ГОСТ 19.102-77, ГОСТ 19.103-77, ГОСТ 19.104-78,

ГОСТ 19.202-78, ГОСТ 19.401-78, ГОСТ 19,402-78, ГОСТ 19.404-79.

4.26 Выполнение эксплутационных документов осуществляется согласно ГОСТ 2.601-95, ремонтных документов – по ГОСТ 2.602-95.

ПРИЛОЖЕНИЕ А

(обязательное)