Документирование ПО
Документация на программное обеспечение — это документы,
сопровождающие некоторое программное обеспечение (ПО) — программу
или программный продукт. Эти документы описывают то, как работает
программа и/или то, как её использовать.
Документирование — это процесс создания документации, важная
часть в разработке программного обеспечения, ей часто уделяется недостаточно внимания.
Типы документации
Существует четыре основных типа документации на ПО:
- архитектурная/проектная — обзор программного обеспечения,
включающий описание;
- рабочей среды и принципов, которые должны быть использованы при создании ПО;
- техническая — документация на код, алгоритмы, интерфейсы, API;
- пользовательская — руководства для конечных пользователей,
администраторов системы и другого персонала.
|
