Конференция завершена. Ждем вас на TechLead Conf в следующий раз!

Чем публиковать Markdown и RST? Обзор современного документационного инструментария Способы управления техническими знаниями внутри компании

Доклад принят в программу конференции
Семён Факторович
documentat.io

Пять лет писал на C++, а потом добровольно и осознанно стал техническим писателем (да, так бывает!).

С 2012 до 2018 руководил отделом технической документации в Zodiac Interactive.

В 2018 году вместе с партнером основал компанию по заказной разработке документации и консалтингу в этой области.

Telegram @factorized

Twitter @lazeez
Константин Валеев
Ростелеком ИТ

Руководит отделом системной аналитики и документации в «Ростелеком Информационные Технологии» — софтверной дочке «Ростелекома». Курирует несколько масштабных проектов. Разбирается в системном анализе и документировании практически и теоретически.

kvaleev@gmail.com
Николай Волынкин
Plesk

Технический писатель, распространяет добрую весть о DocOps и подходе «документация — это код».

Тезисы

Легковесные языки разметки (Markdown, reStructuredText, Asciidoc) победоносно шагают по планете. Markdown понимает, кажется, каждый второй editbox в вебе.

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

Но как быть, если из сотни статей в Markdown нужно сгенерить красивый HTML-портал, а из RST — симпатичную PDF'ку в корпоративном шаблоне?

На этом мастер-классе мы поговорим о современном состоянии экосистемы инструментария вокруг легковесных языков разметки.

Костя Валеев (Ростелеком ИТ) расскажет об их in-house-продукте Foliant и о том, как из Markdown-исходников можно создавать кастомизированные PDF и HTML.

Коля Волынкин (Plesk) расскажет о том, как они генерят огромные HTML-порталы с помощью Sphinx-doc.

Семён Факторович (documentat.io) расскажет о «швейцарском ноже» Pandoc, о том, как его можно расширять с помощью Haskell, Lua и Python, и как мы с его помощью победили генерацию DOCX.

Другие доклады секции Способы управления техническими знаниями внутри компании