Есть только путь до single-source

  • Просто
  • 40 мин

Я из команды технических писателей VK WorkSpace и один из авторов порталов документации:  https://biz.mail.ru/docs/on-premises/.


На докладе расскажу, как мы решили проблему единого источника с помощью связки трех инструментов: MkDocs + Jinja2 + GitLab.

У нас есть 2 проекта, документация к которым совпадает на 90%. Поддержка разницы в 10% занимала у нашей команды половину рабочего времени одного технического писателя. Я покажу, как, с помощью единого источника, мы сократили расходы на поддержку более чем в 2 раза, и расскажу какие задачи мы решали.


  • Покажу как выглядят исходные документы (на Jinja), и как они подключаются в выходные документы(на Markdown).
  • Как исключать и добавлять контент для разных заказчиков.
  • Что делать, если релизы у заказчиков выходят в разное время.
  • Как менять уровни заголовков, если нужна отдельная инструкция и большой документ.

  • Как настроить среду разработки для работы с Jinja.
  • Поделюсь GitLab CI для передачи исходных документов между репозиториями.
Комментарии ({{Comments.length}} )
  • {{comment.AuthorFullName}}
    {{comment.AuthorInfo}}
    {{ comment.DateCreated | date: 'dd.MM.yyyy' }}

Для того чтобы оставить комментарий необходимо

или
Напишите нам, мы онлайн!