Требования к объему и детализации описания программного обеспечения зависят от задач и характера дипломной работы, от объема разрабатываемых программ. Программное обеспечение должно быть описано в соответствии с основными требованиями ГОСТов, составляющих Единую систему программной документации (ЕСПД). В реальной практике в ТЗ (техническое задание) включается раздел «Требования к программной документации», в котором определяется состав документов, передаваемых Заказчику вместе с программным обеспечением: например, «Руководство системного программиста», «Руководство оператора», «Программа и методика испытаний» и т.д. В документах имеются повторяющиеся разделы (например, «Назначение программы»), поэтому в дипломной работе нецелесообразно педантично воспроизводить форму этих документов. Достаточно продемонстрировать умение описывать программное обеспечение так, что из пунктов описания легко потом скомпоновать документы, определенные ТЗ. При наиболее полном описании разработанного программного обеспечения рекомендуем раскрыть в дипломной работе следующие пункты (они выбраны из ЕСПД).
1) Общие сведения о программе (программном комплексе — далее это уточнение будет опускаться).
Здесь указываются:
- обозначение и наименование программы;
- программное обеспечение, необходимое для функционирования программы;
- языки программирования, на которых написана программа;
- основные характеристики: объем и время работы программы.
Остановимся подробнее на последнем пункте. Объем программы измеряется дважды: во-первых, определяется объем исходных текстов программ, во-вторых, объем исполняемых модулей. Полезно также указывать объемы, полученные в результате архивации файлов каким-либо популярным архиватором, например ARJ.
Указываются классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях на ее применение.
3) Структура программы. Программное обеспечение обычно создается коллективом разработчиков (бригадой программистов), дипломник разрабатывает часть модулей. Следует в общих чертах описывать всю систему и подробно — модули, разработанные автором.
Структуру взаимодействия модулей предпочтительно изображать в виде графа подчиненности модулей, чтобы наглядно показать иерархическую структуру комплекса. Служебные подпрограммы, используемые практически всеми модулями комплекса, целесообразно показывать отдельно, чтобы не загромождать схему большим количеством связей.
Для каждого модуля приводится его название и описывается назначение.
4) Используемые технические средства. Здесь перечисляется минимальный состав технических средств, обеспечивающий работу программы: тип процессора, объем оперативной памяти, наличие жесткого диска, требуемый объем дискового пространства, тип дисплейного адаптера, наличие принтера и его тип, какое-либо специализированное оборудование (плоттер, мышь и т.д.)
5) Требования к программному окружению. Операционная система и ее минимально допустимая версия, наличие в оперативной памяти специализированных драйверов (например, для использования мыши, для кодировки кириллицы), используемые стандартные библиотеки (например, библиотеки для научно-технических расчетов, библиотеки графических примитивов, библиотеки классов и т.д.)
6) Настройка программы (процедура инсталляции). Какие действия должен предпринять программист при установке программы на жесткий диск (например, если программа должна выполняться на IBM PC в операционной системе MS DOS, то возможно окажется необходимым добавить маршрут в файл autoexec.bat, задать нужные параметры в config.sys, создать рабочие каталоги и т.д.). Желательно описать командный файл, автоматизирующий процедуру инсталляции, сводящий ее к диалогу с программистом.
7) Эксплуатация программы.
7.1) Описание входных данных.
Входная информация разделяется на переменную и постоянную. Например, программы, эксплуатируемые на производственном участке, читают нормативно-справочную информацию из файлов, содержимое которых обновляется достаточно редко. В то же время оперативный план может меняться ежедневно.
Для входной информации указывается тип кодирования, формат (например, постоянная информация может выбираться из обычных текстовых файлов в формате ASCII, либо из файлов в формате некоторой базы данных). Следует также указывать технические средства ввода данных: клавиатура, мышь, сканер и т.д.
7.2) Описание выходных данных.
Здесь указываются характер и организация выходных данных; формат, описание и способ кодирования. Описывается информация, поступающая на выходные устройства: экран терминала, принтер, плоттер. Описываются файлы с выходной информацией.
Сообщения об ошибках в выходную информацию не включаются.
7.3) Выполнение программы.
Описывается последовательность действий пользователя (оператора), обеспечивающая загрузку, запуск, выполнение и завершение программы, приведено описание функций, формата и возможных вариантов команд, с помощью которых пользователь осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды.
Здесь рекомендуется выделить подраздел «Сообщения пользователю», в котором привести тексты сообщений, выдаваемых в ходе выполнения программы, описания их содержания и соответствующие действия пользователя (в случае сбоя, возможности повторного запуска программы и т.п.)
Рекомендуется использовать поясняющие примеры, таблицы, схемы, графики.
Текст программы.
Текст программы приводится на исходном языке и снабжается подробными комментариями. В оформлении текста программы применяются элементы структурного программирования для улучшения восприятия (отступы внутри тела циклов и условных блоков, «содержательные» имена идентификаторов и т.п.)
9) Методика испытаний.
Здесь описываются требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля. Приводится перечень тестовых примеров и соответствующих контрольных распечаток.
Список использованной литературы
Библиографическое описание включает следующие обязательные элементы: автор(ы), основное заглавие, место и дата издания, объем. Общая схема библиографической записи выглядит так:
Заголовок (Фамилия И.О. индивидуальных авторов; наименование коллективного автора). Основное заглавие: Сведения, относящиеся к заглавию (раскрывают тематику, вид, жанр, назначение документа и т.д.) /Сведения об ответственности (содержит информацию о составителях, редакторах, переводчиках и т.п., об организациях, от имени которых опубликован документ). — Сведения об издании (содержат сведения о повторности издания, его переработке и т.п.). — Место издания: Издательство или издающая организация, дата издания. — Объем (сведения о количестве страниц, листов).
Если используется составная часть издания (например, статья в журнале или сборнике), то составляется аналитическое описание в следующем виде:
Сведения о составной части // Сведения о документе, в котором помещена составная часть.
Первая часть библиографического аналитического описания содержит сведения об авторах, заглавии, сведения, относящиеся к заглавию. Во второй части (после //) приводится краткое библиографическое описание документа, в котором опубликована составная часть (автор, если он не совпадает с автором составной части, заглавие, сведения, относящиеся к заглавию; сведения об ответственности, которые приводятся в основном для сборников научных трудов; сведения об издании, месте и годе издания), а также указываются страницы, на которых помещена данная статья или раздел. В случае с сериальными изданиями или многотомниками дополнительно указывается номер тома или выпуска.
Тестирование Программного Обеспечения в США — Описание ошибок — урок 3.
