Talks & master-classes|Доклады и мастер-классы

Developing documentation: from problem statement to deployment|Разработка документации: от постановки до деплоя

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

Discuss the presentation|Обсудить доклад

[lang_en]

In this report I will talk about the process of creating, localization and publishing documentation at developers.xsolla.com. This resource is intended to developers who want to integrate Xsolla solutions. I will also talk about tools and ways which we use to create, localize and deploy the content.

[/lang_en][lang_ru]

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

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

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

[/lang_ru]

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

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

Head of Technical Documentation Department|Руководитель отдела документирования, Xsolla

[lang_ru]

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

[/lang_ru]

Sponsors & Partners|Спонсоры и партнёры

Sponsors|Спонсоры

Gold

JetBrainsFirst Line Software

Sponsors

BellSoftPVS-Studio

Embedded|Embedded

Auriga|Аурига

Partners|Партнёры

Gold|Золотой

Digital October

Main partners|Генеральные партнёры

RUSSOFT|РУССОФТAP KIT|АП КИТ

In cooperation|При содействии

ACM Special Interest Group on Software EngineeringAssociation for Computing Machinery

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

CUSTIS0x1.tvMajordomo

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

Software Russiai-Help