Больше 10 лет опыта работы техническим писателем и переводчиком в нескольких IT-компаниях.
Сейчас пишу документацию для пользователей и разработчиков (API) в Markdown (git) и частично в Confluence, на русском и английском.
-
23.08.2024Применение Doc as Code для документации White-Label: пишем от лица заказчика
Компания, в которой я сейчас работаю, занимается разработкой White-Label продукта, т.е. под брендом заказчика. Соответственно, мы пишем White-Label документацию. При этом, поскольку наши заказчики однотипные, но с небольшими вариациями — документация также должна быть практически одинаковой, но с учетом особенностей каждого заказчика, включая брендинг, различия в функциональности, разные адреса запросов API и т.д. В своем докладе я расскажу о том, какими средствами мы этого достигаем.
В завершение доклада я дам несколько рекомендаций тем, кто столкнулся с подобной ситуацией — написание документации от имени нескольких однотипных заказчиков с некоторыми различиями. Также приведу несколько ссылок на используемые инструменты.
-
Среднe
-
20 мин
-
TechWriter Days / 2
-