Documentation as Code: когда документация становится продуктом

  • 40 мин

Документация редко становится приоритетом в продуктах, не являющихся first-API. В Битрикс24 изменения начались именно с неё и затронули процессы и технологии DevRel. Мы отказались от закрытой легаси-документации, перевели материалы в Markdown, собрали их на Diplodoc и открыли публичный репозиторий. Так документация стала «как код» — с pull request, ревью и автоматизацией.
AI-агент анализирует исходный код и генерирует черновики статей, команда документации доводит их до готового вида. Одновременно нам удалось сместить фокус от справочника методов к практическим сценариям и руководствам. AI помогает переводить материалы на английский, что позволило выпускать обновления каждую неделю. Эффективность новой документации мы проверили, сравнив её со старой по упоминаниям в публичных чатах разработчиков.
Примененный подход изменил роль технического писателя, позволил встроить AI и сообщество в процесс, а документация стала катализатором изменений в продуктовом DevRel компании.

Комментарии ({{Comments.length}})
  • {{comment.AuthorFullName}}
    {{comment.AuthorInfo}}
    {{ comment.DateCreated | date: 'dd.MM.yyyy' }}

Для того чтобы оставить комментарий необходимо

или
Напишите нам, мы онлайн!