Правила оформления отчетов

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

Отчет по работе является ее основным итоговым документом и оформляется в соответствии с ГОСТ 7.32-2017 «Отчет о научно-исследовательской работе». В данном разделе изложены извлеченные из этого ГОСТа и Государственных образовательных стандартов основные требования к оформлению отчета. Правила оформления ссылок на литературу приведены по ГОСТ Р 7.0.5-2008 «Система стандартов по информации, библиотечному и издательскому делу. Библиографическая ссылка. Общие требования и правила составления».

1 Требования к форме документа

1.1 Отчет может быть рукописным, но, как правило, должен быть оформлен с использованием стандартных редакторов на ЭВМ (для квалификационных работ — обязательно) (по согласованию с руководителем во всех случаях, кроме дипломов, может представляться только электронная копия работ). Отчет пишется (печатается) с одной стороны листа на белой бумаге формата А4 с полями не менее 10 мм справа, 30 мм слева, 20 мм сверху, 20 мм снизу. Поля не отчеркиваются. Листы должны быть сброшюрованы (отчет переплетен, сшит, заключен в «папку для дипломов»).

1.2 Каждый структурный элемент отчета следует начинать с нового листа. Листы отчета нумеруются подряд, начиная с титульного листа (ему присваивается номер 1, однако на этом листе номер не ставится). Номер страницы проставляется в центре нижней части страницы без точки.

1.3 На титульном листе ВКР указывается:

Фамилия Имя Отчество

ТЕМА ВЫПУСКНОЙ КВАЛИФИКАЦИОННОЙ РАБОТЫ

выпускная квалификационная работа

обучающегося __ курса очной формы обучения

по направлению подготовки XX.XX.XX «наименование направления»

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

Пример оформления отчёта с различными титульными листами: Файл:Example.pdf.

Для отчетов по НИР и грантам, представляемым в другие организации, а также на депонирование, титульный лист содержит и другие элементы (индекс УДК, грифы согласования и утверждения, см. ГОСТ 7.32-2017).

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

1.4 Если работа выполнена коллективом авторов, то на листе 2 помещается «СПИСОК ИСПОЛНИТЕЛЕЙ». Под таким заголовком в алфавитном порядке перечисляются: фамилия, и. о. исполнителя, курс (группа) для студента или должность, если в составе творческой группы есть сотрудники и указываются разделы отчета, в которых отражена выполненная данным исполнителем часть работы.

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

1.5 На следующем листе пишется слово «РЕФЕРАТ», далее указывается число страниц, таблиц, рисунков и ссылок на литературу в данной работе. Затем следует краткое изложение постановки задачи, методов ее решения, основных результатов. Далее пишутся ключевые слова, перечисленные в алфавитном порядке в именительном падеже (5-10 слов, отражающих основное содержание работы). Объем реферата — примерно 1/2 страницы.

1.6 На следующем за «РЕФЕРАТОМ» листе (или листах) помещается «СОДЕРЖАНИЕ» работы. Под заголовком «СОДЕРЖАНИЕ», написанным посередине верхней строки, помещается наименование разделов и номера страниц, с которых они начинаются.

1.7 Если в отчете есть ссылки на стандарты, то перечень этих стандартов оформляется отдельным структурным элементом отчета «НОРМАТИВНЫЕ ССЫЛКИ», который следует за разделом «СОДЕРЖАНИЕ».

1.8 В случае необходимости после «СОДЕРЖАНИЯ» может быть помещен структурный элемент «Определения», который содержит определения, необходимые для уточнения или установления терминов, используемых в отчете.

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

1.10 Далее с нового листа начинается основной текст отчета. Отчет должен состоять из «ВВЕДЕНИЯ», «РАЗДЕЛОВ», «ЗАКЛЮЧЕНИЯ», "СПИСКА ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ " и «ПРИЛОЖЕНИЯ» (последнее не обязательно).

Ссылки на использованные источники следует приводить в квадратных скобках.

1.11 Каждый из разделов начинается с нового листа. Заголовки («Введение», «Заключение», названия разделов) при печати печатаются заглавными буквами или выделяются шрифтом. Разделы нумеруются арабскими цифрами («Введение» и «Заключение» не нумеруются).

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

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

— далее текст

а) далее текст

б) далее текст

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

1.15 Рисунки нумеруются подряд в пределах данного раздела двойной нумерацией: номер раздела. номер рисунка.

1.16 Все рисунки снабжаются подписями независимо от того, как подробно описано в тексте отчета то, что изображено на данном рисунке.

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

Рисунок 1 — Детали прибора

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

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

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

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

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

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

Допускается обозначение приложения буквами латинского алфавита за исключением букв I и О.

1.22 Рисунки каждого приложения и таблицы обозначаются отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Пример, Рисунок А.5 или Таблица Б.2.

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

1.24 Список литературы дается в конце работы (перед «ПРИЛОЖЕНИЕМ») под заголовком «СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ».

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

1.26 Оформление ссылок должно соответствовать приведенным в приложении примерам.

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

1.28 Если примечание одно, то оно оформляется так: Примечание — далее текст. Если несколько:

Примечания

1 далее текст

2 далее текст.

2 Требования к содержанию

2.1 Во введении излагается цель и назначение работы, обосновывается ее актуальность, дается оценка современного состояния решаемой проблемы, указывается на возможные области внедрения. Может быть приведено задание на работу. Может быть сделан краткий обзор отчета, обоснована его структура (особенно, если взаимосвязь его разделов на первый взгляд не очевидна). Введение должно быть кратким (2-3 стр.). Из введения читатель должен понять основную цель и содержание работы. Это как бы реклама работы и отчета. Читатель, впервые взявший отчет и не знакомый с работой, прочитав «Введение», должен понять, стоит ли читать дальше.

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

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

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

2.5 Если работа не ставится как чисто реферативная, то обзор литературы должен составлять по объему не более 1/5-1/4 всего отчета.

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

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

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

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

2.6.4 Если в работе выполнялись какие-либо измерения и (или) расчеты, то следует приводить (с указанием погрешности!) не только их окончательные результаты, но и по возможности все промежуточные результаты (непосредственные результаты измерений, использованные в последующих расчетах табличные и другие дополнительные данные; результаты всех повторных измерений, расчетов, результаты, полученные при различных вариантах измерительной (расчетной) методики и т. д. — можно это делать в приложении.

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

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

2.8 В «Заключении» кратко излагаются основные результаты работы, оценивается степень достижения поставленной цели. Могут даваться рекомендации по дальнейшему развитию работы и возможным применениям полученных результатов. Из «Заключения» читатель должен увидеть объем проделанной работы и ее ценность.

2.9 В приложения выносятся громоздкие по объему материалы, наличие которых в основном тексте затруднило бы его восприятие:

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

2.10 Описание программы должно включать:

2.10.1 Название и назначение программы.

2.10.2 Язык программирования и название компилятора.

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

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

2.10.5 Описание используемых ключевых переменных (желательно в листинге программы).

2.10.6 Перечень используемых библиотечных функций.

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

2.10.8 Пример действия программы (если есть необходимость).

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

3 Дополнительные требования к квалификационным работам (бакалаврским, дипломным, магистерским)

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

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

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

Приложение: Примеры оформления ссылок

Ссылки на книги

Смолянинов В. В. Математические модели биологических тканей. — М., 1980. — 368 с.

Ланно М., Бургуэн Ж. Точечные дефекты в полупроводниках: Теория / пер. с англ. Ю. М. Гальперина, В. И. Козуба. — М., 1984. — 264 с.

Юнусов С. Ю. Алкалоиды. — 3-е изд. — Ташкент, 1981. — 420 с.

Ссылки под заглавием

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

Физические свойства полупроводников / И. А. Захаров, С. В. Ковалев, Т. H. Кожина [и др.]. — Л., 1980. — 287 с.

Спектральные приборы / под общ. ред. H. А. Власюка. — 2-е изд. — Киев, 1979. — 280 с.

Физические свойства магнитных полупроводников / АH СССР. Сиб. отд. АH СССР. Ин-т физики им. Л. В. Киренского. — Красноярск, 1983. — 150 с.

Основы физики плазмы: В 2-х т. — М., 1984. — Т. 2.

Рациональное использование твердых бытовых отходов. — М., 1984. — 248 c. (Итоги науки и техники / ВИHИТИ. Охрана природы и воспроизводство; Т. 15).

Ссылки на статьи

Иванов В. С., Петров П. H. Особенности ЯМР в ферромагнетиках // Физические свойства полупроводников. — М., 1983. — С.32-41.

Кузнецов В. А. Фотоперенос электрона в растворах родамина // Оптика и спектроскопия / В. А. Кузнецов, В. H. Шамараев, Г. H. Иванов [и др.]. — 1984. — Т. 57. — N 1. — С. 15-18.

Ссылки на патентные документы

Способ получения антивирусных препаратов из дрожжей: а.с. 687120 СССР / А. Г. Коваленко, А. Д. Бобырев (СССР). N 258404/30-15; заявл. 01.03.78; опубл. 2.05.78, Бюл. N 35. — С. 10-11.

Способ получения бактерий: пат. 615871 ФРГ / Ю. Овербек, М. Hагуиб (ФРГ). N 1699988/28-3; заявл. 15.09.71; опубл. 15.07.78, Бюл. N 26. — С. 4-5.

Ссылки на препринты

Еленин Г. Г. Непрерывные модели. — М., 1981. — 20 с. (Препринт / Ин-т прикл. мат.: N 46.)

Ссылки на авторефераты диссертаций и диссертации

Черепанова Л. Л. Мхи Саратовской области: автореф. дис. … канд. биол. наук. — Л., 1980. — 20 c.

Калиниченко И. М. Исследование влияния ионизирующей радиации: дис. … канд. биол. наук. — М., 1970. — 212 с.

Ссылки на депонированные рукописи

Диков В. А. Генетика эффективных нарушений у человека / Ин-т общ. генет. АH СССР. — 1981. — 38 с. (Рукопись деп. в ВИHИТИ N 3256-81 от 2 июля 1981.)

О биологической активности / Бондарь В. К. [и др.]. / Редкол. журн. Биол. науки. — М., 1981. — 9 с. (Рукопись деп. в ВИHИТИ N 3929-81 от 5 авг. 1981.)

Ссылки на электронные ресурсы

Жиганов Е. Д. Пишем сетевые приложения. URL: http://zed.karelia.ru/4them/socks.html (дата обращения: 12.05.2009).

Ванюшин И. В. Методика измерения характеристики преобразования АЦП // Исследовано в России: электрон. многопредм. науч. журн. 2000. [Т. 3]. С. 263-272. URL: http://zhurnal.ape.relarn.ru/articles/2000/019.pdf (дата обращения: 06.05.2009).

Дополнительно:

Ещё несколько примеров библиографического описания литературных источников: Файл:Biblio.pdf.

Особенности использования LaTeX для оформления ВКР описаны в документе: Файл:Example.pdf.

Полный текст ГОСТ 7.32-2017: Файл:ГОСТ 7.32-2017.pdf.