Вот и обещанная вторая статья по Docs as code. В части 1 я рассказала про основные подходы создания технической документации. В этой статье я не буду останавливаться на других подходах, вас ждет чистый Docs as code.Как мы знаем, подход Docs as code основан на принципах и инструментах разработки,…
Привет, Хабр! В 2020 году компания решила вывести на рынок линейку продуктов Platform V. Для них нужна была документация, которая на тот момент велась в Confluence. Нам предстояло проделать сложную и дорогую работу: собрать документы на нужные версии, привести тексты к единому стилю и…
Какие главные проблемы технической документации? Во-первых, ее нет, во-вторых, если она есть, то не актуальна.Давайте порассуждаем, как мы можем попытаться упростить себе жизнь при создании документации, а главное увеличить ее актуальность и качество.Существует три класса задач,
Что такое Docs as Code классно описано в статье Docs as Code: введение в предмет. В двух словах: это ведение документации на языке разметки (Markdown, AsciiDoc) с хранением в репозитории. Плюшки — все вытекающие от работы с репозиторием.Минусы — в этой статье.На осенних Analyst Days прошлого года добрая…