Документация как код в промышленных масштабах (Николай Волынкин, SECR-2017) — различия между версиями
Материал из 0x1.tv
StasFomin (обсуждение | вклад) |
StasFomin (обсуждение | вклад) (Batch edit: replace PCRE (\n\n)+(\n) with \2) |
||
(не показаны 44 промежуточные версии этого же участника) | |||
;{{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|}} --> |sVStWzgDnNA}}{{letscomment}} {{SlidesSection}} * http://nick.volynkin.gitlab.io/docs-like-code.html <!-- [[File:Документация как код в промышленных масштабах (Николай Волынкин, SECR-2017).pdf|left|page=-|300px]] --> {{----}} [[File:{{#setmainimage:Документация как код в промышленных масштабах (Николай Волынкин, SECR-2017)!.jpg}}|center|640px]] {{LinksSection}} * [http://2017.secrus.ruorg/program/submitted-presentations/docs-like-code-in-enterprise Страничка доклада на сайте конференции] <!-- <blockquote>[©]</blockquote> --> {{fblink|1965725253680486}} {{vklink|967}} <references/> <!-- topub --> {{stats|disqus_comments=0|refresh_time=2021-08-31T17:00:21.461113|vimeo_comments=0|vimeo_plays=293|youtube_comments=1|youtube_plays=179}} [[Категория:SECR-2017]] [[Категория:Draft]]Документирование]] |
Текущая версия на 12:20, 4 сентября 2021
- Докладчик
- Николай Волынкин
История о том, как мы в Plesk внедряем лучшие практики разработки ПО в разработку документации.
- Какие проблемы были в разработке документации и как мы их решаем.
- Что такое разработка документации как кода (“docs like code”): легковесные языки разметки, контроль версий, непрерывная интеграция и поставка (CI/CD), контролируемая публикация, связь с разработкой и выпуском продукта.
- В чём польза для технических писателей и для бизнеса.
- Как перейти на docs like code, не ломая процессы и не выкидывая легаси.
Доклад адресован всем, кто заинтересован в управлении знаниями в компании: техписателям и их руководителям, менеджерам продуктов и проектов, тимлидам и архитекторам, CTO, энтузиастам свободного программного обеспечения.
Технологии: reStructuredText, Sphinx, Markdown, Jekyll, Git, CI/CD, GitLab CI, Docker, pandoc.
Видео
Посмотрели доклад? Понравился? Напишите комментарий! Не согласны? Тем более напишите.
Презентация
Примечания и ссылки
Plays:472
Comments:1