Построение отчетного документа

 

Общая структура документа, описание структурных элементов приведены в разделах 2 и 3 данного документа.

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

Внутри подразделов, пунктов, подпунктов могут быть приведены перечисления (списки). Перечисления оформляются с абзацного отступа. Перед каждой позицией перечисления следует ставить маркер «-» (дефис). При необходимости ссылки на одно из перечислений списка в качестве маркера следует использовать строчную букву, после которой ставится круглая скобка: «а) _____». Для дальнейшей детализации перечислений необходимо использовать арабские цифры с круглой скобкой: «1) ______».

Разделы должны иметь порядковые номера, нумерация - в пределах всего документа. После номера раздела точка не ставится. Слова «Раздел», «Подраздел», «Пункт», «Подпункт» не пишутся.

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

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

Каждый структурный элемент документа и каждый раздел следует начинать с нового листа (страницы).

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

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

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

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

Переносы в заголовках не допускаются.

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

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

Оформление формульных выражений

 

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

Если на формульное выражение предполагается ссылка, то формульное выражение следует нумеровать. Нумерация (обычно) сквозная, в пределах всего документа. Используются арабские цифры в круглых скобках в крайнем правом положении на строке. Допускается нумерация формул в пределах раздела. В этом случае номер формулы состоит из номера раздела и порядкового номера формулы, разделенных точкой, например (3.1). Формулы, помещаемые в приложениях, должны нумероваться отдельной нумерацией арабскими цифрами в пределах каждого приложения с добавлением перед каждой цифрой обозначения приложения, например формула (В.1). Ссылки в тексте на порядковые номера формул дают в скобках: «... в формуле (1)».

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

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

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

 

(1)

где	m – масса образца, кг;
	V – объем образца, м3.

 

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

Пример – Математическое ожидание платежа игрока А игроку В есть:

 

 

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

Пример – Аналогично определяются Следовательно, оптимальные стратегии игроков А и В соответственно равны

 

 

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

 

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

Иллюстрации должны иметь номер. Иллюстрации, за исключением иллюстраций приложений, следует нумеровать арабскими цифрами сквозной нумерацией. Если в тексте документа один рисунок, то он обозначается «Рисунок 1». Допускается нумеровать иллюстрации в пределах раздела. В этом случае номер иллюстрации состоит из номера раздела и порядкового номера иллюстрации, разделенных точкой. Например: «Рисунок 1.1». Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Например: «Рисунок А.3».

На все иллюстрации обязательно должны быть даны ссылки. При ссылке на иллюстрацию следует писать «…в соответствии с рисунком 2», «… в соответствии с рисунком 1.2».

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

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

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

 

 

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

 

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

 

 

 

Рисунок 2 – Оформление таблиц

 

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

Слово «Таблица» и номер таблицы помещают над таблицей, выравнивают по левому краю без отступа.

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

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

Таблицу с большим количеством строк допускается переносить на другой лист (страницу). В этом случае в первой части таблицы должны быть указаны кроме смысловых наименований столбцов их числовые обозначения. Остальные части таблицы содержат в качестве заголовков только их числовые обозначения. Слово «Таблица», ее номер и название указывают один раз над первой частью таблицы. Над другими частями пишут слово «Продолжение таблицы…» и указывают номер таблицы, например: «Продолжение таблицы 1».

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

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

 

Рисунок 3 – Пример таблицы с небольшим количеством столбцов

 

Оформление примечаний, сносок, ссылок

 

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

 

Рисунок 4 – Оформление примечаний

 

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

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

Если необходимо специально пояснить отдельные данные, приведенные в текстовом документе, то следует использовать сноски. Сноски оформляются в соответствии с рисунками 5, 6, 7.

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

 

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

 

 

Рисунок 6 – Пример оформления сноски в таблице

 

Вместо цифр допускается использование символа «*» (звездочка). Более четырех звездочек применять не рекомендуется.

Нумерация сносок отдельная для каждой страницы.

 

Рисунок 7 – Пример оформления сносок на разных станицах

 

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

Внутри документа допускаются ссылки на номера разделов, подразделов, пунктов, подпунктов, иллюстраций, таблиц и приложений, а также на графы и строки таблиц. Например: «...должно соответствовать разделу 2», «по пп. 1.2.3; 3.2.4», «...по формуле (4)», «...в соответствии с приложением 4», «в соответствии с таблицей 4». Если в документе имеется только одна иллюстрация, одна формула, одна таблица или одно приложение, то при ссылках на них следует писать: «в соответствии с рисунком», «по формуле», «в соответствии с таблицей», «в соответствии с приложением».

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

 

Примеры

 

1 Указывается автор, название работы, год издания:

Впервые стратегические игры в полном объеме были описаны в монографии Фон Неймана и Моргенштерна «Теория игр и экономическое поведение», 1947 год.

 

2 Указывается автор, период или год издания, используется обозначение ссылки - квадратные скобки:

Проблема была изучена в начале XIX столетия немецким геометром Якобом Штейном [18].

 

3 Указывается автор и используется обозначение ссылки:

В классической работе Дж. Форрестера [32] была построена математическая модель мировой динамики

 

4 Автор, название не указываются, используется только обозначение ссылки:

Профессия инженера требует серьезного овладения профессиональными сведениями, основанными на математике [3].

 

4 Автор, название не указываются, используется обозначение ссылки на несколько источников:

Рассмотрим основные особенности прогноза [10, 11, 26].

 

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

 

 

Обозначение документов

 

Как уже было отмечено в 4.1, все листы текстового отчетного документа, связанного с работой исследовательского, конструкторского, технологического характера (в том числе, со всеми работами по общепрофессиональным и специальным дисциплинам технических специальностей), кроме титульного листа и задания, содержат рамки и надписи. Вид рамок, содержание, расположение и размеры граф и надписей прописаны в ГОСТ 2-104. Основную надпись на листах формата А4 располагают вдоль нижней короткой стороны формата. Надписи в текстовых документах должны соответствовать форме 2 на первом, или заглавном листе и форме 3 – на последующих листах. Графы надписи заполняют в соответствии с рисунком 8.

 

 

 

Рисунок 8 - Формы надписей согласно ГОСТ 2.104 и обозначение граф

Графы и поля надписей содержат атрибуты работы и студента.

Заполнение основной надписи (номера граф на формах показаны в скобках):

Графа 1 - наименование документа (например, тема проекта);

Графа 2 - обозначение документа по принятой форме (структурное обозначение описано ниже);

Графа 7 - порядковый номер листа;

Графа 8 - общее количество листов документа (графу заполняют на первом листе);

Графа 9 - индекс (обозначение) учебной группы студента;

Графа 11 - фамилии лиц, подписавших документ;

Графа 12 - подписи лиц, фамилии которых указаны в графе 11;

Графа 13 - дата подписания документа (заполняется «от руки»).

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

 

 

Таблица 2 – Поля структурного обозначения документа

 

Название поля	Назначение поля	Примеры содержимого поля
Обозначение формы обучения	Идентифицирует форму обучения студента	ОФ – очная форма

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

Код специальности	Идентифицирует специальность студента по коду ОКСО	230105 – специальность групп ПО 140613 – специальность групп ТЭРЭ 220301 - специальность групп АТП 270103 - специальность групп ЭЗС 190604 - специальность групп ТОА 150411- специальность групп ТОР
Вид деятельности студента	Идентифицирует вид деятельности студента, в рамках которой готовится данный отчетный документ	Д - дипломный проект, К - курсовой проект, УП – учебная практика, ТП – технологическая практика, ПП – преддипломная практика, ЛП – лабораторный практикум
Номер студента по журналу	Отражает номер студента в учебном журнале группы	В случае индивидуальной работы: 01 или 20 В случае групповой работы в порядке возрастания: 02 10 16
Вид документа	Идентифицирует вид отчетного документа	ПЗ - пояснительная записка, О – отчет

 

Пример структурного обозначения документа:

ОФ 230105 Д 07 ПЗ

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