Docs-as-code на Etsy

Docs-as-code интегрирует документацию в разработку с использованием тех же инструментов и процедур, что и код. Она подчеркивает версионирование, разметку в plain-text и автоматизацию для улучшения управления документацией. Инструмент Docsbuilder от Etsy использует Markdown, Docusaurus и GitOps-работы для создания и поддержки документации. Docsbuilder автоматизирует создание сайта, валидацию и развертывание с помощью Google Cloud Build и интеграционных тестов. Docsbuilder обеспечивает доступность с помощью поисковой машины и навигационного компонента для часто используемых сайтов. На данный момент Etsy хостит более 6,2 тыс. страниц на 150 сайтах Docsbuilder. Целью docs-as-code является улучшение качества, эффективности и надежности документации. Важными принципами являются рассмотрение документации как первого класса, версионирование в Git, использование plain-text-форматов и автоматизация потоков работ. Docs-as-code поощряет разработчиков подходить к документации с той же тщательностью, что и к кодированию. Etsy планирует улучшать доступность, навигацию и вовлечение контента в Docsbuilder. Docs-as-code способствует сбалансированному подходу между документацией и кодированием, что приводит к организованной и поддерживаемой документации.