Внешнее описание ПП (Requirements document)
Документация по сопровождению программных продуктов
Сопровождение программ
Сопровождение программ — это работы, связанные с обслуживанием программ в процессе их эксплуатации.
Многократное использование разработанной программы для решения различных задач заданного класса требует проведения дополнительных работ, связанных с доработками программы для решения конкретных задач, проведения дополнительных тестовых просчетов и т.п.
Программа, предназначенная для длительной эксплуатации, должна иметь соответствующую документацию и инструкцию по ее использованию.
Документация по сопровождению ПП (system documentation) описывает ПП с точки зрения ее разработки. Эта документация необходима, если ПП предполагает изучение того, как она устроена (сконструирована), и модернизацию его программ. Как уже отмечалось, сопровождение - это продолжающаяся разработка. Поэтому в случае необходимости модернизации ПП к этой работе привлекается специальная команда разработчиков-сопроводителей. Этой команде придется иметь дело с такой же документацией, которая определяла деятельность команды первоначальных (основных) разработчиков ПП, - с той лишь разницей, что эта документация для команды разработчиков-сопроводителей будет, как правило, чужой (она создавалась другой командой). Команда разработчиков-сопроводителей должна будет изучать эту документацию, чтобы понять строение и процесс разработки модернизируемого ПП, и внести в эту документацию необходимые изменения, повторяя в значительной степени технологические процессы, с помощью которых создавалось первоначальное ПП.
Документация по сопровождению ПП можно разбить на две группы:
1) документация, определяющая строение программ и структур данных ПП и технологию их разработки;
2) документацию, помогающую вносить изменения в ПП.
Документация первой группы содержит итоговые документы каждого технологического этапа разработки ПП. Она включает следующие документы:
Описание архитектуры ПП (description of the system architecture), включая внешнюю спецификацию каждой ее программы.
Для каждой программы ПП - описание ее модульной структуры, включая внешнюю спецификацию каждого включенного в нее модуля.
Для каждого модуля - его спецификация и описание его строения (design description).
Тексты модулей на выбранном языке программирования (program source code listings).
Документы установления достоверности ПП (validation documents), описывающие, как устанавливалась достоверность каждой программы ПП и как информация об установлении достоверности связывалась с требованиями к ПП.
Документы установления достоверности ПП включают прежде всего документацию по тестированию (схема тестирования и описание комплекта тестов), но могут включать и результаты других видов проверки ПС, например, доказательства свойств программ.
Документация второй группы содержит
Руководство по сопровождению ПП (system maintenance guide), которое описывает известные проблемы вместе с ПП, описывает, какие части системы являются аппаратно - и программно-зависимыми, и как развитие ПП принято в расчет в его строении (конструкции).
Общая проблема сопровождения ПП - обеспечить, чтобы все его представления шли в ногу (оставались согласованными), когда ПП изменяется. Чтобы этому помочь, связи и зависимости между документами и их частями должны быть зафиксированы в базе данных управления конфигурацией.