После выполнения шагов “Подготовка” и “Разработка” наступает черёд согласования документации.

Согласование является итерационным (повторяющимся) процессом. И невозможно с точностью спрогнозировать количество итераций. С большой долей вероятности можно сказать, что минимальное их количество равно двум. Потому как лично мне неизвестны примеры согласования сразу первой версии документа. Но не исключаю, что чудеса всё-таки бывают на свете.

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

Шаги подпроцесса Согласование

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

Форматы взаимодействия

Взаимодействие с функциональными экспертами может быть в следующих форматах:

  • классический,
  • групповой.

Классический формат предполагает отправку документа функциональным экспертам, которые определены в плане разработки технической документации (на этапе “Подготовка”). Полученные от экспертов замечания вносятся в реестр.

Групповой формат в какой-то степени схож с семинаром. Все функциональные эксперты собираются в определённом месте (конференц-зале, переговорной комнате и т.д.) и технический писатель (или группа техписателей) демонстрируют разработанный документ. В процессе демонстрации (или сразу после её окончания) ведётся предметное обсуждение. Замечания также записываются и затем вносятся в реестр. Данный формат взаимодействия встречается нечасто. Причина в основном организационная.

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

Словом, классика есть классика.

Процесс отработки замечаний

Но независимо от того какой формат коммуницирования с функциональными экспертами выбран процесс отработки замечаний одинаковый и имеет следующий порядок:

  1. функциональный эксперт после ознакомления с документом оставляет свои замечания, вопросы и/или предложения (например, в виде комментариев режиме редактирования документа, ответным письмом с перечнем вопросов и замечаний и т.д.);

  2. технический писатель, получив замечания от функционального эксперта, вносит все его комментарии в реестр с указанием всех атрибутов замечания (см. шаг “Вычитка” подпроцесса “Разработка”);

  3. технический писатель в процессе отработки отработки замечаний заполняет “свою” часть реестра (пункты 7-10) и оповещает эксперта об этом (направляется исправленная версия документа и реестр или ссылки на них, если указанные документы хранятся на общем корпоративном ресурсе);

  4. функциональный эксперт проверяет устранение замечаний и заполняет “контрольную” часть реестра (пункты 11-13).

Работа ведётся до тех пор, пока не будут учтены все замечаний функциональных экспертов (например, замечания всех авторов в реестре замечаний имеют статусы “Принято”).

Получение согласования

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

При этом “рассылка” может осуществляться как в индивидуальном порядке, так и по группе. Большой разницы между этими способами нет. В групповом варианте важно в тексте сообщения привести информацию о том, за каким из предметных экспертов закреплён тот или иной раздел документа для проверки и согласования.

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

  • чёткая и конкретная тема сообщения, чтобы у получателей сразу было понимание, о чём пойдёт речь (согласование документации);

  • обозначение той части документа, которую необходимо проверить и согласовать (определённые разделы);

  • формат обратной связи (выставление замечаний);

  • явно обозначенная дата, до которой принимается обратная связь с замечаниями и вопросами.

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

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

Результат выполнения шага процесса “Согласование”:

  • отработаны все замечания в реестре;

  • получены согласования всех функциональных экспертов и других заинтересованных лиц (по электронной почте или с помощью других специальных систем, принятых в компании);

  • подготовлена финальная версия разрабатываемого документа;

  • получено утверждение технической документации от функционального заказчика.