Документация как код в промышленных масштабах (Николай Волынкин, SECR-2017) — различия между версиями
Материал из 0x1.tv
StasFomin (обсуждение | вклад) |
StasFomin (обсуждение | вклад) |
||
* 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 -->
[[Категория:SECR-2017]]
[[Категория:Draft]] |
Версия 15:54, 21 ноября 2017
- Докладчик
- Николай Волынкин
История о том, как мы в Plesk внедряем лучшие практики разработки ПО в разработку документации.
- Какие проблемы были в разработке документации и как мы их решаем.
- Что такое разработка документации как кода (“docs like code”): легковесные языки разметки, контроль версий, непрерывная интеграция и поставка (CI/CD), контролируемая публикация, связь с разработкой и выпуском продукта.
- В чём польза для технических писателей и для бизнеса.
- Как перейти на docs like code, не ломая процессы и не выкидывая легаси.
Доклад адресован всем, кто заинтересован в управлении знаниями в компании: техписателям и их руководителям, менеджерам продуктов и проектов, тимлидам и архитекторам, CTO, энтузиастам свободного программного обеспечения.
Технологии: reStructuredText, Sphinx, Markdown, Jekyll, Git, CI/CD, GitLab CI, Docker, pandoc.
Видео
Презентация
Примечания и ссылки