1) информация для управления (см. 5.1);
2) связь между задачами (см. 5.2);
3) обеспечение качества (см. 5.3);
4) инструкции и справки (см. 5.4);
5) сопровождение программного обеспечения (см. 5.5);
6) исторические справки (см. 5.6).
5.1 Информация для управления
Во время разработки программного обеспечения администрации необходимо оценивать ход работы, возникающие проблемы и вероятности развития процесса. Периодические отчеты, согласно которым проверяют ход работ по графику и представляют планы на следующий период, обеспечивают контрольные механизмы и обзор проекта.
5.2. Связь между задачами
Большинство проектов разработки программного обеспечения разделяется на задачи, зачастую выполняемые различными группами.
В типовом варианте:
специалисты в предметной области начинают проект;
аналитики формулируют требования к системе;
проектировщики разрабатывают системный и программный проекты;
специалисты по изданиям создают пользовательскую документацию в соответствии со стратегией и стандартами по документированию;
специалисты по обеспечению качества и ревизоры оценивают общую полноту и качество функционирования программного обеспечения;
сопровождающие программисты улучшают эксплуатируемое программное обеспечение и разрабатывают его изменения или расширения.
Этим людям необходимы средства общения друг с другом, обеспечивающие информацию, которую можно, при необходимости, воспроизводить, распространять и на которую можно ссылаться.
Большинство методологий разработки программного обеспечения устанавливают официальные документы для связи между задачами. Например, аналитики представляют официальные спецификации требований для проектировщиков, а проектировщики выдают официальные проектные спецификации для программистов.
5.3. Обеспечение качества
Требуется документация разработки и документация продукции для выполнения задач, связанных с обязанностями по обеспечению качества программного обеспечения.
5.4 Инструкции и справки
Документация, требующаяся операторам, пользователям, руководителям и другим заинтересованным лицам для того, чтобы понимать и использовать программную продукцию.
5.5. Сопровождение программного обеспечения
Сопровождающим программистам требуется детальное описание программного обеспечения, такое, чтобы они могли локализовать и корректировать ошибки и модернизировать или изменять программное обеспечение соответствующим образом.
5.6 Исторические справки
Документация, требуемая в качестве исторической справки по проекту. Данная документация может помочь в переносе и переводе программного обеспечения в новое окружение.
6 УСТАНОВЛЕНИЕ СТРАТЕГИИ ДОКУМЕНТИРОВАНИЯ
Стратегии документирования, подготовленные и отслеживаемые главной администрацией, обеспечивают руководства для ответственных лиц, принимающих решения на всех нижних уровнях. Стратегия обеспечивает главное направление, но не дает рекомендаций, что делать или как это делать.
Из-за существенной роли, которую играет документация на всех стадиях жизненного цикла программного обеспечения, должна быть подготовлена официально утвержденная стратегия. Каждый затронутый стратегией должен быть информирован о ней и должен ее понимать. Официальная, описанная, разрекламированная стратегия устанавливает дисциплину, требуемую для эффективного документирования программного обеспечения.
Стратегия должна поддерживать основные элементы эффективного документирования:
1) требования документации охватывают весь жизненный цикл программного обеспечения.
Документация требуется на ранних стадиях проекта и должна быть доступна и сопровождаться на всем протяжении процесса разработки программного обеспечения. После завершения процесса разработки документация необходима для использования, сопровождения, модернизации, преобразования или передачи программного обеспечения;
2) документирование должно быть управляемым.
Управление и контроль требуются для получения и сопровождения документации. Руководители и специалисты по изданиям должны подготовить подробные планы, охватывающие документирование продукции, графиков, обязанностей, ресурсов, обеспечения качества и процедур проверок;
3) документация должна соответствовать ее читательской аудитории.
Читателями могут быть руководители, аналитики, специалисты по экспертным системам, сопровождающие программисты, канцелярский персонал и т. д. В зависимости от выполняемых задач им требуются различные степени детализации и различное представление материала. Специалисты по изданиям должны быть готовы соответствующим образом спроектировать различные типы документации, предназначенные для различных читателей;
