Опыт внедрения Docs as a Code в продуктовую команду с нуля: от идеи, до проверенного workflow
-
40 мин
B2B продукты IT-компаний зачастую требуют наличия документации, чтобы специалисты заказчика могли работать с продуктом. ALD Pro — один из таких продуктов.
Цель доклада — рассказать, как наша команда за 3 месяца конвертировала разрозненные материалы на 1000+ листов А4 в унифицированную, автоматизированную систему на основе концепции Docs as a Code. Основная работа заключалась в переводе текстовых, графических, табличных и прочих материалов в формат rST с хранением в Git VCS, и реализации автоматизированной сборки готовых PDF-документов и Справочного центра (для просмотра в веб-браузере). Мы столкнулись с нетривиальными вызовами: обучение коллег для использования rST и Git, доработка ГОСТ-стилей оформления PDF документов для сертифицированного исполнения, проработка workflow для техписателей и аналитиков, и др.
В докладе расскажем, какие возникли задачи, и как мы их решили, что не получилось, сколько человеко-ресурсов потратили и кому делегировать данную работу в условиях сжатых сроков.