Привет техписам и всему ИТ-сообществу. На связи команда «Инферит Клаудмастер», и мы хотим рассказать вам о том, как мы организовали базу знаний о нашем продукте. Для этого мы поговорили с Миленой Балановой, техническим писателем Инферит Клаудмастер, которая в перерывах между «витанием в виртуальных облаках» и написанием документации рада поделиться инсайтами о создании базы знаний:

• как «Инферит Клаудмастер» за год создал работающую пользовательскую документацию, которая покрывает вопросы клиентов и позволяет справляться без полноценного штата технической поддержки,

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

В качестве вводных данных стоит поделиться, что на текущий момент Милена единственный техпис в команде. К счастью, у Милены была свобода выстраивать процесс «с нуля» и одновременно расти самой в сфере техписательства.

Выстраиваем процесс создания базы знаний в рамках релиза

В команде «Инферит Клаудмастер» длительность спринта ― 3 недели. Независимо от того, сколько в вашей команде занимает процесс выпуска релиза, шаги ниже помогают создать качественный материал с подробным описанием функциональности продукта.

Неделя 1

Обновление Руководства пользователя локально.
Работаем с артефактами во время встреч спринта и фиксируем детали в локальной версии Руководства пользователя.

В зависимости от типа встречи, в рамках спринта можно получить следующие данные:

• Планирование спринта ― общее понимание новой функциональности и её бизнес-ценности.

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

• Example mapping ― технические нюансы разработки, ожидаемое поведение системы при прохождении клиентом пользовательского пути, методология расчёта числовых параметров «под капотом».

• Демо/ревью спринта ― возможные доработки функциональности перед выпуском релиза.

Неделя 2

Публикация обновлений на стенд продукта для тестирования и согласования. Пушим локальные обновления — добавляем новые статьи в Руководство пользователя и обновляем существующие — на dev стенде.

На практике в Руководстве пользователя «Инферит Клаудмастер» обновляются следующие компоненты:

• статьи о функциональности разделов продукта и с описанием методологии расчётов числовых данных,

• матрица функциональности продукта,

• таблица ролей продукта, 

• ченджлог (или дайджест релизов),

• публичный роадмап продукта.

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

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

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

Неделя 3

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

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

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

Прививаем клиенту привычку, где ему читать о новостях

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

• ченджлог, отдельный раздел Руководства,

• роадмап со встроенной опцией отправки письма-анонса релиза с карточками "Готово",

• посты в тг-канале продукта, 

• пресс-релизы в различные СМИ.

Этот этап динамический, поскольку наша команда постоянно пробует как новые подходы в донесении информации до конечного потребителя, так и новые инструменты. Такой подход команда «Инферит Клаудмастер» сформировала и опробовала в течение года.

Готовим команду к работе с клиентскими запросами по релизу

Мы утвердили в команде регламент публикации обновлений Руководства пользователя.  

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

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

Чек-лист техписа перед обновлением пользовательской документации

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

• В Руководстве пользователя: 

  • в статьях и ченджлоге описана функциональность всех новых страниц или разделов, 

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

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

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

• В публичном роадмапе:

  • описана функциональность всех обновлений в рамках релиза,

  • указаны ссылки на Руководство пользователя с возможностью подробнее прочесть о новой функциональности,

  • указаны ссылки на новые страницы и разделы продукта с возможностью их просмотра,

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

  • карточки запланированных обновлений добавлены.

• В тг-посте и пресс-релизе:

  • описана функциональность всех обновлений в рамках релиза,

  • указаны ссылки на Руководство пользователя с возможностью подробнее прочесть о новой функциональности,

  • указаны ссылки на новые страницы и разделы продукта с возможностью их просмотра.