Доклады и мастер-классы

Разработка документации: от постановки до деплоя

13 октября, 10:50
IV зал

Обсудить доклад

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

Для решения задач документирования мы используем генератор статических сайтов Hugo (markdown + Go templates + YAML) и Gitlab CI/CD. Статические страницы документации собираются из шаблонов и публикуются в HTML на 6 языках. Каждый шаблон описывает логику сборки страницы в соответствии с типом контента. Для локализации документации используется подход Continuous localization, который реализован через связку Gitlab CI/CD + Serge + Smartcat.

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

Екатерина Носкова

Екатерина Носкова. Разработка документации: от постановки до деплоя

Руководитель отдела документирования, Xsolla

Больше пяти лет занимаюсь разработкой технической документации. Практикую Docs as code и Scrum/Agile.

Спонсоры и партнёры

Спонсоры

Gold

JetBrainsFirst Line Software

Sponsors

BellSoftPVS-Studio

Embedded

Аурига

Партнёры

Золотой

Digital October

Генеральные партнёры

РУССОФТАП КИТ

При содействии

ACM Special Interest Group on Software EngineeringAssociation for Computing Machinery

Технические партнёры

CUSTIS0x1.tvMajordomo

Организаторы

Software Russiai-Help