Стратегии документирования, подготовленные и отслеживаемые главной администрацией, обеспечивают руководства для ответственных лиц, принимающих решения на всех нижних уровнях. Стратегия обеспечивает главное направление, но не дает рекомендаций, что делать или как это делать.
Из-за существенной роли, которую играет документация на всех стадиях жизненного цикла программного обеспечения, должна быть подготовлена официально утвержденная стратегия. Каждый затронутый стратегией должен быть информирован о ней и должен ее понимать. Официальная, описанная, разрекламированная стратегия устанавливает дисциплину, требуемую для эффективного документирования программного обеспечения.
Стратегия должна поддерживать основные элементы эффективного документирования:
1) требования документации охватывают весь жизненный цикл программного обеспечения.
2) документирование должно быть управляемым.
3) документация должна соответствовать ее читательской аудитории.
4) работы по документированию должны быть объединены в общий процесс разработки программного обеспечения.
5) должны быть определены и использованы стандарты по документированию.
6) должны быть определены средства поддержки.
Требования документации охватывают весь жизненный цикл программного обеспечения.
Документация требуется на ранних стадиях проекта и должна быть доступна и сопровождаться на всем протяжении процесса разработки программного обеспечения. После завершения процесса разработки документация необходима для использования, сопровождения, модернизации, преобразования или передачи программного обеспечения;
Документирование должно быть управляемым.
Управление и контроль требуются для получения и сопровождения документации. Руководители и специалисты по изданиям должны подготовить подробные планы, охватывающие документирование продукции, графиков, обязанностей, ресурсов, обеспечения качества и процедур проверок;
3) документация должна соответствовать ее читательской аудитории.
Читателями могут быть руководители, аналитики, специалисты по экспертным системам, сопровождающие программисты, канцелярский персонал и т.д. В зависимости от выполняемых задач им требуются различные степени детализации и различное представление материала. Специалисты по изданиям должны быть готовы соответствующим образом спроектировать различные типы документации, предназначенные для различных читателей;
4) работы по документированию должны быть объединены в общий процесс разработки программного обеспечения.
Процесс разработки должен быть определен;
Должны быть определены и использованы стандарты по документированию.
По возможности, должны быть приняты существующие стандарты. Когда подходящие стандарты отсутствуют, должны быть разработаны требуемые стандарты и руководства;
Должны быть определены средства поддержки.
Должны быть использованы там, где это экономически целесообразно, средства, помогающие разработке и сопровождению программной продукции, включая документацию.
Требования эффективного документирования.
Для эффективного управления документированием программного обеспечения важно осознавать различные функции, выполняемые документацией.
Программную документацию можно рассматривать как имеющую шесть основных функций:
1) информация для управления;
2) связь между задачами;
3) обеспечение качества;
4) инструкции и справки;
5) сопровождение программного обеспечения;
6) исторические справки. (см 39 билет)
Стратегия должна поддерживать основные элементы эффективного документирования:
