Для программы, использующей структурный подход к программированию, в данном разделе приводятся обобщенные алгоритмы, например, алгоритм основной программы (рис. 6) и описывается межпрограммный интерфейс подпрограмм.
Для программы, при разработке которой использовалась объектно-ориентированная технология, обязательно должна описываться иерархия или диаграмма классов (рис. 7). Для каждого класса желательно указать дополнительные поля и методы, соответственно обосновывая их назначение и функции. При необходимости здесь же можно привести алгоритмы некоторых методов.
Всего в записке приводятся два-три из наиболее интересных алгоритмов, включая алгоритм основной программы при структурном подходе.
Примечание. Каждый алгоритм должен быть представлен:
• таблицей и (или) списком используемых в нем глобальных переменных;
• схемой алгоритма, использующей имена переменных, приведенных в таблице или списке; (алгоритм может быть представлена в псевдокодах, если разработчику он более знаком или удобен);
• описанием процесса обработки данных в соответствии с приведенной схемой алгоритма.
Рис. 6. Алгоритм программного продукта (процедурное программирование)
Описание каждого алгоритма должно включать:
• функциональное назначение алгоритма;
• входные и выходные данные (результаты выполнения);
• список формальных параметров и их назначение;
• пример вызова модуля или подпрограммы;
• используемые технические средства;
• ссылку на таблицу переменных алгоритма;
• ссылку на рисунок со схемой алгоритма;
• описание процесса обработки данных в соответствии со схемой;
• если имеется приложение с полным текстом программы, то ссылку на соответствующую страницу приложения.
При описании процесса обработки данных в соответствии со схемой алгоритма необходимо пояснить все циклы, каждую альтернативу ветвления, принятое решение по результатам анализа альтернатив и последующие действия.
Тексты описания алгоритмов должны быть структурными, предложения короткими. Описание алгоритма должно отражать суть процесса обработки.
Для пояснения особенностей реализации классов или специфики событийно обработки можно использовать дополнительные иллюстрации (рис. 8,9)
В завершении раздела реализации описывается декомпозиция разрабатываемой программы на модули и приводится схема взаимодействия модулей (рис. 10).
Рис. 10. Взаимодействие модулей программного продукта в процессе компиляции и компоновки
Кроме того, в этом же разделе желательно указать вариант разработки («восходящая» или «низходящая») и обосновать свой выбор.
6. Подготовка тестовых данных. В этом разделе выбирается стратегия и методы тестирования. В соответствии с выбранной стратегией и методами строятся примеры тестов (обязательно с предполагаемыми результатами тестирования). Данные тестов целесообразно представить в виде таблиц.
7. Заключение. Раздел содержит выводы по разработанному продукту, рекомендации по его использованию и возможные направления дальнейшего усовершенствования .
Примечание. В зависимости от выбранной технологии и особенностей разрабатываемого продукта могут иметь место отклонения от рекомендуемой структуры записки. Разделы записки могут объединяться, опускаться, меняться местами. Возможно добавление новых разделов, если этого требует логика изложения. Все интересные материалы, выходящие за пределы рекомендуемого объема записки выносятся в приложение. Объем приложения не лимитируется.
