Структура отчетного документа

Отчетный документ по курсовому и дипломному проектированию (будем называть также проект, работа) должен иметь следующую структуру:

– титульный лист (см. приложение А);

– задание на проект (см. приложение Б);

– аннотация;

– реферат (см. приложение В);

– содержание

– обозначения и сокращения (при необходимости);

– введение;

– основная часть;

– заключение;

– список использованных источников (см. приложение Е);

– приложения (при необходимости);

– электронные материалы на дискете или лазерном диске в конверте.

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

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

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

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

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

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

Текст реферата должен отражать: объект исследования или разработки;

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

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

Оптимальный объем текста реферата – одна страница.

Пример составления реферата дан в приложении В.

Содержание включает нормативные ссылки, определения, обозначения и сокращения (если таковые имеются), введение, наименование всех разделов, подразделов, пунктов (если они имеют наименование), заключение,

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

рисунков и таблиц, приведенных в отчете.

Обозначения и сокращения содержат перечень обозначений и сокращений, применяемых в данном проекте.

Запись обозначений и сокращений проводят в порядке использования их в тексте проекта с необходимой расшифровкой и пояснениями.

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

Для значительной категории потребителей информации (особенно при информационном поиске) два основных структурных раздела – “введение” и

“заключение” – представляют самостоятельный интерес. Следовательно,

они должны содержать максимум полезных и нужных сведений и должны

выполнять важнейшие информационные функции.

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

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

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

Литературный обзор выполняется в форме реферата. Здесь отражается

значимость разработки проекта по данной теме проекта, научное состояние

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

Основная часть является наиболее важной и результативной частью

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

части отражает сущность, методику и основные результаты выполненной

работы. Здесь же излагаются вопросы по применению программного обеспечения на этапах решения задач по теме проекта.

Таким образом, основная часть должна содержать:

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

– процесс теоретических и (или) экспериментальных исследований, включая определение характера и содержания теоретических исследований,

методы исследований, методы расчета, обоснование необходимости проведения экспериментальных работ, принципы действия разработанных объектов, их характеристики;

– обобщение и оценку результатов исследований, включающих оценку

полноты решения поставленной задачи и предложения по дальнейшим на-

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

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

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

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

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

В общем случае заключение должно содержать: основные выводы по результатам выполнения проекта или отдельных его этапов; оценку полноты

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

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

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

мотивированный вывод о нецелесообразности продолжения проекта.

Список использованных источников должен содержать сведения об источниках, использованных при выполнении работы, в соответствии с требованиями ГОСТ 7.1. Источники следует располагать в порядке появления ссылок в тексте проекта.

Сведения о книгах (монографии, учебники и т.д.) должны включать:

фамилию, инициалы автора, заглавие книги, сведения о повторности издания, место издания, издательство, год издания, порядковый номер тома,

выпуска, части, количество страниц.

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

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

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

(Мн).

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

повторности издания, место издания, издательство, год, номер тома, номер

выпуска, страницы, на которых напечатана статья, сведения о серии).

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

Наименование серии пишут после сокращенного слова “серия” (сер.). При указании номера страниц, на которых помещена статья, следует приводить

номера первой и последней страницы, разделенные тире, например:

Сведения об отчете о НИР должны включать: заглавие отчета, части,

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

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

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

Примеры образцов библиографических описаний даны в приложении Д.

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

ссылок в тексте.

В приложения могут быть включены: промежуточные математические

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

Электронные материалы представляются в следующем виде:

После приложения вставляется (приклеивается) конверт для хранения

лазерного диска или дискеты. На внешнем носителе информации должна быть создана папка с именем, составленным по следующему формату:

Факультет_Год_Код работы_Курс_Номер группы_Номер зачетки_ФИО Студента

Имя папки следует продублировать также на конверте. Например, ГУМАНИТАРНЫЙ_2008_КП_3_01_067845_ПЕТРОВ. Здесь приведено имя папки для хранения материалов по курсовому проекту (КП) за 2008 год студента Гуманитарного факультета первой группы третьего курса Петрова, номер зачетки которого-067845.

Код работы кодируется по следующему правилу: КП – курсовой проект, КР – курсовая работа, ДР – дипломная работа и ДП – отчет по преддипломной практике.

В папке с соответствующим именем на внешнем носителе должна быть

представлена в электронном виде следующая информация: электронная копия отчетного документа; компьютерная презентация (структура и содержание презентации согласовываются с руководителем); тексты программ и примеров и другая дополнительная информация (на усмотрение студента).

Эта информация после защиты переносится в базу данных архива вуза.

 

ПРАВИЛА ОФОРМЛЕНИЯ ОТЧЕТНОГО ДОКУМЕНТА

ОБЩИЕ ТРЕБОВАНИЯ

Изложение текста и оформление отчетного документа проекта выполняют в соответствии с правилами оформления, которые изложены ниже, а

также требованиями стандартов предприятия БГУ, ГОСТ 7.32, ГОСТ 2.105

и СТБ 6.38-2004. Страницы текста документа и включенные в него иллюстрации и таблицы должны соответствовать формату А4 по ГОСТ 9327. Отчетный документ должен быть подготовлен в электронном виде с использованием компьютера и напечатан на принтере (через один интервал) на одной стороне листа белой бумаги формата А4.

Цвет шрифта должен быть черным, высота букв, цифр и других знаков – не менее 1,8 мм (кегль не менее 12 и не более 14, шрифт – Times New Roman), размеры полей:, верхнее – 20 мм, нижнее –20 мм, правое – 10 мм, левое – 30 мм.

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

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

четкие, не расплывшиеся линии, буквы, цифры и знаки.

Опечатки, описки и графические неточности, обнаруженные в процессе

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

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

Фамилии, названия учреждений, организаций, фирм, название изделий

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

В тексте работы не допускается:

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

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

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

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

– употреблять математические знаки без цифр, например: ≤ (меньше

или равно), ≥(больше или равно), ≠ (не равно), а также знаки № (номер),

% (процент);

– применять индексы стандартов (ГОСТ, СТБ, РД, ТУ и т.д.) без регистрационного номера.

Если в работе приводятся поясняющие надписи, наносимые непосредственно на изготовляемое изделие (например, планки, таблички к элементам

управления и т.п.), то их выделяют шрифтом (без кавычек), например:ВКЛ., ОТКЛ., или кавычками – если надпись состоит из цифр, знаков.

Наименование команд, режимов, сигналов и т.п. следует выделять кавычками, например: “Сигнал +5в включено”.

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

размерности словами, например: “Абсолютная погрешность измерения – не

более 2 мм”, “Тест процессора с разными параметрами необходимо запустить два раза”.

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

величин, согласно ГОСТ 8.417.

Если в тексте приведен ряд числовых значений величин, выраженных в

одной и той же единице физической величины, то ее обозначения указывают только за последней значащей цифрой, например: 1,0; 1,5; 2,0; 2,5 мм.

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

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

после скобок или проставлять обозначения единиц после числового значения величины и после ее предельного отклонения, например: (180 ± 2) °С или 180 °С ± 2 °С.

Между последней цифрой числа и обозначением единицы следует оставлять неразделяемый пробел (например, в MS Word это комбинация – Shift + Ctrl + пробел), равный минимальному расстоянию между словами,

например: 100 кВт, 80 %, 2 °С. Исключения составляют обозначения в виде

знака над строкой, перед которыми пробел не оставляют, например: 203.

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

Точка в конце обозначения единицы физической величины не ставится.

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

Текст работы должен быть переплетен.

Наименование структурных частей работы “Реферат”, “Содержание”,

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

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

Разделы, подразделы должны иметь заголовки. Пункты, как правило,

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

Расстояние между заголовками структурных элементов и разделов основной части отчета должно быть не менее 2–2,5 интервалов.