Оформление пояснительной записки. 4.1.1. Расчетно-пояснительная записка оформляется в текстовом редакторе WORD.
4.1.1. Расчетно-пояснительная записка оформляется в текстовом редакторе WORD.
Шрифт – Times New Roman, 14 пт пунктов с межстрочным интервалом, позволяющим разместить 40+3 строки на странице.
Параметры страницы:
· левое поле – 30 мм,
· правое поле – 10 мм,
· верхнее и нижнее поля –20 мм.
Абзацы в тексте начинаются отступом, равным пяти знакам.
4.1.2. Страницы пояснительной записки следует нумеровать арабскими цифрами без точки в правом нижнем углу листа, соблюдая сквозную нумерацию по всему тексту записки, включая список использованной литературы и приложения.
4.1.3. Номера страницнатитульном листе, на задании по дипломному проектированию, ведомости объема, реферате и первой странице оглавления не ставятся, но включаются в общую нумерацию страниц.
4.1.4. Наименования разделов «ПЕРЕЧЕНЬ УСЛОВНЫХ ОБОЗНАЧЕНИЙ, СИМВОЛОВ И ТЕРМИНОВ», «ОГЛАВЛЕНИЕ», «ВВЕДЕНИЕ», «ЗАКЛЮЧЕНИЕ», «СПИСОК ИСПОЛЬЗОВАННОЙ ЛИТЕРАТУРЫ» следует располагать по центру строки без точки в конце и печатать прописными буквами полужирным шрифтом.
4.1.5. Расстояниемежду текстом и следующим за ним заголовком раздела (подраздела) должно составлять одну свободную строку. Расстояние между заголовками раздела и подраздела – 1 свободная строка.
4.1.6. Иллюстрации (чертежи, графики, схемы, диаграммы, фрагменты программных кодов, копии экранов программы, фотоснимки) следует располагать в записке непосредственно после текста, в котором они упоминаются впервые, или на следующей странице. На все иллюстрации должны быть даны ссылки в записке. Все иллюстрации независимо от их вида и содержания принято называть рисунками.
4.1.7. Иллюстрации следует располагать по центру листа и нумеровать арабскими цифрами нумерацией в пределах раздела, например, «Рисунок 1.1 – Диаграмма вариантов использования» (тоже по центру, указывается под рисунком без точки). Расстояние между текстом и иллюстрацией, иллюстрацией и подписью, подписью и текстом – 1 свободная строка. При ссылках на иллюстрации следует писать «…. приводится на рисунке 2.1».
4.1.8. Таблицы следует располагать в записке по центру страницы непосредственно после текста, в котором они упоминаются впервые, или на следующей странице. На все таблицы должны быть ссылки в записке. При ссылках следует писать «… по таблице 6.1».
4.1.9. Таблицы следует нумеровать арабскими цифрами нумерацией в пределах раздела. Таблицы должны иметь заголовок, которая указывается над таблицей и выравнивается по ее левому краю: «Таблица 6.1 – Технико-экономические показатели проекта». После названия таблицы точка не ставится.
Заголовок должен быть кратким и точно отражать содержание таблицы. Строки с заголовком не должны выходить за правую и левую границы таблицы.
Расстояние междутекстом и подписью, таблицей и текстом – 1 свободная строка.
4.1.10. Перечисления следует печатать строчными буквами с абзацного отступа, разделяя их точкой с запятой, оформив их в виде нумерованного списка:
1) ;
2) .
либо маркированного:
- ;
- .
4.1.11. Каждый пункт перечисления оформляется отдельным абзацем.
4.1.12. Формулы и вычисления следует выделять из текста в отдельную строку по центру. Выше и ниже их должно быть оставлено по одной свободной строке.
4.1.13. Формулы набираются в редакторе формул. Для того чтобы в формулах различать символы сходного начертания, принято буквы латинского алфавита печатать курсивом, а русского и греческого – прямым шрифтом. 4.1.24. Каждая формула должна заканчиваться знаком препинания: запятой в случае наличия пояснений к ней, точкой с запятой в случае перечисления формул либо точкой. Вычисления заканчиваются точкой.
4.1.14. Формулы в пояснительной записке следует нумеровать в пределах раздела арабскими цифрами в круглых скобках в крайнем правом положении на строке.
4.1.15. Пояснение значений формул следует приводить под формулой в той же последовательности, в которой они даны в формуле. Каждое новое значение следует давать с новой строки и заканчивать точкой с запятой (кроме последнего значения). Первую строку начинают со слова «где» без двоеточия с абзаца, остальные строки – обычное выравнивание. Например:
, (4.2)
где – время решения задачи на ЭВМ, час;
– периодичность решения задачи в течение года, раз/год ( =5000);
– среднечасовая ставка пользователя программы, руб. (определяется аналогично ставке работника, осуществляющего ручной расчет) ( =5 101).
4.1.16. Список использованной литературы может включать перечень стандартов, монографий, учебников, методических пособий, статей, тезисов докладов и материалов конференций, электронных ресурсов локального и удаленного доступов. Каждый пункт списка выравнивается по ширине окна без абзацного отступа. После номера пункта точка не ставится. Библиографические описания должны быть выполнены в соответствии с правилами, установленными стандартом ГОСТ 7.1.
4.1.17. На все использованные источники должны быть ссылки по тексту в следующем виде: <цитируемый текст> [x], где х – № источника в списке используемых источников.
4.1.18. В приложения расчетно-пояснительной записки рекомендуется выносить информацию, имеющую справочное или второстепенное значение, но необходимую для полного освещения темы дипломного проекта. Каждое приложение должно начинаться с новой страницы. Вверху по центру пишут слово ПРИЛОЖЕНИЕ прописными буквами и его буквенное обозначение. Ниже по центру пишут заголовок строчными буквами, начиная с прописной буквы. Если приложений несколько, их обозначают заглавными буквами русского (белорусского) алфавита, начиная с А, за исключением букв Е, З, Й, О, Ч, Ь, Ы, Ъ, или латинского алфавита за исключением букв I и О.
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 –Тестовые случаи
№ | Название модуля/экрана | Описание тестового случая | Ожидаемые результаты | Тестовый случай пройден? Да/Нет | Комментарии |
4.2.2.6. Для тестовых случаев, предусматривающих работу с данными, необходимо определить граничные и эквивалентные значения и привести их в таблице 4.2 следующего вида:
Таблица 4.2 –Перечень граничных и эквивалентных значений
Название поля | Формат данных | Перечень граничных значений | Перечень эквивалентных значений |
4.2.2.7. Аппаратные средства, которые будут использованы при тестировании программного обеспечения (как серверной, так и клиентской части) следует привести в таблице 4.3. Во второй колонке указывается роль аппаратного средства, например, сервер приложений, web-сервер, сервер базы данных, рабочая станция.
Таблица 4.3 –Перечень аппаратных средств
№ | Роль | Аппаратная конфигурация | Программная конфигурация |
4.2.2.8. Если программное обеспечение будет тестироваться на различных платформах, необходимо составить матрицу конфигураций, отмечая знаками «+» или «-» используемую конфигурацию, приведена в таблице 4.4.
Таблица 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 8 | |||||||
Windows 7 | |||||||
Windows XP |
4.2.2.9. Запуск тестовых случаев может быть проведен как вручную, так и с использованием средств автоматизированного тестирования. Используемые средства должны быть описаны в расчетно-пояснительной записке.
4.2.2.10. Каждый отработанный тестовый случай помечается в пятой колонке таблицы 4.1, как пройденный или не пройденный. В шестой колонке таблицы 4.1 можно привести уточнения, при какой конфигурации программных или аппаратных средств произошла ошибка, либо сделать ссылку на рисунок с копией экрана программы, демонстрирующий ошибку.
4.2.2.11. После запуска всех тестовых случаев следует перейти к анализу полученных результатов. Если в программе были найдены ошибки, их следует привести в таблице 4.5, выработать гипотезу месторасположения каждой ошибки, проверить гипотезу опытным путем и сделать вывод о ее прохождении.
Таблица 4.5 –Анализ ошибок
Номер ошибки | Описание ошибки | Гипотеза местонахождения | Гипотеза прошла? Да/Нет |
4.2.2.12. Описание процесса тестирования программного обеспечения заканчивается выводами о его прохождении с указанием количества найденных и исправленных ошибок.