Skip to main content
✱ Подходы, инструменты, стандарты

Применение Doc as Code для документации White-Label: пишем от лица заказчика

Techwriter Days #2
2025-03-28 12:00
Секция D
20 мин
Средне
Доклад был на прошедшей конференции Techwriter Days #2 и сейчас находится в архиве.
Всем привет! На конференции Techwriter Days мы представляем запись доклада, который произвела Софья Новикова. В своем выступлении она рассказала о применении модели Doc as Code для создания документации White-Label от лица заказчика. Софья, технический писатель с опытом работы с 2006 года, поделилась своим уникальным подходом, используемым в компании ООО РБС, которая работает как интегратор в электронной коммерции. В докладе обсуждаются основы модели White-Label, когда небрендированный продукт предоставляется компаниям для последующей продажи под их брендом. В частности, это платёжный шлюз, который инсталлируется на сервере банка и позволяет интернет-магазинам обрабатывать платежи под их брендом. Софья рассказала, с какими сложностями они столкнулись при использовании старого подхода на базе Confluence, и как переход на Doc as Code значительно упростил процесс создания и распространения документации. Она подробно описала, как с помощью Markdown и Git, а также дополнительных инструментов, таких как генератор Slate и шаблонизатор NJAC, удается поддерживать актуальность и точность документации для различных банковских клиентов. Кроме того, в докладе были даны рекомендации по переходу на более современный подход в документировании и описаны взаимодействия с разработчиками и DevOps-командами, что помогает в успешной интеграции и поддержке Doc as Code.
Компания, в которой я сейчас работаю, занимается разработкой White-Label продукта, т.е. под брендом заказчика. Соответственно, мы пишем White-Label документацию. При этом, поскольку наши заказчики однотипные, но с небольшими вариациями — документация также должна быть практически одинаковой, но с учетом особенностей каждого заказчика, включая брендинг, различия в функциональности, разные адреса запросов API и т.д. В своем докладе я расскажу о том, какими средствами мы этого достигаем. В завершение доклада я дам несколько рекомендаций тем, кто столкнулся с подобной ситуацией — написание документации от имени нескольких однотипных заказчиков с некоторыми различиями. Также приведу несколько ссылок на используемые инструменты.

Доступно только после покупки 😊

Другие доклады Techwriter Days #2