Документация как код в промышленных масштабах (Николай Волынкин, SECR-2017) — различия между версиями

Материал из 0x1.tv

;{{SpeakerInfo}}: {{Speaker|Николай Волынкин}}
<blockquote>
Как полтора десятка человек и тысячи страниц перешли на История о том, как мы в Plesk внедряем лучшие практики разработки ПО в разработку документации.

* Какие проблемы были в формеразработке документации и как мы их решаем.
* Что такое разработка документации как кода. Как поменялись (“docs like code”): легковесные языки разметки, контроль версий, непрерывная интеграция и поставка (CI/CD), контролируемая публикация, связь с разработкой и выпуском продукта.
* В чём польза для технических писателей и для бизнеса.
* Как перейти на docs like code, не ломая процессы, какие сложности мы преодолели, как внедрили DevOps и автоматизировали всю рутинуне выкидывая легаси.

Доклад может быть интересен темадресован всем, кто отвечает за разные аспекты процессов документированиязаинтересован в управлении знаниями в компании: техписателям и их руководителям техписателей, менеджерам продуктов и проектов, девопс-инженерамтимлидам и архитекторам, CTO, владельцам и активистам opensource-проектов. Я хочу рассказать как о технической части процессов, так и о человеческой. Техническая  это миграция контента, автоматизация, работа энтузиастам свободного программного обеспечения.

Технологии: reStructuredText, Sphinx, Markdown, Jekyll, Git, CI/CD, GitLab CI, Docker, pandocлокализацией. Человеческая  как не сломать людям привычные способы работы и как помочь им освоить новое.
</blockquote>

{{VideoSection}}
{{vimeoembed|240324927|800|450}}
<!-- {{youtubelink|}} -->

{{SlidesSection}}
* http://nick.volynkin.gitlab.io/docs-like-code.html

<!-- [[File:Документация как код в промышленных масштабах (Николай Волынкин, SECR-2017).pdf|left|page=-|300px]] -->

{{----}}
{{LinksSection}}

Версия 12:55, 15 ноября 2017

Докладчик
Николай Волынкин.jpg
Николай Волынкин

История о том, как мы в Plesk внедряем лучшие практики разработки ПО в разработку документации.

  • Какие проблемы были в разработке документации и как мы их решаем.
  • Что такое разработка документации как кода (“docs like code”): легковесные языки разметки, контроль версий, непрерывная интеграция и поставка (CI/CD), контролируемая публикация, связь с разработкой и выпуском продукта.
  • В чём польза для технических писателей и для бизнеса.
  • Как перейти на docs like code, не ломая процессы и не выкидывая легаси.

Доклад адресован всем, кто заинтересован в управлении знаниями в компании: техписателям и их руководителям, менеджерам продуктов и проектов, тимлидам и архитекторам, CTO, энтузиастам свободного программного обеспечения.

Технологии: reStructuredText, Sphinx, Markdown, Jekyll, Git, CI/CD, GitLab CI, Docker, pandoc.

Видео

Презентация


Примечания и ссылки