Управление документированием в проекте

1. Ситуация и предмет заказа

Разработка технической документации на автоматизированную систему или программу по заказу. Стороны и взаимоотношения между ними: заказчик, исполнитель, соисполнители и субподрядчики.

Виды технической документации: проектно-сметная, рабочая, эксплуатационная, организационно-распорядительная. Комплект технической документации, документ, текст. Три традиционных взгляда на техническую документацию и инженерный подход к документированию.

Некоторые существенные отличия технической документации от программ.

Взаимосвязь процесса документирования с другими процессами (стадиями) жизненного цикла автоматизированной системы или программы в трактовках разных стандартов и методологий.

Зачем нам знать что-то кроме стандартов?

2. Разработка руководства пользователя: простейший жизненный цикл

На простом примере демонстрируется минимальный полный жизненный цикл комплекта технической документации. Для каждой стадии жизненного цикла указываются основные задачи, работы, артефакты.

3. Требования к технической документации

Функция требований: кому и зачем они нужны.

Требования к требованиям: конструктивность, различимость, тестируемость, реалистичность, непротиворечивость, адекватность. Арбитраж, который всегда с тобой: критерий работоспособности требований. Требования-цели и требования-ценности. Требования-условия и требования-предписания.

Типы требований: функционально-коммуникативные, к составу комплекта, к структурам документов, к подробности и полноте изложения, к терминологии, к языку и стилю, к оформлению, к возможностям сопровождения, форматам конечных документов, к комплектности и способу поставки, прочие.

Стандарты и их функции при формировании требований.

Процедура формирования требований. Выбор стратегии формирования требований: треугольник ресурсов. Участники процедуры формирования требований и их функции. Последовательность действий при формировании требований. Результат: план документирования.

4. Управление работами по документированию

Участники разработки технической документации, их функции, компетенции, и полномочия. Основные участники работ: руководитель проекта, технический эксперт, разработчик технической документации, ответственный приемщик. Исполнители специальных и технических работ: переводчик, лит. редактор, корректор, верстальщик и др. Заинтересованные лица и группы влияния: пользователи, внутренние службы заказчика, 'начальство'.

Планирование работ по созданию комплекта технической документации. Нулевой цикл: формирование требований к комплекту. Адаптация абстрактного жизненного цикла в соответствии с требованиями к конкретному комплекту. Формирование списка необходимых работ и определение последовательности их выполнения. Оценка объемов и трудоемкости работ, нормы выработки для различных видов работ. Составление календарного плана с учетом стадий жизненного цикла разрабатываемого комплекта и состава необходимых работ.

Контроль. Цели и задачи контроля. Виды контроля: текущий контроль и контроль по результатам этапов. Методы контроля. Типичные риски, индикаторы и предвестники их реализации.

Сдача-приемка технической документации. Главный принцип: ко дню сдачи работы все требования фактически должны быть признаны выполненными. Стратегия 'показал-утвердил'. Стратегия этапов и доработок и ее обратная сторона - 'эффект швабры'. Сдача по закрытому списку.

Особенности привлечения субподрядчика к документированию. Выбор субподрядчика. Что приобретается: специалист, комплект или процесс? Что может произойти, если выдавать сотрудников субподрядчика за собственных сотрудников.

5. Управление качеством технической документации

Связь требований к технической документации с ее качеством. Привязка показателей качества к стадиям жизненного цикла комплекта. Эффект 'строительного мусора'. Методы контроля качества по различным показателям.

Рецензирование документов. Работа с замечаниями от нескольких рецензентов. Управление внесением правок при большом количестве итераций. Отчеты 'было-стало'. Рецензирование документов и внесение правок при наличии у документов общих разделов или единого источника. Тестирование как альтернатива рецензированию.

Почему необходимое качество достигается не всегда, как это предотвратить, и как исправить положение, если это случилось. Ошибочные способы повышения качества.

6. Типичные конфликты. Причины, профилактика, разрешение

Рассматриваются конфликты, возникающие между исполнителями и заказчиками особенно часто. Рассматриваются их причины, способы предотвращения и решения.

'Ваша документация никуда не годится'.

'Вы сорвали жесткий срок, и поэтому:'.

• Случай 1: ': вот вам новый, еще более жесткий'.
• Случай 2: ':давайте хотя бы работу выполним нормально'.

'Было не срочно, вдруг стало срочно'.

'Тут вашу документацию Иван Иваныч посмотрел:'.

• Случай 1: один большой специалист, который как раз случайно проходил мимо.
• Случай 2: стейкхолдер в засаде.
• Случай 3: неполное делегирование полномочий.

'Каждый день что-нибудь новенькое'

Неконструктивные упреки

• 'Мы за вас эту документацию сами написали!'
• 'За это время мы эту документацию написали бы своими силами'