Структура пояснительной записки

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

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

ПЗ дипломного проекта имеет следующий структурный состав, который должен соблюдаться при ее брошюровке - переплете:

а) титульный лист;

б) задание на дипломный проект;

в) реферат;

г) содержание;

д) введение;

е) разделы основной (технической) части дипломного проекта;

ж) экономический раздел;

з) раздел по безопасности жизнедеятельности;

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

и) перечень принятых терминов;

к) перечень принятых сокращений;

л) список использованных источников;

м) приложения.

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

Титульный лист – это первый лист ПЗ, который содержит следующую информацию:

- наименование вуза, института (факультета), кафедры;

- наименование темы дипломного проекта;

- буквенно – цифровое обозначение дипломного проекта;

- квалификация, направление и специальность, по которой выпускается студент;

- группа, фамилия и инициалы студента;

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

- год защиты дипломного проекта.

Титульный лист дипломного проекта должен быть подписан всеми официальными лицами.

Бланк задания на дипломное проектирование состоит из двух листов, которые располагаются в ПЗ сразу же после титульного листа, и содержит следующую информацию:

- сведения об авторе дипломного проекта (группа, аббревиатура института (факультета), номер специальности, фамилия, имя и отчество студента);

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

- место преддипломной практики;

- тема дипломного проекта;

- требования к проекту (техническое задание на проект);

- перечень вопросов, подлежащих разработке, расчетов, обоснований и описаний;

- перечень плакатов графической части дипломного проекта с указанием их наименования, количества листов и формата листов;

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

- календарный график по выполнению проекта;

- даты выдачи и принятия к исполнению проекта.

Примеры оформления титульного листа и задания на дипломное проектирования соответственно приведены в приложении А и Б.

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

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

Реферат к дипломному проекту содержит краткое изложение сути дипломного проекта и оформляется в соответствии с требованиями ГОСТ 7.9 – 95, согласно которому имеет следующую структуру:

- сведения о количестве листов ПЗ, рисунков, таблиц, листов формата А2, листов формата А1, источников, приложений;

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

- текст реферата.

Текст реферата располагают по следующему плану:

- объект исследования;

- цель работы;

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

- полученные результаты и их новизна;

- степень внедрения;

- эффективность разработки;

- область применения.

Оптимальный объем реферата – 1200 знаков, но не более 2000 знаков (не более двух страниц формата А4).

Реферат содержит основную надпись для текстовых документов по форме 2, выполненная в соответствии с требованиями ГОСТ 2.104 – 68 (см. рисунок 1).

					Обозначение документа
Изм.	Лист	№ докум.	Подп.	Дата
Разраб.				Наименование разработки. Пояснительная записка	Литер	Лист	Листов
Пров.
				Группа
Н. контр.
Утв.

Рисунок 1 – Основная надпись для текстовых документов (форма 2)

Основная надпись для текстовых документов по форме 2 содержит следующие подписи:

Разраб.	–	автор дипломного проекта
Пров.	–	руководитель дипломного проекта
Н. контр.	–	нормоконтролер кафедры
Утв.	–	преподаватель кафедры, допускающий проект к рецензированию и защите

В поле «Обозначение документа» заносится буквенно – цифровое обозначение дипломного проекта, где индекс «ПЗ» является кодом пояснительной записки.

В поле «Наименование разработки» указывается название темы дипломного проекта и наименование документа. В соответствии с требованиями ГОСТ 2.109 – 73 сокращения слов в данном поле не допускаются.

Если название темы не умещается в отведенной графе, то допускается сокращение наименования разработки до первого существительного в теме дипломного проекта с ссылкой на титульный лист ПЗ. При этом порядок слов в названии темы дипломного проекта изменять не допускается. Например, «Информационная система … (см. титульный лист)»

В поле «Группа» указывается номер группы студента.

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

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

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

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

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

Разделы основной (технической) части дипломного проекта должны логически последовательно отражать этапы разработки и включать:

- анализ предметной области;

- техническое задание;

- проектирование информационной системы;

- разработка базы данных;

- обоснование выбора средств разработки (или обоснование целесообразности использования заданных средств разработки);

- описание программы;

- программу и методику испытаний;

- описание применения.

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

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

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

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

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

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

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

Разделы по описанию программного продукта и требований к нему являются обязательными и представляют собой комплект программной документации на разработанную автоматизированную информационную систему, состав которого определяется ГОСТ 19.101-77, содержащий требования к видам программ и программным продуктам.

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

- техническое задание;

- описание программы;

- программа и методика испытаний;

- описание применения.

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

Раздел «Техническое задание» должен соответствовать требованиям ГОСТ 19.201 – 78 и содержать следующие подразделы:

- основание для разработки, где приводится документ, на основании которого ведется разработка, наименование организации, утвердившая этот документ;

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

- требования к программе;

- требования к программной документации, где приводится состав программной документации и специальные требования к ней;

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

- порядок контроля и приемки, где описываются виды испытаний и общие требования к приемке работы.

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

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

- требования к надежности;

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

- требования к информационной и программной совместимости, где определяются информационные структуры на входе и выходе, методы решения, исходные коды, языки программирования и программные средства, СУБД, используемые программы, операционная среда.

Раздел «Описание программы» содержит описание текста программы, должен соответствовать требованиям ГОСТ 19.402 – 78 и содержать следующие подразделы:

- общие сведения, где приводится обозначение и наименование программы, программное обеспечение, необходимое для функционирования программы, СУБД, языки программирования, на которых она реализована;

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

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

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

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

- входные данные, где дается описание входных данных, показывается их характер, организация, формат и способ кодирования;

- выходные данные, где дается описание выходных данных, показывается их характер и организация.

Раздел «Программа и методика испытаний» содержит описание методов испытаний программного обеспечения, должен соответствовать требованиям ГОСТ 19.301 – 79 и содержать следующие подразделы:

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

- цель испытаний;

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

- требования к программной документации, где приводится состав программной документации, предъявляемой на испытания программного продукта;

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

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

Раздел «Описание применения» содержит описание применения программного продукта, должен соответствовать требованиям ГОСТ 19.502 – 78 и содержать следующие подразделы:

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

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

- описание задачи, где даются определения задачи и описываются методы ее решения;

- входные и выходные данные, где дается описание входных и выходных данных, показывается их характер и организация.

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

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

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

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

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

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

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

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

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

Перечень принятых сокращений является необязательным разделом и включается, если в тексте ПЗ используется система сокращения слов или наименований. В данном разделе приводятся используемые общепринятые и принятые в тексте сокращения слов и наименований с соответствующей полной их расшифровкой. В тексте такие выражения, в том числе и общепринятые, при первом упоминании записывают полностью и тут же приводят в скобках сокращенную запись. В дальнейшем изложении употребляют сокращенную запись без расшифровки. Данный раздел помещают в конце записки перед перечнем терминов. Исключение составляют сокращения, общепринятые в русском языке и установленные ГОСТ 2.316 – 68.

Перечни принятых терминов и сокращений включают в содержание ПЗ. Примеры оформления перечня принятых сокращений и терминов приведены соответственно в приложении Д и Е.

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

Выполнение списка библиографических описаний источников информации и ссылки на них в тексте должно выполняться в соответствии с требованиями ГОСТ 7.32 – 2001.

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

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

Приложения оформляют как продолжение ПЗ на последующих ее листах. В приложении включают официальные документы, математические выводы, данные справочного характера, громоздкие расчёты, рисунки, таблицы, результаты проектирования, текст программы, SQL – запросы, экранные формы, копии графической части дипломного проекта, копию презентации, а также весь текстовый и графический материал, расположенный на листах формата А1, А2, А3 или нестандартного формата.

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

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

Заголовок приложения записывают верхней строкой прописными буквами.

Приложения обозначают заглавными буквами русского алфавита, начиная с буквы А, за исключением букв Ё, З, Й, О, Ч, Ь, Ы, Ъ, записывают после слова "Приложение". Обозначения приложениям присваивают в алфавитной последовательности.

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

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

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

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

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