1.4. Документирование программ

Каждая стадия проектирования завершается составле­нием соответствующих документов, .поэтому важным элементом проектирования программных приложений является оформление программной документации. Исключение может составлять разра­ботка бесхитростных программ с коротким жизненным циклом и небольшой трудоемкостью.

Программная спецификация (program specification) - точное описание того результата, которого нужно достичь с помощью про­граммы. Это описание должно точно устанавливать, что должна делать программа, не указывая, как она должна это делать.

Для программ, заканчивающих свою работу каким-то результа­том, обычно составляются спецификации ввода-вывода, в которых описывают желаемое отображение множества входных величин во множество выходных величин.

Для циклических программ (в которых нельзя указать точку за­вершения), разрабатывают спецификации, где основное внимание сосредоточивается на отдельных функциях, реализуемых програм­мой в ходе циклических операций.

Существует большое число различных систем обозначений, ис­пользуемых в программных спецификациях — от естественного языка с использованием математических уравнений и таблиц до формализованных описаний, основанных на исчислении предика­тов (Предикат - функция, определяемая па некоторой предметной области пере­менных и принимающая значения в области истинностных значений.) первого порядка.

Разработку программных систем начинают с составления пер­вичных спецификаций. В ходе выполнения проекта первичные спецификации последовательно претерпевают изменения до про­граммных документов стадий и вплоть до документации, которая необходима для эксплуатации и сопровождения программы. Пер­вичные спецификации обычно составляют в терминах решаемой задачи, а не программы. Первичная спецификация описывает:

объекты, участвующие в задаче (что делает программа и что делает человек, работающий с этой программой);

процессы и действия (проектные процедуры и действия чело­века, алгоритмы решения задачи в машине, порядок обработки информации, размер оперативной памяти, требуемый для работы программы);

входные и выходные данные, а также их организацию (напри­мер, сценарий диалога с экранными формами, организация файлов с указанием длин полей записей и предельного количества инфор­мации в файлах);

инструкции пользования будущей программой.

Различают внешнюю программную документацию, которая со­гласуется с заказчиком, и промежуточную внутреннюю документа­цию проекта. При составлении программной документации сначала разрабатываются внешние спецификации, а затем — внутренние.

Внешние спецификации включают спецификации входных и вы­ходных данных, их организацию, реакции на исключительные си­туации, определение, что делает человек (по каким алгоритмам он работает и откуда берет информацию), а что машина. То есть все, что бы увидел пользователь, когда бы он получил готовую про­грамму. Внешние спецификации зависят сильно от жизненного цикла программы.

Еще до разработки структуры и реализации программы к тести­рованию внешних спецификаций следует привлекать потенциаль­ных пользователей. Пользователю можно показывать макеты экра­нов в порядке выполнения программы, а пользователь может гото­вить данные для тестирования всех функций программы и сможет апробировать методику работы с программой.

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