Файл: Основы проектирования программ. Этапы создания программного обеспечения.pdf

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

Использование средств отладки IDE позволяет сэкономить время и улучшить качество кода.

3. Работа с готовым продуктом

3.1. Составление документации

После того как программа написана, прошла этап тестирования и отладки, начинается процесс составления документации.

В состав документации к программе входит:

1. Спецификация

Подробное описание создаваемой программы. Спецификация позволяет точно оценить затраты денег и ресурсов на работу, сколько времени займет данная разработка;

1. Ведомость держателей подлинников

Содержит список организаций, хранящих оригиналы документации;

1. Текст программы

Программный код, с комментариями к нему;

1. Описание программы

Сведения о структуре программы. В описании указываются задачи, решаемые программой, используемые для работы ресурсы, входные и выходные данные.

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

1. Программа и методика испытаний

Программа методики испытаний выявляет данные и части программы, которые необходимо проверить во время тестирования программы. Методика испытаний определяет последовательность тестов и способы наблюдений за их результатами.

Обычно проверки осуществляются на степень соответствия техническому заданию, качества документации, безопасность и т.д.

1. Техническое задание

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

Техническое задание имеет следующую структуру:

Введение

• Основание для разработки
• Применения разработки
• Требования к программе
• Требования к документации
• Порядок разработки
• Приложения

Подробные требования к разработке указаны в ГОСТ 19.201-78;

1. Пояснительная записка

Один из самых трудных документов из-за предъявляемых к нему требований. Он должен соответствовать не только требованиям по структуре, но и по стилистике текста.

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

Пояснительная записка состоит из:

• Общие положения
• Описание разработки
• Описание функционирования программного продукта
• Ввод в рабочий процесс

Требования к пояснительной записке описываются в ГОСТ 2.106-96;

1. Эксплуатационные документы
   1. Ведомость эксплуатационных документов

Данный документ содержит список документации на программу и ее составные элементы;

• 1. Формуляр

Ведется на всей продолжительности разработки программы и отражает ее текущее состояние. Описывает основные характеристики программы и сведения о использовании;

• 1. Описание применение

Данный документ содержит информацию о функциях программы и описывает:

• Проблемы, решаемые программой;
• Используемые ресурсы;
• Входные и выходные данный.

Предназначается будущим пользователям программы;

• 1. Руководство системного программиста

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

В документы описываются следующие сведение:

• Описание программы
• Составляющие части
• Конфигурирование
• Руководство по эксплуатации
• Руководство по администрированию

Данные сведения необходимы для обеспечения работоспособности программы;

• 1. Руководство программиста

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

С использованием данного документа, у программиста не должно возникать проблем при создании своих продуктов на основе предоставленной разработки.

Данный документ содержит:

• Описание объектов разработки;
• Способы взаимодействия объектов;
• Список дополнительных средств разработки;
• Технические требования.

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

• 1. Руководство пользователя

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

• 1. Описание языка