Выпуск #8. Процесс разработки технической документации (согласование и публикация)

Опубликовано 11.05.2023

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

Слушайте подкаст на любимых платформах

Поделитесь подкастом с друзьями и коллегами

---

Расшифровка выпуска

00:00 - 01:07 Приветствие

Добро пожаловать в подкаст технического коммуникатора Техкомпод!

Меня зовут Владимир Юсупов. Я - технический коммуникатор и, по совместительству, ведущий данного подкаста.

На календаре 11 мая 2023 года.

Выпуск номер восемь.

Продолжаю небольшую серию выпусков о процессе разработки технической документации.

Напомню, что процесс состоит из следующих этапов:

1. Подготовка,
2. Разработка,
3. Согласование,
4. Публикация.

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

01:08 - 01:49 Этап “Согласование”

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

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

01:50 - 03:10 Форматы взаимодействия

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

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

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

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

Во-первых, не всегда удаётся подобрать удобные для всех заинтересованных лиц дату и время встречи.

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

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

03:11 - 04:09 Процесс отработки замечаний

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

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

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

04:10 - 06:08 Получение согласования

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

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

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

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

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

06:09 - 06:31 Результат этапа “Согласование”

Результат этапа “Согласование” следующий:

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

06:32 - 07:22 Этап “Публикация”

Согласованный и утверждённый документ остаётся только опубликовать. Другими словами, перенести в соответствующую директорию корпоративной сети, загрузить на корпоративный сайт или портал и т.д.

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

Окончательно удостоверившись, что работа выполнена прекрасно, можно публиковать документацию и с чувством выполненного долга смело праздновать завершение очередного “произведения” (пусть и технического).

07:23 - 08:14 Заключение

На этом заканчиваю серию выпусков о процессе разработки документации.

Спасибо, что прослушали этот выпуск от начала до конца. Если у Вас возникли вопросы, замечания или предложения, пишите мне. Заходите на мой сайт techwritex.ru. Там я периодически пишу заметки по техписьму и коммуникациям. И конечно же подписывайтесь на подкаст.

На этом у меня всё. До встречи через две недели!

С Вами был Владимир Юсупов. Подкаст технического коммуникатора Техкомпод.

Пока!