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

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

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

При этом допускается использовать повествовательную форму изложения текста документа, например «применяют», «указывают» и т.п.

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

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

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

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

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

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

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

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

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

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

- применять знак «ø» для обозначения диаметра (следует писать слово «диаметр»). При указании размера или предельных отклонений диаметра на чертежах, помещенных в тексте документа, перед размерным числом следует писать знак «ø»;

- применять без числовых значений математические знаки, например > (больше), < (меньше), = (равно), ≥ (больше или равно), ≤ (меньше или равно), ≠ (не равно), а также знаки № (номер), % (процент);

- применять индексы стандартов (ГОСТ, ОСТ, РСТ, СТП, СЗВ, СТ) без регистрационных номеров.

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

Например:

1 Провести испытания пяти труб, каждая длиной 5 м.

2 Отобрать 15 труб для испытаний на давление.

Единица физической величины одного и того же параметра в пределах одного документа должна быть постоянной. Если в документе проводится ряд числовых значений, выраженных в одной и той же единице физической величины, то ее указывают только после последнего числового значения, например: 1,50; 1,75; 2,00 м.

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

Например:

1 От 1 до 5 мм.

2 От 10 до 100 кг.

3 От плюс 10 до минус 40^оС.

4 От плюс 10 до плюс 40^оС.

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

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

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

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

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

Округление числовых значений величин до первого, второго, третьего и т.д. десятичного знака для различных типоразмеров, марок и т.п. изделий одного наименования должно быть одинаковым. Например, если градация толщины стальной горячекатаной ленты должен быть указан с таким же количеством десятичных знаков, например 1,50; 1,75; 2,00.

Дробные числа необходимо приводить в виде десятичных дробей, за исключением размеров в дюймах, которые записывать 1/4″, 1/2″,

(но не , ).

При невозможности выразить числовые значения в виде десятичной дроби, допускается записывать в виде простой дроби в одну строчку через косую черту, например 5/32, (50А-4С)/(40В+20).

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

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

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

Формулы и уравнения пишутся с абзацного отступа (красной строки).

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

Если формула или уравнение не умещается в одну строку, то оно должно быть перенесено после знака равенства (=) или после знаков плюс (+), минус (-), умножения (х), деления (:), или других математических знаков, причем знак в начале следующей строки повторяют.

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

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

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

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

Ссылки на использованные источники следует приводить в квадратных скобках справа от нумерации формулы, например, … (3.1) [5].

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

Единицы физических величин в документах должны быть выражены в системе СИ по ГОСТ 8.417-81.

Все расчетные величины в процессе вычислений необходимо выражать в единицах СИ, заменяя приставки степенями числа 10.

Например:

Плотность каждого образца ρ, кг/м³, вычисляют по формуле

ρ = m/ V, (2.1) [2]

где m - масса образца, кг;

V - объем образца, м³

ρ = 50/25 = 2 кг/м³

Оформление таблиц

Цифровой материал, как правило, оформляют в виде таблиц.

Структура таблицы приведена на рисунке 1.1.

Таблица _______ ______________________________

номер наименование

Головка граф					Заголовки граф
					Подзаголовки граф
								Строки

Ряды

Боковик Графы (колонки)

(графа для заголовков)

Рисунок 1.1

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

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

На все таблицы должны быть ссылки в дипломной или курсовой работе (проекте). При ссылке следует писать «таблица» с указанием ее номера.

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

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

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

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

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

Выше и ниже строки со словом «Таблица…» должно быть оставлено по одной свободной строке.

Таблицу с большим количеством строк допускается переносить на другой лист (страницу).

При переносе части таблицы на другой лист (страницу) слово "Таблица…" указывают один раз с абзацного отступа (красной строки) над первой частью таблицы. После боковика и граф чертят строку высотой 5 мм и вносят цифры по порядку 1, 2 и т. д.

Над другими частями пишут с абзацного отступа (красной строки) слово "Продолжение" и указывают номер таблицы без её названия, например: "Продолжение таблицы 1.1" и чертят ту же строку высотой 5 мм с нумерацией 1, 2 и т. д.

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

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

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

Например:

Таблица 2.2 Дефектная ведомость

Наименование детали	Характер износа	Замена или восстановление
Редуктор механизма передвижения	Износ отверстий под подшипник, трещины	Замена корпуса редуктора
Зубчатые колеса Z2 = 44; Z4 = 56	Облом зубьев, износ головок зуба по толщине более 0,2 модуля передачи	Восстановление автоматической наплавкой под слоем флюса

Продолжение таблицы 2.2

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

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

Заголовки граф, как правило, записывают параллельно строкам таблицы.

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

Головка таблицы должна быть не менее 15 мм и отделена линией от остальной части таблицы. Высота строк таблицы должна быть не менее 8 мм.

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

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

Графу "Номер по порядку" включать в таблицу не допускается.

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

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

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

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

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

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

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

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

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

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

Если цифровые или иные данные в какой-либо строке таблицы не приводят, то в ней ставят прочерк.

Например:

Таблица 3.1 Размеры

в миллиметрах

Диаметр зенкера	С	С1	R	h	h1	S	S1
От 10 до 11 включ. Св. 10 " 12 " " 12 " 14 "	3,17 4,85 5,50	- 0,14 4,20	- 0,14 4,20	3,00 3,84 7,45	0,25 - 1,45	1,00 1,60 2,00	- 6,75 6,90

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

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

Например:

Таблица 3.2 Марки и назначение материалов

Марка стали и сплава	Назначение
Новое обозначение	Старое обозначение
08Х18Н10   08Х18Н10Т 12Х18Н10Т 09Х15Н810   07Х6Н6	0Х8Н10   0Х18Н10Т Х18Н10Т Х15Н910   Х16Н6	Трубы, детали печной арматуры, теплообменники, патрубки, муфели, реторты и коллекторы выхлопных систем, электроды искровых зажигательных свечей То же " Для изделий, работающих в атмосферных условиях То же. Не имеет дельтаферрита

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

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

Дробные числа приводят в виде десятичных дробей, за исключением размера в дюймах, которые записывают по типу 1/2.

При указании в таблицах последовательных интервалов значений величин, охватывающих все значения ряда, перед ними пишут «от», «до», например, … толщина слоя должна быть от 0,5 до 2 мм, или через тире, например: «стр. 10-15». Пределы размеров указывают от меньших к большим.

Для сокращения текста заголовков и подзаголовков граф отдельные понятия заменяют буквенными обозначениями, установленными ГОСТ 2.321 или другими обозначениями, если они пояснены в тексте или приведены на иллюстрациях, например D – диаметр, Н – высота, L – длина.

Например:

Таблица 3.4 Размеры

в миллиметрах

Условный проход D	D	L	L1	L2	Масса, кг, не более

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

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

Например:

Предельные отклонения размеров профилей всех номеров:

по высоте………………….±2,5%

по ширине………………...±1,5%

по толщине стенки……….±0,3%

по толщине полки………..±0,3%

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

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

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

Если примечание одно, то после слова «Примечание» ставится тире и

примечание печатается с прописной буквы. Одно примечание не нумеруют.

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

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

Например:

Таблица 2.1 Анализ занятости населения Республики Казахстан по

регионам

в %

П р и м е ч а н и е - Данные из сборника Агентства по статистике РК №5, 2012

Оформление рисунков

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

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

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

Рисунки могут быть в компьютерном исполнении, в том числе и цветные.

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

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

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

После номера рисунка и наименования точки не ставятся.

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

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

Слово «Рисунок» и его наименование помещают после пояснительных данных.

Сам рисунок, слово «Рисунок…», его номер и название располагают посередине строки.

На все рисунки должны быть даны ссылки в дипломной или курсовой работе (проекте). При ссылках на рисунок следует писать «в соответствии с рисунком 1.2».

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

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

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

Выше и ниже рисунка и строки со словом «Рисунок…» должно быть оставлено по одной свободной строке.

Например:

1 2 3 4 5

1 - подъемный механизм стрелы; 2 - напорный механизм; 3 – поворотный

механизм на платформе; 4 - компрессорная установка; 5 - преобразовательный агрегат

Рисунок 4.1 Схема механизмов на платформе

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

1) соотношение между толщиной линии сетки, координатных осей и

графиков 1 : 1,5 : 2.

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

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

4) наличие сетки на графиках обязательно.

Оформление приложений

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

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

В тексте дипломной или курсовой работы (проекта) на все приложения должны быть даны ссылки. Приложения располагают в порядке ссылок на них в тексте, за исключением информационного приложения «СПИСОК ЛИТЕРАТУРЫ», которое располагают последним.

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

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

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

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

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

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

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