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