4. Оформление дипломного проекта

4.1. Оформление пояснительной записки

4.1.1. Рекомендуемый объем расчетно-пояснительной записки – не менее 60 и не более 100 листов формата A4, включая приложения.

4.1.2. Шрифт – Times New Roman, 12 пт, через полтора интервала. Параметры страницы: левое поле – 30 мм, правое поле – 10 мм, верхнее и нижнее поля – 20 мм. Абзацы – 15–17 мм, одинаковые по всему тексту.

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

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

4.1.5. Наименования разделов «ПЕРЕЧЕНЬ УСЛОВНЫХ ОБОЗНАЧЕНИЙ, СИМВОЛОВ И ТЕРМИНОВ», «СОДЕРЖАНИЕ», «ВВЕДЕНИЕ», «ЗАКЛЮЧЕНИЕ», «СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ» следует располагать по центру строки без точки в конце и печатать прописными буквами, не подчеркивая.

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

4.1.7. Каждый раздел следует начинать с нового листа. Разделы основной части нумеруются арабскими цифрами (например, «1 ОБЗОР ЛИТЕРАТУРЫ») и начинаются с абзацного отступа.

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

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

4.1.10. Расстояние между текстом и следующим за ним заголовком должно составлять 2 свободные строки. Расстояние между заголовками раздела и подраздела – 1 свободная строка. Расстояние между заголовком и следующим за ним текстом – 1 свободная строка.

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

4.1.12. Иллюстрации следует располагать по центру листа и нумеровать арабскими цифрами нумерацией в пределах раздела, например, «Рисунок 1.1 – Диаграмма вариантов использования» (тоже по центру, указывается под рисунком без точки). Расстояние между текстом и иллюстрацией, иллюстрацией и подписью, подписью и текстом – 1 свободная строка). При ссылках на иллюстрации следует писать «…. приводится на рисунке 2.1»

4.1.13. Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения. Например, «Рисунок А.3».

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

4.1.15. Таблицы следует нумеровать арабскими цифрами нумерацией в пределах раздела. Таблицы должны иметь подпись, которая указывается над таблицей и выравнивается по ее левому краю: «Таблица 6.1 – Технико-экономические показатели проекта». После названия таблицы точка не ставится. Расстояние между текстом и подписью, подписью и таблицей, таблицей и текстом – 1 свободная строка.

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

4.1.17. Ширина линии границы – 0,5 пт.

4.1.18. При переносе части таблицы на следующую страницу подпись, которая указывается над таблицей и выравнивается по ее левому краю, имеет следующий вид: «Продолжение таблицы 6.1». Далее – шапка таблицы и ее продолжение.

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

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

1) ;

2) .

либо маркированного:

- ;

- .

4.1.21. Каждый пункт перечисления оформляется отдельным абзацем.

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

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

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

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

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

4.1.27. На все использованные источники должны быть ссылки по тексту в следующем виде: <цитируемый текст> [x], где х – № источника в списке используемых источников.

4.1.28. Каждое приложение должно начинаться с новой страницы и иметь заголовок, напечатанный с прописной буквы симметрично тексту. Над заголовком в правом верхнем углу прописными буквами должно быть напечатано слово «ПРИЛОЖЕНИЕ». Если приложений несколько, их обозначают заглавными буквами русского (белорусского) алфавита, начиная с А, за исключением букв Е, З, Й, О, Ч, Ь, Ы, Ъ, или латинского алфавита за исключением букв I и О. Название приложения записывается строчными буквами, начиная с прописной.

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

4.2. Оформление подраздела «Тестирование программного обеспечения»

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

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

4.2.2.1. Критическое тестирование – это процесс поиска ошибок в программе при стандартной ее работе (при правильной последовательности действий, при верном заполнении полей и т. д.).

4.2.2.2. Углубленное (расширенное) тестирование – это процесс поиска ошибок в программе в нестандартных, непредвиденных ситуациях (например, при некорректно вводимых данных).

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

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

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

Таблица 4.1 – Форма для тестовых случаев

№	Название модуля/экрана	Описание тестового случая	Ожидаемые результаты	Тестовый случай пройден? Да/Нет	Комментарии
1	2	3	4	5	6

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

Таблица 4.2 – Форма для перечня граничных и эквивалентных значений

Название поля	Формат данных	Перечень граничных значений	Перечень эквивалентных значений
1	2	3	4

4.2.2.7. Аппаратные средства, которые будут использованы при тестировании программного обеспечения (как серверной, так и клиентской части) следует привести в таблице вида 4.3. Во второй колонке указывается роль аппаратного средства, например, сервер приложений, web-сервер, сервер базы данных, рабочая станция.

Таблица 4.3 – Форма для перечня аппаратных средств

№	Роль	Аппаратная конфигурация	Программная конфигурация
1	2	3	4

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

Таблица 4.4 – Матрица конфигураций

	IE 6.0	IE 7.0	Mozilla 1.7.12	FireFox 1.0.7	FireFox 1.5.x	Opera 8.5x	Opera 9.0
Windows 2000
Windows XP

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

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

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

Таблица 4.5 – Форма для анализа ошибок

Номер ошибки	Описание ошибки	Гипотеза местонахождения	Гипотеза прошла? Да/Нет
1	2	3	4

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

4.3. Оформление графического материала

4.3.1. К графическому материалу ДП относятся слайды презентации, которые оформляются последним приложением. Этому приложению должна предшествовать опись листов графической части проекта (прил. К), которая является последней страницей расчетно-пояснительной записки. Номер этой страницы указывается в содержании и на титульном листе в качестве объема пояснительной записки.

4.3.2. Количество слайдов должно быть не менее 10 и не более 15. Каждый слайд должен быть распечатан на листе формата А4 с рамкой и штампом. Образец штампа для первого листа приводится в прил. Л (обязательна книжная ориентация), для всех последующих листов – в прил. М. Рамка должна иметь следующие поля: слева – 20 мм, сверху, снизу и справа – 5 мм

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

4.3.4. Слайды презентации должны иметь заголовки одного формата. Рекомендуется использовать шрифт Times New Roman, 30–40 пт.