- •Содержание
- •1. Характеристика отчетных документов по курсовому
- •Структура и правила оформления отчетного документа
- •2.1. Структура отчетного документа
- •2.2 Правила оформления отчетного документа
- •2.2.1 Общие требования
- •2.2.2 Нумерация страниц, разделов, подразделов, пунктов и подпунктов работы
- •2.2.4 Иллюстрации
- •2.2.5 Таблицы
- •2.2.6 Формулы и уравнения
- •2.2.7 Ссылки
- •2.2.8 Примечания
- •2.2.9 Приложения
- •2.2.10 Оформление программной документации
- •2.2.11. Рекомендуемый объем отчетного документа
- •3 Подготовка к защите и защита отчетных документов
- •Литература
- •Проект (курсовую, дипломную работы)
- •Реферат
- •Примеры оформления рисунков
Структура и правила оформления отчетного документа
2.1. Структура отчетного документа
Отчетный документ по курсовому и дипломному проектированию (будем называть также проект, работа) должен иметь следующую структуру:
– титульный лист (см. приложение А);
– задание на проект (см. приложение Б);
– аннотация;
– реферат (см. приложение В);
– содержание
– обозначения и сокращения (при необходимости);
– введение;
– основная часть;
– заключение;
– список использованных источников (см. приложение Е);
– приложения (при необходимости);
– электронные материалы на дискете или лазерном диске в конверте.
Титульный лист является первой страницей проекта и служит источником информации, необходимой для обработки и поиска документа. Образцы титульных листов приведен в приложении А.
Задание на проект выдается студенту руководителем проекта. Содержание проекта, отраженное в разделах задания, является по существу индивидуальным, и поэтому части задания в зависимости от значимости могут быть представлены в разном сочетании. Типовой образец задания на проект приведен в приложении Б.
Аннотация выполненной работы приводится на трех языках: белорусском, русском и английском.
Реферат проекта должен быть достаточно полным. Он должен обязательно включать ключевые сведения о предмете, цели, о методах исследования и об основных результатах работы.
Реферат должен содержать: сведения об объеме работы, количестве частей проекта, количестве иллюстраций, таблиц, использованных источников, приложений; перечень ключевых слов; текст.
Перечень ключевых слов должен включать от 5 до 15 слов или словосочетаний из текста работы, которые в наибольшей мере характеризуют ее содержание и обеспечивают возможность информационного поиска. Ключевые слова приводятся в именительном падеже и печатаются прописными буквами в строку через запятые.
Текст реферата должен отражать: объект исследования или разработки;
цель работы; метод или методологию проведения работы; результаты работы и их новизну; основные конструктивные, технологические и технико-эксплуатационные характеристики; степень внедрения или рекомендации по внедрению результатов проекта; область применения; значимость работы.
Если проект не содержит сведений по какой-либо из перечисленных структурных частей реферата, то в тексте реферата эта часть опускается, при этом последовательность изложения сохраняется.
Оптимальный объем текста реферата – одна страница.
Пример составления реферата дан в приложении В.
Содержание включает нормативные ссылки, определения, обозначения и сокращения (если таковые имеются), введение, наименование всех разделов, подразделов, пунктов (если они имеют наименование), заключение,
список использованных источников и наименование приложений с указанием номеров страниц, с которых начинаются эти элементы в отчетном документе. После содержания допускается привести в форме оглавления перечни
рисунков и таблиц, приведенных в отчете.
Обозначения и сокращения содержат перечень обозначений и сокращений, применяемых в данном проекте.
Запись обозначений и сокращений проводят в порядке использования их в тексте проекта с необходимой расшифровкой и пояснениями.
Введение характеризует современное состояние проблемы, которой посвящен проект, в виде литературного обзора, а также цель работы и значимость научной проблематики.
Для значительной категории потребителей информации (особенно при информационном поиске) два основных структурных раздела – “введение” и
“заключение” – представляют самостоятельный интерес. Следовательно,
они должны содержать максимум полезных и нужных сведений и должны
выполнять важнейшие информационные функции.
Во введении следует четко формулировать, в чем конкретно заключается смысл описываемой работы. По одной проблеме могут выполняться не-
сколько аналогичных проектов. Поэтому нужно обосновать необходимость
проведения этой работы, показать ее место среди аналогичных работ, описать цель работы.
Литературный обзор выполняется в форме реферата. Здесь отражается
значимость разработки проекта по данной теме проекта, научное состояние
проблемы и обозначаются вопросы, подлежащие анализу и разработке.
Основная часть является наиболее важной и результативной частью
проекта. По структуре она зависит от темы проекта и от удельного веса составляющих его частей (теоретической и практической). Материал основной
части отражает сущность, методику и основные результаты выполненной
работы. Здесь же излагаются вопросы по применению программного обеспечения на этапах решения задач по теме проекта.
Таким образом, основная часть должна содержать:
– выбор направления исследований, включающий обоснование направления исследования, методы решения задач и их сравнительную оценку, описание выбранной общей методики проведения исследований;
– процесс теоретических и (или) экспериментальных исследований, включая определение характера и содержания теоретических исследований,
методы исследований, методы расчета, обоснование необходимости проведения экспериментальных работ, принципы действия разработанных объектов, их характеристики;
– обобщение и оценку результатов исследований, включающих оценку
полноты решения поставленной задачи и предложения по дальнейшим на-
правлениям работ, оценку достоверности полученных результатов и их
сравнение с аналогичными результатами отечественных и зарубежных работ, обоснование необходимости проведения дополнительных исследований, отрицательные результаты, приводящие к необходимости прекращения дальнейших исследований.
Результаты, полученные в ходе работы, должны быть четко отделены от результатов, заимствованных из других работ и научных документов.
В зависимости от особенностей выполненной работы основную часть можно представить в виде текста, таблицы, сочетания иллюстраций и таблиц, и дополнительно необходимо представить в виде компьютерной презентации.
Заключение является одной из важнейших частей проекта, которое содержит оценку в виде выводов основных наиболее важных полученных результатов работы. Очень важно, чтобы выводы, сделанные в процессе работы, не были бездоказательными, необоснованными. Недопустимо искажение результатов или умолчание отрицательных результатов.
В общем случае заключение должно содержать: основные выводы по результатам выполнения проекта или отдельных его этапов; оценку полноты
решений поставленных задач; рекомендации и исходные данные по конкретному использованию результатов работы; оценку научно-технического уровня выполненной работы в сравнении с лучшими достижениями в данной области.
В процессе работы могут выявиться новые (в известном смысле неожиданные) закономерности, новые данные. Все эти сведения также должны
быть оценены в заключении. Помимо оценки результатов работы, заключение должно содержать информацию о путях и целях дальнейшей работы или
мотивированный вывод о нецелесообразности продолжения проекта.
Список использованных источников должен содержать сведения об источниках, использованных при выполнении работы, в соответствии с требованиями ГОСТ 7.1. Источники следует располагать в порядке появления ссылок в тексте проекта.
Сведения о книгах (монографии, учебники и т.д.) должны включать:
фамилию, инициалы автора, заглавие книги, сведения о повторности издания, место издания, издательство, год издания, порядковый номер тома,
выпуска, части, количество страниц.
Фамилию автора следует указывать в именительном падеже. Если книга написана двумя или более авторами, то их фамилии с инициалами указа-
ют в той последовательности, в какой они напечатаны в книге, перед фамилией последующего автора ставят запятую. Заглавие книги следует приводить в том виде, в каком оно дано на титульном листе. Наименование места
издания необходимо приводить полностью в именительном падеже, допускается сокращение некоторых городов. Например, Москва (М), Минск
(Мн).
Сведения о статье на периодическое (продолжающееся) издание должны включать: фамилию и инициалы автора, заглавие статьи, сведения об издании, в котором опубликована статья: (наименование издания, сведения о
повторности издания, место издания, издательство, год, номер тома, номер
выпуска, страницы, на которых напечатана статья, сведения о серии).
Заглавие статьи приводят в том виде, в каком оно дано в периодическом (продолжающемся) издании. Наименование издания пишут в кавычках.
Наименование серии пишут после сокращенного слова “серия” (сер.). При указании номера страниц, на которых помещена статья, следует приводить
номера первой и последней страницы, разделенные тире, например:
Сведения об отчете о НИР должны включать: заглавие отчета, части,
выпуска, данные, определяющие характер документа (“Заключительный отчет”, “Промежуточный отчет”), наименование организации, проводившей работу, фамилия и инициалы руководителя работы, номер (код) темы, присвоенный в организации (ведомстве), номер государственной регистрации,
место составления отчета (если не указан год составления, приводят год утверждения отчета), количество страниц отчета.
Сведения о стандарте должны включать обозначение документа, заглавие, сведения о повторности издания.
Примеры образцов библиографических описаний даны в приложении Д.
Приложения оформляют как продолжение проекта на последующих страницах или в виде отдельной части, располагая их в порядке появления
ссылок в тексте.
В приложения могут быть включены: промежуточные математические
доказательства, формулы и расчеты; тексты программ; руководство пользователя; таблицы вспомогательных цифровых данных; протоколы испытаний; описание аппаратуры и приборов, применяемых при проведении экспериментов, измерений и испытаний; иллюстрации вспомогательного характера; акты внедрения результатов работы, копии публикаций по результатам выполненной работы и др.
Электронные материалы представляются в следующем виде:
После приложения вставляется (приклеивается) конверт для хранения
лазерного диска или дискеты. На внешнем носителе информации должна быть создана папка с именем, составленным по следующему формату:
Факультет_Год_Код работы_Курс_Номер группы_Номер зачетки_ФИО Студента
Имя папки следует продублировать также на конверте. Например, ГУМАНИТАРНЫЙ_2008_КП_3_01_067845_ПЕТРОВ. Здесь приведено имя папки для хранения материалов по курсовому проекту (КП) за 2008 год студента Гуманитарного факультета первой группы третьего курса Петрова, номер зачетки которого-067845.
Код работы кодируется по следующему правилу: КП – курсовой проект, КР – курсовая работа, ДР – дипломная работа и ДП – отчет по преддипломной практике.
В папке с соответствующим именем на внешнем носителе должна быть
представлена в электронном виде следующая информация: электронная копия отчетного документа; компьютерная презентация (структура и содержание презентации согласовываются с руководителем); тексты программ и примеров и другая дополнительная информация (на усмотрение студента).
Эта информация после защиты переносится в базу данных архива вуза.
