Разработка документации — от постановки до деплоя (Екатерина Носкова, SECR-2018) — различия между версиями
Материал из 0x1.tv
StasFomin (обсуждение | вклад) |
StasFomin (обсуждение | вклад) |
||
* [https://2018.secrus.org/program/submitted-presentations/developing-documentation/ Talks page on SECR site] <!-- <blockquote>[©]</blockquote> --> {{vklink|1234}} {{fblink|2180595238860152}} <references/> <!-- topub --> [[Категория:SECR-2018]] [[Категория:Документирование]] {{stats|disqus_comments=0|refresh_time=2018-12-04T18:18:002019-02-22T21:20:49.922147563755|vimeo_plays=4562|youtube_comments=0|youtube_plays=3}}19}} |
Версия 18:20, 22 февраля 2019
- Докладчик
- Екатерина Носкова
В докладе я расскажу, как в компании Xsolla устроен процесс создания и публикации документации для разработчиков, которые хотят интегрировать решения Xsolla. Какие инструменты и подходы мы используем, как создаем и деплоим контент и как его локализуем.
Для решения задач документирования мы используем генератор статических сайтов Hugo (markdown + Go templates + YAML) и Gitlab CI/CD. Статические страницы документации собираются из шаблонов и публикуются в HTML на 6 языках. Каждый шаблон описывает логику сборки страницы в соответствии с типом контента. Для локализации документации используется подход Continuous localization, который реализован через связку Gitlab CI/CD + Serge + Smartcat.
Доклад будет интересен техническим писателям, разработчикам и менеджерам проектов, которым необходимо решать схожие задачи документирования.
Видео
Посмотрели доклад? Понравился? Напишите комментарий! Не согласны? Тем более напишите.
Презентация
Примечания и ссылки
Plays:81 Comments:0