Documentat.io

Wallarm

Продуктовая компания, разрабатывающая решения для защиты вебсайтов и API-шлюзов

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

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

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

Мы полностью взяли на себя ответственность за обновление старой и написание новой документации для всех продуктов компании. Теперь для заказчика команда documentat.io выглядит как полностью внедренная в их рабочий процесс собственная команда технических писателей.

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

Команда documentat.io продолжает обновлять документацию по мере выпуска новых версий продуктов, активно взаимодействуя с командами разработчиков, тестировщиков и техподдержки Валарм. Мы остаемся в курсе всех изменений благодаря участию в еженедельном планировании спринтов и отслеживанию задач в Jira и Confluence заказчика.

Из трех продуктов заказчика задокументирован только один.

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

Англоязычная документация на продукты, нацеленные на клиентов из США, содержит грамматические и орфографические ошибки. Это портит имидж компании и вызывает недоверие клиентов.

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

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

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

Реструктурировать документацию на существующем портале.

Актуализировать инструкции по установке, настройке и использованию программного продукта заказчика.

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

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

Документация актуализирована и регулярно обновляется в соответствии с новыми релизами. За первые 9 месяцев работы закрыто больше половины задач из бэклога «документационного долга», ведется работа по устранению оставшихся проблем.

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

Команда documentat.io самостоятельно пишет все тексты на английском языке с минимальным привлечением корректоров из Америки. Теперь качество англоязычной документации устраивает зарубежных стейкхолдеров.

Наша команда быстро адаптировалась к инструментарию заказчика. Из файлов в формате Markdown сборщик Gitbook генерирует HTML-файлы с документацией с корпоративным оформлением Валарм. Шаги CI/CD исполняются изолированно в docker-контейнере, и полученные HTML-страницы публикуются на портал.

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

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