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

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

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

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

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

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


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

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

{{----}}
{{LinksSection}}
* [http://2017.secr.ru/program/submitted-presentations/docs-like-code-in-enterprise Страничка доклада на сайте конференции]
<!-- <blockquote>[©]</blockquote> -->

<references/>





<!-- topub -->


{{stats|disqus_comments=0|refresh_time=2018-02-14T16:51:30.876220|vimeo_comments=0|vimeo_plays=81|youtube_plays=0}}

Версия 11:09, 27 февраля 2018

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

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

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

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

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

Видео

on youtube


Презентация


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





Plays:81   Comments:0