Одним из первых важнейших требований является документирование всех этапов процесса разработки программного обеспечения, начиная с постановки первоначальных требований и заканчивая вводом в эксплуатацию и дальнейшим сопровождением. Документы, возникающие в процессе разработки, такие, как спецификации, планы разработки, руководство пользователя, являются неотъемлемой частью программного продукта. Заказчик вместе с программным продуктом должен по возможности получать всю документацию, связанную с разработкой продукта. Документирование процесса разработки ведется с целью облегчения процесса сопровождения, доработки и контроля качества продукта. В случае смены разработчика проектная документация должна обеспечить дальнейшую эффективную работу с программным продуктом.
Качество документации должно отвечать следующим критериям:
- правильность:
соответствие (трассируемость) требований и спецификаций соответствующей системе, и наоборот;
последовательность в описании требований, спецификаций и функций;
- полнота:
использование версий и дат документов для контроля изменений, доступность всех версий документов (в том числе рабочих);
функциональность системы должна быть максимально полно описана в системных требованиях;
документация должна предоставлять информацию для всех категорий пользователей, операторов системы и разработчиков;
- удобство и простота использования:
использование оглавлений, алфавитных указателей, глоссариев и кросс-ссылок;
логическая последовательность и непротиворечивость в использовании терминологии;
уместный внешний вид документации (шрифты, формат).
В то же время необходимо, как уже отмечалось, избегать излишней бюрократизации, другими словами - в зависимости от цели проекта набор, состав и объем документов должен меняться.
Принципы управления документированием программного обеспечения одинаковы для любого объема проекта. Для небольших проектов значительную часть положений, приведенных в данном стандарте, можно не применять, но принципы остаются теми же. Руководители могут адаптировать данные рекомендации для своих конкретных потребностей.
