Документирование

программного обеспечения

Важную роль  в создании надежного ПО играют методы и средства документирования разработки.

​

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

​

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

  ПО должна удовлетворять ряду основных требований:    

1. Соответствие запросам разных категорий технического персонала, связанного с проектированием и эксплуатацией разработанного ПО.

2. Возможность использования на разных этапах  проектирования и эксплуатации проекта ПО.

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

​

Документация создается на этапах проектирования, и включает в себя 10 самостоятельных документов:

1.  Документ функциональных требований. Цель - обеспечить базу для взаимопонимания заказчика и исполнителя.

2.  Документ информационных требований. Цель  - обеспечить на стадии развития ПО описание окружающей среды для работы ПО.

3.  Документ “Спецификация системы”. Цель - определить для аналитиков и программистов требования, операционные условия, проектируемые характеристики составленных программ.

4.  Документ программных спецификаций. Цель - определить требования к программистам.

5.  Документ спецификации базы данных. Цель - определить идентификацию, логические и физические характеристики БД.

6.  Документ Руководство пользователя. Цель - создать справочный документ для пользователя по подготовке и вводу данных.

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

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

9.  Документ Тестовый план.  Цель - описание плана и процедур выполнения тестирования, сроки и даты тестирования, описание тестов.

10.  Отчёт о тестовом анализе. Назначение - обобщить результаты тестового анализа, выявить возможности и недостатки тестируемого программного изделия.

​