Техническим писателям у нас в компании нужно успевать обновлять документацию не по одному продукту, а по целой экосистеме решений. В этом им помогает методология Docs-as-Code и инженеры.

Как это работает. Документация хранится в форматах Markdown или Acsiidoc в едином хранилище — в том же репозитории, что и основной код. Файлы автоматически собираются в удобный документ в нужном формате. История всех изменений видна. Как и код, текст документов можно проверять до релиза.

Технические писатели пробовали разные форматы файлов и инструменты. Выбор платформы и редактора был непростым. На помощь пришли DevOps-инженеры:

🔹провели экспертизу и рекомендовали формат AsciiDoc;
🔹помогли организовать новый репозиторий и установить нужные инструменты;
🔹подготовили стили для документов с учетом стандартов компании;
🔹написали CI/CD-конвейер для сборки документов.

Об этапах перехода, процессах управления и развития документации и регламенте работы наши техписы подготовили отличную статью для блога «Базис» на Хабре.

Лайки, комментарии и плюсы в карму приветствуются :)

basistech.ru