Структурные элементы текстовых документов

 

Обязательными структурными элементами любого текстового являются:

1. Титульный лист

2. Ведомость документации

3. Лист задания

4. Содержание

5. Введение

6. Основная часть

7. Заключение

8. Литература

9. Приложения (при наличии)

Титульный лист

 

Пример оформления титульного листа приведен ниже.

 

2-360101 Технология машиностроения Группа ТМ-48. 04/ 5

 

Рисунок 2 - Пример оформления титульного листа для дипломного проекта

 

 

 

 

Рисунок 3 - Пример оформления титульного листа для курсовой работы

Ведомость документации

 

 

Рисунок 4 - Пример оформления ведомости документации

 

Примечание: при заполнении основной надписи

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

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

· в графе «Н.контр.» указывается фамилия преподавателя, который проводит нормоконтроль

 

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

 

Задание оформляется на типографском бланке и выдается цикловой комиссией. При отсутствии бланка допускается оформлять задание набором на компьютере на листах формата А4.

Формы бланков приведены:

Ф 11.1		Бланк задания на курсовое проектирование
Ф 11.1		Бланк задания на дипломное проектирование

 

Содержание

 

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

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

Слово «Содержание» помещают в виде заголовка (в центре, симметрично тексту) с прописной буквы. Наименования, включенные в содержание, записывают строчными буквами, начиная с прописной буквы. Содержание включают в общее количество листов документа.

Пример оформления приведен на рисунке 5.

 

Рисунок 5 - Пример оформлениясодержания

Примечание: при заполнении основной надписи

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

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

· в графе «Н.контр.» указывается фамилия преподавателя, который проводит нормоконтроль

· в графе «Утв.» указывается фамилия заведующего отделением

Структурирование текста пояснительной записки

«Введение» и «Литература» не нумеруются.

Введение

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

Основная часть

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

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

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

Каждый раздел начинается с нового листа. На первом листе нового раздела выполняется основная надпись по форме 1 (185х40 мм). Пример оформления приведен в приложении Б.

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

Расстояние от основания верхней строки текста до внутренней рамки листа (а также наименование раздела, подраздела, пункта или наименование таблицы) – 13 мм.

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

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

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

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

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

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

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

 

Пример:

3 Методика испытаний (номер и заголовок раздела)

3.1 Аппараты и материалы (номер и заголовок подраздела)

3.1.1 Текст первого пункта 3.1.2 Текст второго пункта

} нумерация пунктов

 

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

Пример:

1 Типы и основные размеры (номер и заголовок раздела)

1.1 Текст …… 1.2 Текст ……

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

2 Технические требования

2.1 Текст …… 2.2 Текст ……

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

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

3.2.1.1; 3.2.1.2; 3.2.1.3 и т.д.

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

Пример:

Процесс ковки составляет следующие операции:

- протяжка ……… - осадка ………… - прошивка ……..

} перечисления

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

а) текст ………. б) текст ………

} перечисления

Изложение текста в пояснительной записке

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

Перечень допускаемых сокращений слов устанавливает ГОСТ 2.316- (см. Приложение А).

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

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

В тексте записки не допускается:

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

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

- применять произвольные словообразования и обороты разговорной речи (техницизмы, профессионализмы).

В тексте записки, за исключением формул и таблиц не допускается:

- применять математический знак минус (-) перед отрицательными значениями величин (следует писать слово «минус»);

- применять знак диаметра «Ø» (пишется слово «диаметр»);

- применять без числовых значений математические знаки «>» (больше), «=» (равно) и т.д., а также знаки «№» (номер) и «%» (процент).

В ПЗ числовые значения величин с обозначением физических величин и единиц счета следует писать цифрами (220 V, 50 кг), а числа без обозначений физических величин от единицы до девяти – словами (восемь труд длинной 5 м).

Физическую величину указывают только после последнего числового значения ряда, число знаков после запятой должно быть одинаковым (1,50; 1,75; 2,00 м). Если приводится диапазон числовых значений физической величины, то обозначение физической единицы указывается после последнего числового значения (“от плюс 10 до минус 40°C”; “от 10 до 50 кг”).

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

Допускается числовое значение, которое невозможно выразить десятичной дробью, записывать в виде простой дроби в одну строчку через косую линию, например: 13/72.

 

Оформление формул

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

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

Rbt,m = Mu/(γ·W), (1)

где Rbt,m – прочность бетона на растяжение, МПа;

Mu - разрушающий момент, кН·см;

γ=1,7 - коэффициент, учитывающий деформации бетона растянутой зоны;

W – упругий момент сопротивления сечения, см³.

 

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

Формулы приложения нумеруют арабскими цифрами в пределах каждого приложения с добавлением перед каждой цифрой обозначения приложения. Например: формула (Б.1).

Допускается нумерация формул в пределах раздела. В этом случае номер формулы состоит из номера раздела и порядкового номера формулы, разделенные точкой. Например: формула (3.1).

Ссылки в тексте на порядковые номера формул дают в скобках. Например: в формуле (1).

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

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

Иллюстрации следует нумеровать арабскими цифрами сквозной нумерации. Если рисунок один, то он обозначается «Рисунок 1».

Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Например: Рисунок А.3.

Допускается нумеровать иллюстрации в пределах раздела. Например: Рисунок 1.1.

Иллюстрации, при необходимости, могут иметь наименование и пояснительные данные (подрисуночный текст). Слово «Рисунок» и наименование помещают после пояснительных данных и располагают следующим образом:

6

 

 

 

 

0 0,05 0,10 0,15 0,20 0,25 0,30

Давление р, МПа

Рисунок 1 – Зависимость осадки штампа S от давления р при испытании грунта статической нагрузкой

Рисунок 5– Пример оформления рисунка

Примечания

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

Пример:

Примечание – при изменении параметров …

 

Построение таблиц

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

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

Допускается нумеровать таблицы в пределах раздела. В этом случае номер таблицы состоит из номера раздела и порядкового номера таблицы в пределах данного раздела, разделенных точкой. Например: «Таблица 2.1».

Слово «Таблица» пишут слева над таблицей, указывают порядковый номер, ставят тире и затем указывают название. Заголовки и подзаголовки таблиц начинают с прописных букв. В конце заголовков и подзаголовков таблиц знаки препинания не ставят. Например: «Таблица 3 – Значение коэффициента γf».

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

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

Пример построения таблиц приведен на рисунках 6 и 7

 

Рисунок 6 - Пример построения таблиц

 

 

Таблица 5.4 – Подсчет нагрузок на ферму покрытия одноэтажного промышленного здания

 

Вид нагрузки	Нормативная нагрузка, Н/м²	Коэффициент надежности по нагрузке γf	Расчетная нагрузка, Н/м²
Постоянная: от защитного слоя из гравия на мастике 20 мм		1,3
Временная (снеговая):		1,4
Полная нагрузка:		-

 

Рисунок 7 – Пример построения таблиц

 

Ссылки

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

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

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

 

Заключение

Заключение содержит краткие выводы и оценку полученных результатов.

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

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

Ссылки на источники в тексте работы оформляются в виде указания порядкового номера источника в списке, заключенного в квадратные скобки, например: [3], [8]. Если в тексте приводится дословная цитата, она заключается в кавычки, а в квадратных скобках после номера источника указывается номер страницы, например: [3, с. 15].

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

Приложения

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

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

Каждое приложение следует начинать с новой страницы с указанием наверху по середине страницы слова «Приложение». Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Ё, З, Й, О, Ч, Ь, Ъ. После слова «Приложение» следует буква, обозначающая его последовательность. Если в документе одно приложение, оно обозначается «Приложение А».

Приложения, как правило, выполняют на листах формата А4. Допускается также использовать листы формата А3, А4х4, А2 и А1 по ГОСТ 2.301.

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

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

 

ОФОРМЛЕНИЕ ГРАФИЧЕСКОГО МАТЕРИАЛА

Графический материал должен отвечать требованиям действующих стандартов по ЕСКД и может выполняться:

- неавтоматизированным методом - карандашом;

- автоматизированным методом - с применением графических и печатающих устройств вывода ПЭВМ.

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

Схемы и чертежи следует выполнять на любых форматах, установленных ГОСТ 2.301 Графический материал, предназначенный для демонстрации при публичной защите работы, как правило, на листах формата А1.

Форматы листов выбирают в соответствии с требованиями, установленными ГОСТ 2.301 и ГОСТ 2.001-93, при этом основные форматы являются предпочтительными. Выбранный формат должен обеспечивать компактное выполнение чертежа.

ГОСТ 2.301 устанавливает форматы чертежей. Формат чертежа определяется размерами внешней рамки, выполненной тонкой линией. Линии рамки наносят на расстоянии 5мм от края формата и выполняют сплошной основной линией. Для брошюровки чертежей оставляют у левого края листа свободное поле шириной 20 мм.

Обозначение и размеры основных форматов указаны в таблице 1.

На каждом формате в нижнем правом углу делается основная надпись по ГОСТ 2.104 –приложение Б.

Таблица 1 - Основные форматы

Обозначение формата	Размеры, мм	Обозначение формата	Размеры, мм
А1	594× 841	А3	297× 420
А2	420× 594	А4	210× 297

Оформление чертежей деталей и сборочных чертежей должно соответствовать требованиям стандартов ЕСКД. Общие требования к чертежам - по ГОСТ 2.109.

На чертеже детали должны быть указаны:

· - все размеры, необходимые для изготовления данной детали с указанием предельных размеров. Предельные отклонения размеров должны соответствовать требованиям стандартов. Единой системы допусков и посадок (ЕСДП, ГОСТ 25446);

· - шероховатость поверхностей деталей, выполняемых по данному чертежу, независимо от метода их образования;

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

· -условные обозначения марки материалов в соответствии со стандартами или техническими условиями на данный материал.

На сборочных чертежах должны быть указаны:

· - габаритные и присоединительные размеры сборочной единицы;

· - технические требования, предъявляемые к сборке изделия.

· - номера позиций, указанные в спецификации сборочной единицы.

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

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

Оформление электрических схем должно соответствовать требованиям стандартов группы 7 ЕСКД (ГОСТ 2.701-84, ГОСТ 2.702-75 и т. д.). На приводимых в документе электрических схемах около каждого элемента указывают его позиционное обозначение, установленное соответствующими стандартами, и при, необходимости номинальное значение величины.

Оформление схем, алгоритма, программ, данных и систем должно соответствовать ГОСТ 19. 701.

Оформление схем в работах, связанных с созданием АСУ, должно соответствовать ГОСТ 24. 302 и ГОСТ 24.303.

Оформление технологических схем по ЭНГМ должно соответствовать ГОСТ 2.108.

По специальностям 2- 36 07 01 "Машины и аппараты химических производств и предприятий строительных материалов" и 2- 48 01 01 "Химическая технология неорганических веществ, материалов и изделий" на сборочных чертежах аппаратов помещают техническую характеристику аппарата (машины) и таблицу назначения штуцеров.

Форма таблиц и образец заполнения приведены ниже.

Таблицы строятся на правой линии рамки, ограничивающей поле чертежа: таблица характеристики аппарата - над основной надписью на расстоянии не менее 12 мм от нее; таблица штуцеров - над таблицей характеристики аппарата на расстоянии не менее 12 мм от нее.

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

Технологическая документация (для специальности 2-360101 - Технология машиностроения) оформляется отдельным альбомом на картах стандартного образца в соответствии с требованиями ЕСТД.

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

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

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