ТРЕБОВАНИЯ К ОФОРМЛЕНИЮ ТЕКСТА ПРОГРАММЫ
Требование одно, но важное: если в работе используются чужие “куски” кода (более чем 3-4 строки подряд), компоненты, библиотеки, необходимо прямо в тексте программы (в комментариях) указать, из какого источника данный фрагмент.
ТРЕБОВАНИЯ К ОТЧЕТУ ПО ЛАБОРАТОРНЫМ РАБОТАМ
К ВНИМАТЕЛЬНОМУ ПРОЧТЕНИЮ ОБЯЗАТЕЛЬНО
Отчет должен содержать следующие разделы:
1) Титульный лист с правильным и полным названием ВУЗа, с указанием темы, номера лабораторной работы, варианта, преподавателя и автора.
Задание на разработку программного продукта.
3) Теоретическое введение (Пример в приложении А) – состоит из двух частей:
l Теоретическая: описание методов, технологий и протоколов, используемых в разработанной программе (не более 2-3 страницы).
l Практическая: описание использованных в программе компонентов и их свойств, функций и их аргументов (объем не ограничен). В разделе описываются компоненты, функции среды разработке (или сторонние) — которые вы используете впервые, или которые непосредственно относятся к сути лабораторной работы.
Разработка приложения
Включает:
· Описание классов и функций разработанного приложения, с описанием их назначения и ссылкой на текст программы, реализующий тот или иной объект (Пример — приложение Б, таблица 1).
· Экранные формы разработанной программы, наглядно отображающие все этапы ее работы.
· Диаграмма классов — UML диаграмма разработанных классов (Пример — приложение Б, рисунок 1).
5) Тестирование приложения (Пример в приложении В) и оформление результатов тестирования должно быть выполнено в соответствии с ГОСТ 19.301-79 (обратите внимание на документ «Программа и методика испытаний.html»). Должно содержать следующие подразделы:
l Объект испытаний – описание объекта испытания
l Цель испытания
l Требования к программе
l Средства и порядок испытаний – описание параметров компьютера, операционной системы, сетевого оборудования.
l Методы испытаний – описание методов тестирования. Имеется введу подробное описание используемого вами метода.
l Описание серии тестов (2-3 теста), включая описание цели каждого из тестов, ожидаемого и полученного результата, вывода о совпадении или не совпадении. Если ожидаемый результат можно проверить с помощью стороннего приложения — нужно (обязательно) привести снимок экрана этого приложения. Если ожидаемый результат возможно подсчитать руками — нужно привести расчеты в отчете.
l Выводы по тестированию
В качестве метода тестирования рекомендуется использовать метод функционального тестирования, хотя не исключаются и другие методы.
6) Список использованных источников, включая ссылки на интернет издания, оформленные по ГОСТ 7.1-2003, ГОСТ 7.82-2001, ГОСТ 7.12-93 (обратите внимание на документ «Рекомендации по оформлению списка литературы.html»).
7) Выводы по работе – содержащие сведения о знаниях и умениях, полученных в ходе выполнения работы.
Содержание
9)Приложения, содержащее основные функции программы (написанные вами). Помещать весь текст программы в приложение не нужно (отчеты, в которые включен полный текст программы). Каждая функция должна располагаться в отдельном разделе приложения и должна иметь краткое описание: какие входные параметры она получает, что и как делает. Обратите внимание — как оформлены приложения в этом документе.
Оформление отчета (в том числе и подписей к рисункам!) должно быть также выполнено по соответствующему ГОСТу. Общие требования к структуре и правилам оформления отчета регламентируют ГОСТ 7.32, ГОСТ 19.104 и ГОСТ 7.1.
ПРИЛОЖЕНИЕ А
Пример теоретического введения
Теоретическое введение
Принципы работы протокола TCP/IP
Transmission Control Protocol (TCP) (протокол управления передачей) — один из основных сетевых протоколов Интернет, предназначенный для управления передачей данных в сетях и подсетях TCP/IP.
Дальнейшее описание строго не более 3х страниц…
Используемые функции и компоненты
В работе используются следующие функции интерфейса ОС Windows
WSAStartup
Назначение: Инициализирует работу процесса с WS2_32.dll
Прототип функции: int WSAStartup(__in WORD wVersionRequested, __out LPWSADATA lpWSAData);
Аргументы:
· wVersionRequested (тип WORD) – требуемая версия протокола …
· lpWSAData (тип LPWSADATA) – возвращаемый параметр: указатель на структуру...
Bind
Назначение: Ассоциирует локальный адрес с сокетом
Прототип функции: int bind(__in SOCKET s, __in const struct sockaddr *name, __in int namelen);
Аргументы:
· s (тип SOCKET) - указатель на сокет;
· name (тип указатель на структуру sockaddr) – структура, содержащая параметры для...;
· namelen (тип int) – длина структуры …
ПРИЛОЖЕНИЕ Б
Примеры элементов раздела разработка приложения
Таблица 1 - Пример описания объектов программы
| Наименование класса, функции | Назначение | Текст программы |
| Класс: Sender | Отправка данных | Приложение A, класс Sender |
| Функция: Send | Отправка данных | Приложение А, класс Sender, функция Send |
Рисунок 1 — Пример диаграммы классов
ПРИЛОЖЕНИЕ В
Пример тестирования
Тестирование
Объекты испытаний
Программы
· «Шифрующие таблицы Трисемуса» (применяется для шифрования-дешифрования текста методом Шифрующих таблиц Трисемуса).
· «Криптоанализ» (применяется для криптоанализа зашированного текста).
Цель испытаний
Выявление ошибок и недостатков разработанной программы.
Требования к программе
Программа шифрования должна корректно шифровать и расшифровывать представленный текст. Программа криптоанализа должна за приемлемое время расшифровывать текст без ключа.
Средства испытаний
Операционная система: Windows XP Professional (5.1, Build 2600) Service Pack 3 (2600.xpsp.080413-2111)
Процессор: AMD Athlon(tm) 64 X2 Dual Core Processor 5800+, MMX, 3DNow (2 CPUs), ~3.0GHz
Оперативная память: 2048MB RAM
Методы испытаний
Приложение будет протестировано с помощью метода функционального тестирование,
далее следует описание, что это за метод, какие этапы включает …
Описание серии тестов
Тест 1
Цель: проверить корректность реализации алгоритма шифрования.
Входные данные: Текст “Проверочный текст”
Ожидаемый результат:
В этом разделе производится получение результата сторонними методами.
· Если это возможно – приводится, расчет вручную, с приведением всех формул и таблиц.
· Если имеются сторонние утилиты – пробуем преобразовать входной результат с помощью них.
◦ Если речь идет о шифровании, возможно зашифровать текст с помощью сторонних утилит и привести снимок экрана с полученным результатом.
◦ Если речь идет, скажем, о работоспособности сети можно проверить сетевое соединение с помощью ping и привести снимок экрана
Полученный результат: тут приводится результат работы вашего приложения.
Например, введенный текст – «Шифрующие таблицы Трисемуса» (25 букв, 2 пробела), полученный текст - «афэиыонфзъвькфяеъифщзчыщв» (25 букв, 0 пробелов).
Вывод по тесту: Полученный результат совпадает с ожидаемым / не совпадает с ожидаемым и почему.
Тест 2