1. общие требования к структуре

СОДЕРЖАНИЕ

ВЕДЕНИЕ. 4

1. СТРУКТУРА ПОЯСНИТЕЛЬНОЙ ЗАПИСКИ.. 5

2.ТРЕБОВАНИЯ К СТРУКТУРНЫМ ЭЛЕМЕНТАМ.. 7

2.1. Титульный лист. 7

2.2. Содержание. 7

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

2.4. Введение. 8

2.5. Основная часть. 9

2.6. Заключение. 12

2.7. Список использованных источников. 12

2.8. Приложения. 13

3.ПРАВИЛА ОФОРМЛЕНИЯ.. 14

3.1. Общие требования. 14

3.2. Заголовки. 15

3.3. Нумерация. 16

3.4. Список использованных источников. 17

3.5. Приложения. 18

3.6. Оформление титульного листа. 19

3.7. Оформление содержания. 19

3.8. Оформление иллюстраций. 20

3.9. Оформление блок-схем. 2
1

3.10. Оформление таблиц. 23

3.11. Оформление формул. 25

3.12. Оформление ссылок. 26

ПРИЛОЖЕНИЕ 1. оБРАЗЕЦ ОФОРМЛЕНИЯ ТИТУЛЬНОГО ЛИСТА………………………28

ПРИЛОЖЕНИЕ 2. ОБРАЗЕЦ ОФОРМЛЕНИЯ СОДЕРЖАНИЯ.. 29

введение

Оформление печатных работ научного характера должно соответствовать определенным требованиям как по содержанию, так и по оформлению. В прошедшие годы были разработаны многочисленные стандарты на различные виды документации – Единая система программной документации (ЕСПД), Единая система конструкторской документации (ЕСКД) и др. Имеются стандарты на библиографическое описание документов, стандарты на содержание и оформление научно-исследовательских работ, и многие другие.

Большая часть стандартов, созданных в период существования СССР, уже устарела. И хотя реформа системы стандартизации России действует уже несколько лет, новые стандарты Российской Федерации по интересующей нас тематике не выпущены. Поэтому при оформлении печатных документов ориентируются на существующие стандарты, действие которых никто не отменял.

Защита дипломного проекта предусматривает подготовку пояснительной записки, которая по своей сути является отчетом о научно-исследовательской работе. Поэтому в правилах оформления будем ориентироваться на ГОСТ 7.32-91 (ИСО 5966-82) «ОТЧЕТ О НАУЧНО-ИССЛЕДОВАТЕЛЬСКОЙ РАБОТЕ. Структура и правила оформления», входящего в Систему стандартов по информации, библиотечному и издательскому делу [1].

1.
ОБЩИЕ ТРЕБОВАНИЯ К СТРУКТУРЕ И СОДЕРЖАНИЮ ПОЯСНИТЕЛЬНОЙ ЗАПИСКИ

Структурными элементами пояснительной записки к дипломному проекту являются:

· титульный лист;

· содержание;

· перечень сокращений, условных обозначений и пр.;

· введение;

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

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

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

· приложения.

Жирным шрифтом выделены обязательные элементы.

Наименования всех структурных элементов, кроме титульного листа и основной части, служат заголовками структурных элементов пояснительной записки. Основная часть текстового документа, как правило, разбивается на два, три или более разделов, которым присваиваются порядковые номера, обозначенные арабскими цифрами с точкой (например, «1. ОПИСАНИЕ ПРЕДМЕТНОЙ ОБЛАСТИ»).

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

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

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

1. Очень корявый язык.

2. Большая безграмотность не только в построении фраз, но и в написании отдельных слов.

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

4. Бездумное переписывание готовых текстов, взятых из других источников, например, из Интернета или из работ других студентов, с присущими этим текстам ошибками.

5. Полное игнорирование требований к содержанию пояснительной записки.

6. Полное игнорирование требований к оформлению пояснительной записки.

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

2. ТРЕБОВАНИЯ К СТРУКТУРНЫМ ЭЛЕМЕНТАМ

2.1. Титульный лист

На титульном листе должны быть указаны следующие сведения:

· официальное название учебного заведения;

· название выпускающей кафедры;

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

· вид материала (дипломный проект с указанием присваиваемой квалификации);

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

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

· место и год выполнения проекта (подготовки отчета).

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

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

Пример оформления титульного листа приведен в прил. 1.

2.2. Содержание

Содержание является обязательным и располагается на странице 2. Пример оформления содержания дан в прил. 2. Названия разделов, пунктов и их последовательность должны точно соответствовать их написанию и расположению в тексте ПЗ. Содержание также должно быть напечатано шрифтом
Times New Roman
14 пт
с интервалом между строк Минимум 18 пт.
При автоматическом формировании содержания эти параметры устанавливаются вручную.

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

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

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

2.4. Введение

В этом разделе должна быть лаконично, но очень ясно описана решаемая Вами проблема, затраченные Вами усилия для решения этой проблемы, используемые программные средства, чтобы после прочтения «Введения» становилась очевидной затронутая Вами пробле­матика. Объем раздела «Введение» не более полутора листов печатного текста, оформленного в соответствии с требованиями. В этом разделе должны быть отражены следующие вопросы:

· тема дипломной работы;

· формулировка проблемы (задачи);

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

· для кого предназначена работа и где может использоваться;

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

· перечислить виды проделанной работы, например, в следующем виде:

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

- найдены и рассмотрены существующие аналоги;

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

- исследованы возможные способы реализации;

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

- разработана объектная модель;

- разработана модель данных;

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

- реализованы все функции системы;

- сделан анализ проделанной работы.

· перечислить используемые технические, операционные, программные средства. Пример:

Использовалась операционная система WinXP, СУБД Cache`5.0.9.5202.2, Internet Explorer 6.0, Mozilla Firefox, Stylus Studio 2006, Far Manager 1.70 beta 5 build 1634.

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

2.5. Основная часть

Основная часть пояснительной записки детально раскрывает существо решенной Вами задачи. Основная часть может состоять из следующих разделов:

· Постановка задачи.

· Описание данных.

· Алгоритмы решения задачи.

· Описание базы данных.

· Схема функционирования программного средства.

· Руководство пользователя.

2.5.1. Постановка задачи

В этом разделе должны быть отражены следующие вопросы:

1.
Описание предметной области

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

2.
Постановка задачи

2.1. Суть задачи.

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

2.2. Анализ требований к системе (программному продукту).

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

· Перечислить виды пользователей системы (программного средства).

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

Это можно оформить либо в виде коротких и четких предложений, описывающих функции программного средства, либо в виде диаграмм прецедентов (Use case diagram) языка UML.

3.
Исследовательская часть

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

· предложения (мои) по реализации.

4.
Характеристика выбранных программных сред и средств

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

2.5.2. Описание данных

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

2.5.3. Алгоритмы решения задачи

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

1. Словесный.

2. Графический, в виде блок-схемы.

2.5.4. Описание базы данных

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

При описании структуры базы данных:

1. Описываются все таблицы в виде:

Имя таблицы – описание, т.е. для хранения какой информации предназначена данная таблица. Например:

USERS – таблица хранит информацию о пользователях.

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

Пример описания таблицы базы данных

Рис. 1.

3. Приводится концептуальная схема базы данных (рис.2), которая отображает взаимосвязи между таблицами, например, в стиле СУБД ACCESS.

Пример концептуальной схемы базы данных

Рис.2.

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

2.5.5. Схема функционирования программного средства

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

· из каких функциональных блоков (файлов, модулей, процедур, функций, классов) состоит программа;

· приведено описание каждого блока с его названием и назначением;

· приведена графическая схема взаимосвязи этих программных блоков.

Например:

Index.php – главная страница для управления новостной информацией;

Addnews.php – добавление новой новости;

EditNews.php – изменение информации о новости;

DeleteNews.php – удаление устаревшей новости.

Пример схемы взаимодействия дан на рис.3.

Рис.3.

2.5.6. Руководство пользователя

В этом разделе описывается:

· порядок установки программного средства на компьютер пользователя;

· все действия пользователя при работе с системой (про­граммным средством).

В этом разделе необходимо привести образы экранов (ScreenShots) для лучшего восприятия раздела.

2.6. Заключение

В этом разделе необходимо:

· подвести итоги проделанной работы - что сделано, что не сделано;

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

· отметить точки роста (развития) программы. Например:

o добавить новые функции (режимы работы);

o распространить на новый класс задач;

· сравнить выполненную работу с существующими аналогами.

· перечислить виды проделанной Вами работы, аналогично тому, как это сделано в разделе «Введение».

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

2.7. Список использованных источников

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

2.8. Приложения

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

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

1) материалы, дополняющие пояснительную записку;

2) промежуточные математические доказательства, формулы и счеты;

3) таблицы вспомогательных цифровых данных;

4) протоколы испытаний;

5) описание аппаратуры и приборов, применяемых при проведении экспериментов, измерений и испытаний;

6) тексты программ;

7) иллюстрации вспомогательного характера и др.

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

3. ПРАВИЛА ОФОРМЛЕНИЯ

3.1. Общие требования

Для пояснительной записки используется белая бумага формата А4. Допускается представлять иллюстрации, таблицы и распечатки с ЭВМ на листах формата А3 [3].

Текст пояснительной записки должен быть кратким, ясным, не содержать орфографических и грамматических ошибок, должен быть напечатан на одной стороне листа с левым полем не менее 3 см, правым полем не менее 1 см, верхним полем не менее 1,5 см и нижним полем не менее 2 см.
Расстояние между строками должно быть равно 1.5 интервала. Для задания в Word требуемого межстрочного интервала надо использовать интервал “Минимум
” с указанием величины интервала числом 18 пт.

Высота букв текста должна быть не менее 2.5 мм (включая надписи на графическом поле рисунков и текст в таблицах). Для основного текста должен использоваться шрифт Times New Roman
размера 14 пт.

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

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

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

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

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

В тексте пояснительной записки не допускается:

- применять обороты разговорной речи, техницизмы, профес­сио­нализмы;

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

- применять произвольные словообразования;

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

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

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

- применять математический знак минус (-) перед отрицательными значениями величин (следует писать слово "минус");

- применять без числовых значений математические знаки, например, >
(больше), <
(меньше), = (равно),
(больше или равно), (меньше или равно), (не равно), а также знаки № (номер), % (процент).

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

3.2. Заголовки

Структурным элементам номера не присваиваются, т.е. заголовки «СОДЕРЖАНИЕ», «ВВЕДЕНИЕ» и др. пишутся без нумерации. Заголовки структурных элементов и разделов выполняются жирным шрифтом, прописными буквами, без переносов с выравниванием по центру.

Каждый структурный элемент и раздел следует начинать с новой страницы.

Подразделы имеют нумерацию в пределах раздела (общий номер подраздела состоит из номера раздела и номера подраздела, разделенных точкой, например, 1.1, 1.2 и т. д.), пункты – в пределах подраздела (1.1.1, 1.1.2), подпункты — в пределах пункта(1.1.1.1, 1.1.1.2). Подразделы, пункты и подпункты имеют собственные заголовки. Заголовки подразделов, пунктов и подпунктов следует начинать с абзацного отступа и печатать строчными буквами, не подчеркивая, без точки в конце. Каждый пронумерованный заголовок должен быть указан в содержании. Деление текста на подразделы, пункты и подпункты должно быть логически обоснованным.

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

Шрифт заголовков одного уровня рубрикации должен быть единым по всему тексту. Например, заголовки подразделов можно выполнять жирным шрифтом, пунктов – жирным курсивом, подпунктов – курсивом. Подчеркивание в заголовках и тексте не рекомендуется. Допускается увеличивать размер шрифта заголовков до 16-18 пт.

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

после заголовка структурного элемента или раздела — 1,5 интервала;

перед заголовком подраздела — 1,5 интервала, после — 1 интервал;

перед заголовком пункта — 1 интервал, после — 0,7 интервала;

перед заголовком подпункта — 0,7 интервала, после — 0,5 интервала.

При оформлении работы программой Microsoft Word размер дополнительных пробелов устанавливается в меню Формат | Абзац | Интервал | после ,
как показано на рис.4.