Документирование разработки программы

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

Отчет должен быть представлен в электронном виде (полностью готовом для печати, если потребуется).

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

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

Структура отчета по лабораторной работе

1. Титульный лист установленного образца

2. Протокол защиты (чистый лист с соответствующим заголовком). Он может быть размещён на обратной стороне титульного листа или на отдельном листе.

Оглавление

4. Задание на лабораторную работу для выполняемого варианта.

5. Структурная схема программы.

6. Сценарий диалога (можно использовать скриншоты).

7. Спецификация функций (в виде таблицы в альбомном формате):

· Название функции и ее назначение.

· Описание вызова функции (полный заголовок).

· Описание входных параметров (имя, тип, назначение).

· Описание выходных параметров (имя, тип, назначение).

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

· Список функций, вызываемых из данной функции.

8. Алгоритмы функций (для сложных случаев обработки).

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

Литература

11. Приложения – исходные тексты программы

Дополнительно предоставляется: электронная версия отчёта + исходный текст программы в виде архива (отчет размещается в кампусе).

Исходные тексты программы для сложных случаев обработки данных должны быть снабжены комментариями.

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