Некоторые требования к программной документации для эффективного использования и обслуживания программного продукта:
- Актуальность. 1 Документация не должна вводить в заблуждение и должна быть актуальной. 1
- Чёткая структура. 1 Полезно наличие сквозного предметного указателя. 1
- Логическая связность и простота. 1
- Наличие инструкций о том, что делать в случае возникновения проблем. 1
- Использование стандартов. 4 Для повышения эффективности работы с документами должны применяться стандарты, регламентирующие форму и содержание документов. 4
Также к программной документации относятся, например, точность, полнота и краткость документов, их чёткое и однозначное толкование. 4