Описание программы (ГОСТ 19.402-2000)
– общие сведения:
Ø обозначение и наименование программы;
Ø автор, дата создания, версия программы;
Ø программная среда и программное обеспечение, необходимые для функционирования программы, а также рекомендации по выбору версий и модификаций;
Ø языки программирования, на которых написана программа;
Ø новые возможности и отличие от предыдущих версий и модификаций.
– структура программы (выполняется на основании исходного текста программы):
Ø алгоритм программы (схема алгоритма программы);
Ø используемые методы и типовые проектные решения;
Ø структура программы с описанием функций составных частей, их проблемной и машинной ориентации и связей между ними (при необходимости нарисовать структуру программы);
Ø связи программы с другими программами;
Ø используемые стандартные протоколы связи;
– входные и выходные данные:
Ø характер и организацию входных и выходных данных;
Ø описание предварительной подготовки входных данных;
Ø формат, описание и способ кодирования входных и выходных данных;
Ø возможности управления форматом и полнотой получаемых выходных данных.
– вызов и загрузка:
Ø способ вызова программы с соответствующего носителя данных;
Ø входные точки в программу.
Допускается указывать адреса загрузки, сведения об использовании оперативной и внешней памяти, объем программы
Описание применения (ГОСТ 19.502-78):
В данном разделе указываются сведения об организации рабочего места, где будет эксплуатироваться разработанная программа: требования к помещению, требования техники безопасности и т.д. Также здесь указываются основные моменты энерго- и ресурсосбережения, которые следует учитывать при организации рабочего места, где будет эксплуатироваться разрабатываемая программа.
Руководство программиста (ГОСТ 19.503-79, ГОСТ 19.504-79):
– характеристики программы: описание основных характеристик и особенностей программы (временные характеристики, режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т.п.);
– обращение к программе: описание процедур вызова программы (способы передачи управления и параметров данных и др.);
– настройка программы: описание действий по настройке программы на условия конкретного применения (настройка на состав технических средств, выбор функций и др.). При необходимости приводят поясняющие примеры;
– дополнительные возможности: описание дополнительных разделов функциональных возможностей программы и способов их выбора
– сообщения программисту: тексты сообщений, выдаваемых в ходе выполнения настройки, проверки программы, а также в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
Руководство пользователя (ГОСТ 19.505-79 Руководство оператора):
– условия выполнения программы: условия, необходимые для выполнения программы (требования к необходимым для данной программы техническим средствам, и другим программам, общие характеристики входной и выходной информации, а также требования и условия организационного, технического и технологического характера и т.п.)
– выполнение программы: последовательность действий оператора, обеспечивающих загрузку, запуск, выполнение и завершение программы, приведено описание функций, формата и возможных вариантов команд, с помощью которых пользователь осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды;
– сообщения оператору: тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора (действия оператора в случае сбоя, возможности повторного запуска программы и т.п.);
Программа и методика испытаний (ГОСТ 19.301-2000):
– объект испытаний: наименование, область применения, обозначение программы;
– цель испытаний;
– средства и порядок испытаний:
Ø описание программно-аппаратурной среды функционирования разработанной программы;
Ø процедуры проверки соответствия программно-аппаратной среды функционирования предъявленным требованиям и порядок их выполнения;
Ø порядок выполнения процедур проверки корректности выполняемых действий.
– методы испытаний: описание используемых методов испытаний, в частности, описания тестов и способов проверок с указанием ожидаемых результатов испытаний (перечней тестовых примеров, контрольных распечаток тестовых примеров и т.п.).
Заключение (п. 5.10, п. 6.1 и п. 6.3 ГОСТ 7.32-2001
Отчет о научно-исследовательской работе)
Заключение должно содержать:
– краткие выводы по результатам выполнения дипломного проекта;
– оценку полноты решений поставленных задач;
– разработку рекомендаций и исходных данных по конкретному использованию разработанной программы;
– оценку технико-экономической эффективности внедрения;
– оценку научно-технического уровня выполненного дипломного проекта в сравнении с лучшими достижениями в данной области.