Документация как код в промышленных масштабах¶
История о том, как мы в Plesk внедряем лучшие практики разработки ПО в разработку документации.
- Какие проблемы были в разработке документации и как мы их решаем.
- Что такое разработка документации как кода (“docs like code”): легковесные языки разметки, контроль версий, непрерывная интеграция и поставка (CI/CD), контролируемая публикация, связь с разработкой и выпуском продукта.
- В чём польза для технических писателей и для бизнеса.
- Как перейти на docs like code, не ломая процессы и не выкидывая документацию, уже написанную в другом формате.
Доклад адресован всем, кто заинтересован в управлении знаниями в компании: техписателям и их руководителям, менеджерам продуктов и проектов, тимлидам и архитекторам, CTO, энтузиастам свободного программного обеспечения.
Технологии: reStructuredText, Sphinx, Markdown, Jekyll, Git, CI/CD, GitLab CI, Docker, pandoc.
Впервые рассказывал на SECR 2017 в Санкт-Петербурге 19 октября 2017. Обновленная версия доклада и практический мастер-класс будут 26 ноября на конференции DocFactor в Новосибирске.
Вот слайды и запись доклада с SECR (30 минут):