http://0x1.tv/20171020DM

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

-------------

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

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

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

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

http://0x1.tv/20181013DB

Применение практики «Документация как код» для документирования заказных приложений (Николай Поташников, SECR-2018)
* Николай Поташников

-------------

Умение создавать хорошую документацию выделяет разработчика среди конкурентов. Умение создавать документацию эффективно, не затрачивая больших усилий, не так заметно, но не менее важно, особенно если создается сложный программный продукт, а заказчик оказался требовательным.

Наш 20-летний опыт создания заказных приложений позволяет с уверенностью сказать, что практика «Документация как код» является наилучшей для сокращения усилий при документировании, причем как в маленьких, так и в очень больших проектах с любым уровнем формализации требований. В докладе я расскажу о том, как эта практика применяется у нас в компании.

В своей работе мы ориентируемся на технологическую цепочку Asciidoctor, но речь пойдет об общем подходе к процессу подготовки программной документации, его организационной и технологической составляющих.