1. Структура и содержание текстовых документов
1.1. К текстовым документам учебных проектов и работ относятся: пояснительная записка, расчетно-графическая работа, спецификация, реферат, отчет о практике.
1.2. Текст документа должен быть кратким, точным, не допускающим различных толкований, логически последовательным, необходимым и достаточным для понимания сути изложенного.
1.3. Структура текстовых документов (кроме спецификаций)
1.3.1. Структурными элементами пояснительной записки дипломного проекта (работы) являются:
- титульный лист;
- задание;
- реферат;
- содержание;
- перечень листов графических документов;
- перечень сокращений, условных обозначений, символов, единиц;
- список терминов;
- введение;
- основная часть;
- заключение;
- библиографический список;
- приложения.
1.3.2. Обязательные структурные элементы выделены полужирным шрифтом.
1.3.3. По некоторым видам работ в соответствии с Рабочими программами дисциплин могут быть установлены другие структурные элементы.
1.4. Объем текстовых документов
- пояснительной записки дипломных проектов и работ 90…150 страниц рукописного текста или 60…100 страниц текста в другом варианте исполнения формата А4 по ГОСТ 2.301;
- пояснительной записки курсовых проектов и работ, расчетно-графической работы, реферата, отчета о практике 10…60 страниц рукописного или 7…40 страниц иного варианта исполнения текста формата А4.
При выполнении документа несколькими студентами его объем соответственно увеличивается и определяется руководителем работы.
1.5. Содержание структурных элементов текстовых документов
1.5.1. Титульный лист
Титульный лист является первой страницей документа и служит источником информации, необходимой для обработки и поиска документа.
1.5.2. Задание на проект (работу)
Задание является обязательным структурным элементом дипломного проекта (работы). Для остальных видов учебных документов задание как структурный элемент документа может отсутствовать.
В задании приводятся основные данные для выполнения работы. При необходимости задание может быть дополнено приложением, устанавливающим более подробное содержание отдельных его частей.
1.5.3. Реферат
Реферат представляет краткое изложение выполненной работы, обеспечивающее быструю подачу систематизированной информации в свернутом виде на основе ее смысловой переработки и раскрытия наиболее важных сторон содержания реферируемой работы.
Текст реферата должен отражать (в приведенной последовательности): объект исследования или разработки, цель работы, методы исследования и аппаратуру или иные средства, полученные результаты и их новизну, основные архитектурно-планировочные, градостроительные, конструктивные, технологические, технико-эксплуатационные или другие характеристики, степень внедрения или рекомендации по внедрению, область применения, экономическую эффективность или иную значимость работы, количество страниц, иллюстраций, таблиц, приложений.
Если в выполненной работе отсутствуют какие-либо из перечисленных структурных частей реферата, то в тексте реферата они опускаются, при этом последовательность изложения сохраняется. Структурный части реферата, отмеченные полужирным шрифтом, являются обязательными.
В реферате следует применять стандартизированную терминологию. Язык реферата должен быть лаконичным.
Оптимальный объем реферата не более 2000 знаков.
Реферат является обязательным структурным элементом для пояснительных записок дипломных проектов и работ.
1.5.4. Содержание
Содержание включает все структурные элементы текстового документа за исключением титульного листа, задания и реферата (введение, наименование всех разделов и подразделов основной части и т.д.) с указанием номеров страниц, с которых они начинаются.
В документе объемом до 10 страниц включительно содержание допускается не составлять.
Содержание является обязательным структурным элементом для документов всех видов учебных работ.
1.5.5. Перечень листов графических документов
В перечне листов графических документов перечисляются по порядку все листы графических документов с указанием изображений, помещенных на каждом листе.
1.5.6. Перечень сокращений, условных обозначений, символов, единиц измерения
Принятые в документе малораспространенные сокращения, условные обозначения, символы, единицы измерения при необходимости представляются в виде отдельного списка.
Если сокращения, условные обозначения, символы, единицы повторяются в отчете менее трех раз, отдельный список не составляется, а расшифровка приводится непосредственно в тексте документа при первом упоминании.
1.5.7. Список терминов
Список терминов составляется при необходимости. При этом термины должны быть перечислены в алфавитном порядке.
1.5.8. Введение
Введение должно содержать современное состояние решаемое научно-технической проблемы, основание и исходные данные для разработки темы, обоснование необходимости выполнения проекта (работы), цель и задачи, которые необходимо решить для достижения поставленной цели.
Для научно-исследовательских работ во введении должна быть показана актуальность темы и новизна полученных результатов.
Введение является обязательным структурным элементом для пояснительных записок дипломных проектов и работ.
1.5.9. Основная часть
Структура и содержание основной части пояснительной записки курсовых проектов и работ, а также расчетно-графических работ должны соответствовать Рабочим программам дисциплин и методическим указаниям.
Структура и содержание основной части отчетов о практике и рефератов настоящим стандартом не нормируются и определяются руководителем в соответствии со «Сквозной программой практики».
Структура и содержание основной части пояснительной записки дипломных проектов и работ устанавливается в задании на выполнение проекта (работы) руководителем и утверждается заведующим кафедрой. Перечень и объем подразделов основной части пояснительной записки дипломного (курсового) проекта или работы, устанавливаемые кафедрой, ведущей проектирование, с учетом специфики тематики, должны соответствовать содержанию проекта (работы).
Примерное содержание основной части дипломных проектов, выполняемых по различным специальностям, и дипломных работ приведено в приложениях Г, Д, Е.
В некоторых случаях возможны другой перечень подразделов основной части пояснительной записки и их содержание, которые определяются руководителем в соответствии со спецификой темы проекта.
Основная часть может также включать:
- другие разделы с более глубокой проработкой решений (научно-исследовательских, конструкторских, технологических, градостроительных, экономических и др.), например: методика исследований, измерений, испытаний, САПР и др.;
- отчет или результаты УИРС (НИР), выполненные по теме проекта.
Основная часть документа должна содержать данные, отражающие существо, методику и основные результаты выполненной работы.
В основной части с достаточной полнотой и ясностью должны быть приведены результаты технических и экономических расчетов, теоретических и экспериментальных исследований, описаны разработанные конструктивные решения, технологические процессы и т.п.
Основная часть должна быть изложена точным и строгим языком, с максимальной степенью упорядоченности излагаемого материала.
Расчеты выполняют на листах документа. В общем случае расчеты должны содержать:
- эскиз или схему рассчитываемого изделия;
- указания, что требуется определить при расчете;
- данные для расчета;
- сам расчет;
- результаты расчета;
- выводы (заключение) по результатам расчета.
Единицы физических величин должны быть выражены в системе СИ согласно ГОСТ 8.417 и в единицах, допускаемых к применению наравне с единицами СИ, а также в кратных (10n) и дольных (10-n) от них.
1.5.10. Заключение
Заключение подводит итог выполненной работе.
В общем случае заключение должно содержать:
- краткие выводы по результатам выполненной работы;
- оценку технико-экономической эффективности либо иной народно-хозяйственной, социальной или научной значимости работы;
- общие итоговые технико-экономические данные о результатах работы;
- предложения по использованию результатов работы.
Выводы должны соответствовать цели и поставленным задачам.
1.5.11. Библиографический список
Библиографический список должен содержать сведения об источниках, использованных при выполнении работы.
При большом количестве источников информации целесообразно приводить только те работы, которые действительно необходимы.
1.5.12. Приложения
В приложения рекомендуется включать связанные с выполненной работой материалы, которые по какой-либо причине не могут быть включены в основную часть.
В приложения могут быть включены:
- материалы, дополняющие пояснительную записку;
- промежуточные математические доказательства, формулы и расчеты;
- таблицы вспомогательных цифровых данных;
- протоколы, ведомости, программы и акты испытаний;
- описание аппаратуры и приборов, примененных при проведении экспериментальных исследований;
- инструкции, методики, описания алгоритмов и программ задач (в том числе решаемых на ЭВМ), разработанных в процессе выполнения работы или используемых в данной работе;
- иллюстрации вспомогательного характера;
- акты внедрения или справки о внедрении результатов работы;
- отчет о патентных исследованиях;
- библиографический список публикаций и патентных документов, полученных в результате выполнения работы и др.
Иллюстрации, таблицы и распечатки ЭВМ, выполненные на листах формата А3, также рекомендуется включать в приложения.