Документирование программного обеспечения
ой же документацией,
которая определяла деятельность команды первоначальных (основных)
разработчиков программного средства, - с той лишь разницей, что эта
документация для команды разработчиков-сопроводителей будет, как правило,
чужой (она создавалась другой командой). Команда разработчиков-
сопроводителей должна будет изучать эту документацию, чтобы понять строение
и процесс разработки модернизируемого программного средства, и внести в эту
документацию необходимые изменения, повторяя в значительной степени
технологические процессы, с помощью которых создавалось первоначальное
программное средство.
Документация по сопровождению программного средства можно разбить на две
группы:
1. документация, определяющая строение программ и структур данных ПС и
технологию их разработки;
2. документацию, помогающую вносить изменения в программное средство.
Документация первой группы содержит итоговые документы каждого
технологического этапа разработки программного средства. Она включает
следующие документы:
Внешнее описание программного средства (Requirements document).
Описание архитектуры программного средства (description of the system
architecture), включая внешнюю спецификацию каждой ее программы.
Для каждой программы программного средства - описание ее модульной
структуры, включая внешнюю спецификацию каждого включенного в нее модуля.
Для каждого модуля - его спецификация и описание его строения (design
description).
Тексты модулей на выбранном языке программирования (program source code
listings).
Документы установления достоверности программного средства (validation
documents), описывающие, как устанавливалась достоверность каждой программы
программного средства и как информация об установлении достоверности
связывалась с требованиями к программному средству.
Документы установления достоверности включают прежде всего документацию по
тестированию (схема тестирования и описание комплекта тестов), но могут
включать и результаты других видов проверки программного средства,
например, доказательства свойств программ.
Документация второй группы содержит
Руководство по сопровождению программного средства (system maintenance
guide), которое описывает известные проблемы вместе с программным
средством, описывает, какие части системы являются аппаратно- и программно-
зависимыми, и как развитие программного средства принято в расчет в его
строении (конструкции).
Общая проблема сопровождения программного средства - обеспечить, чтобы все
его представления шли в ногу (оставались согласованными), когда программное
средство изменяется. Чтобы этому помочь, связи и зависимости между
документами и их частями должны быть зафиксированы в базе данных управления
конфигурацией.
|Вид эксплуатационного|Содержание эксплуатационного документа |
|документа | |
|Ведомость |Перечень эксплуатационных документов на |
|эксплуатационных |программу. |
|документов | |
|Формуляр |Основные характеристики программы, |
| |комплектность и сведения об эксплуатации |
| |программы. |
|Описание применения |Сведения о назначении программы, области |
| |применения, классе решаемых задач, применяемых|
| |методах, ограничениях для применения, |
| |минимальной конфигурации технических средств. |
|Руководство |Сведения для проверки, обеспечения |
|системного |функционирования и настройки программы на |
|программиста |условия конкретного применения. |
|Руководство |Сведения для эксплуатации программы. |
|программиста | |
|Руководство оператора|Сведения, необходимые для осуществления |
| |действий, связанных с выполнением программы |
| |вычислительной системой. |
|Описание языка |Описание синтаксиса и семантики языка. |
|Руководство по |Сведения для применения текстовых и |
|техническому |диагностических программ при обслуживание |
|обслуживанию |технических средств. |
1. http://www.ergeal.ru/archive/cs/tp/ - Технология программирования,
конспект лекций ВМиК МГУ, кафедра системного программирования
2.http://www.aanet.ru/~web_k46/textbooks/std_pro/face.htm - Богданов Д.В.,
Путилов В.А., Фильчаков В.В. Стандартизация процессов обеспечения качества
программного обеспечения. - Апатиты, КФ ПетрГУ, 1997.
| |  скачать работу |
Документирование программного обеспечения |
