Внедрение методологии Docs-as-Code позволило техническим писателям работать с документацией как с кодом, используя трекеры, git-репозитории и code review. Это обеспечило хранение всей документации в едином хранилище и возможность отслеживать историю изменений, что повысило качество документации.
Первоначальное использование reStructuredText (RST) столкнулось с проблемами, включая отсутствие TOC на гиперссылках, автонумерации, «битые» ссылки и разнородность стилей. Это привело к критике и необходимости изменения процесса.
Переход на AsciiDoc (ADOC) при помощи DevOps-инженеров стал важным шагом, позволившим автоматизировать процесс работы с текстами и проверять их до релиза. Конвейер CI/CD ускорил внесение изменений, а переход от формата "1 документ = 1 файл» к "1 глава = 1 файл» улучшил навигацию.
В результате, использование AsciiDoc и VSCodium дало возможность автоматизировать нумерацию элементов, сборку PDF, генерацию титульных страниц, а также декомпозировать документ на главы. Введение регламентов оформления текста и взаимодействия с аналитиками способствовало повышению качества документации и сокращению времени на обучение новых сотрудников.
Изображение носит иллюстративный характер
Первоначальное использование reStructuredText (RST) столкнулось с проблемами, включая отсутствие TOC на гиперссылках, автонумерации, «битые» ссылки и разнородность стилей. Это привело к критике и необходимости изменения процесса.
Переход на AsciiDoc (ADOC) при помощи DevOps-инженеров стал важным шагом, позволившим автоматизировать процесс работы с текстами и проверять их до релиза. Конвейер CI/CD ускорил внесение изменений, а переход от формата "1 документ = 1 файл» к "1 глава = 1 файл» улучшил навигацию.
В результате, использование AsciiDoc и VSCodium дало возможность автоматизировать нумерацию элементов, сборку PDF, генерацию титульных страниц, а также декомпозировать документ на главы. Введение регламентов оформления текста и взаимодействия с аналитиками способствовало повышению качества документации и сокращению времени на обучение новых сотрудников.
