Привет!
Мы тут решили провести митап по DocOps — это почти как DevOps, только про документацию и всё, что с ней связано. Таких мероприятий обычно не так много, оно и понятно — документация не такая хайповая штука, как React, к примеру. Да и не только React, прямо скажем. Злые языки вообще утверждают, что от документации зрение портится.
Но она реально важна, с ней работают люди, и чем правильнее и логичнее у вас в компании выстроены процессы работы с документацией, тем всем будет проще. Даже тем коллегам, работа которых (на первый взгляд) в документацией не связана.
В общем, в пятницу, 26 июля, мы в 19.00 собираемся в Deworkacy (Москва, Берсеневская набережная, 6, стр 3) и начинаем документировать говорить про документацию. Список докладов — под катом.
19.00–19.30 Николай Поташников, компания «Курс-ИТ»
Ведение документации на программный продукт и ее переиспользование в отчетности заказчику
Мы используем Asciidoctor для ведения документации в крупных заказных проектах уже более двух лет. За это время накопился набор простых практик, позволяющих одновременно и ускорить работу и повысить качество получаемых документов. В докладе я рассмотрю решение нескольких практических задач по подготовке документации в Asciidoctor, с которыми мы сталкиваемся практически в каждом проекте.
19.30–20.00 Лана Новикова, компания «Iponweb»
Как мы пытались скрестить Sphinx и Confluence
Нередко организацию корпоративной wiki противопоставляют подходу Docs as code. Я расскажу, как мы пытались их примирить в рамках единого подхода, расскажу об опыте настройки публикации артефактов базы знаний команды UI разработки через CI в Confluence как отдельный таргет, что учли заранее, что не учли, что планируем еще сделать и какие «грабли» встретили на пути.
20.30–21.00 — перерыв на кофе, нетворкинг.
21.00–21.30 Николай Волынкин, компания «Plesk»
Замена рельсов под едущим поездом
Меняем инструмент разработки документации на docs-as-code. При этом:
- не останавливаем разработку и публикацию,
- делаем и сравниваем прототипы на нескольких инструментах,
- переносим переводы документации,
- исправляем ошибки и выравниваем стиль в исходном контенте,
- обходимся без ручной работы.
21.30–22.00 Константин Валеев, компания «Ростелеком Информационные технологии»
Ведение репозиториев с документацией
Расскажу, как вести репозиторий с документацией, рассмотрим несколько стандартных подходов, которые можно заимствовать у разработки, и парочку специфичных именно для документирования.
22.30–23.00 свободное общение
И еще разок для тех, кто одновременно читал анонс и продолжал документировать.
- 26 июля, пятница
- Москва, Берсеневская набережная, 6, стр 3 (Deworkacy, малый лекторий)
- 19.00–23.00
- Вход бесплатный.
- Ссылка на регистрацию.
Автор: RTteam
