Любой инструмент для документации умеет хранить статью. Ни один не знает, что только что смерженный PR сделал её неверной. Ellie Docs подключается к вашему репозиторию GitHub, отслеживает код, от которого на самом деле зависит каждая статья, и в момент устаревания помечает её и готовит правку.
Без карты · Регистрация через Google, Microsoft, GitHub или по почте
В API переименовали поле. Эндпоинт объявили устаревшим. Переделали сценарий в интерфейсе. PR сливается без замечаний, тесты проходят, а статья со старым поведением остаётся на месте: выглядит верной, но молча неточна, пока ошибку не заметит клиент или тикет в поддержку.
Каждую статью можно привязать к коду, эндпоинтам или спецификации API, которые она описывает, поэтому Ellie Docs точно знает, за чем следить.
GitHub App следит за смерженными PR, оценивает, затрагивают ли они связанную статью, и помечает её сразу с готовой правкой на проверку, а не просто красным баннером.
Есть спецификация OpenAPI? Ellie держит справочник в синхроне с ней и проверяет каждую версию на ломающие изменения. Спецификации нет? Ellie выведет её из ваших маршрутов и валидаторов запросов, указывая код, на который опирается каждое поле.
Установите GitHub App Ellie Docs в репозитории, от которых зависит документация продукта. Мы не храним копию вашего репозитория: код загружается, когда Ellie нужно его прочитать, а позже снова загружается по коммиту.
Перенесите существующую документацию через импорт обходом сайта или начните с нуля: Ellie Docs напишет статьи и свяжет каждую с кодом, эндпоинтами или спецификацией, от которых она зависит.
Когда merge затрагивает связанную статью, Ellie помечает её и готовит правку. Ваша команда проверяет очередь предложенных исправлений, а не ищет, что сломалось.
GitHub App с доступом только к выбранным вами репозиториям. Мы не храним копию вашего репозитория: Ellie загружает дерево файлов, когда ей нужно его прочитать, и затем повторно загружает по коммиту. Сохраняется производный материал, на котором держится статья: фрагменты и ссылки, стоящие за каждым утверждением, чтобы любое высказывание в документации можно было проследить до кода, который его подтверждает. Секреты, найденные в файлах, удаляются до сохранения, а ваш код никогда не используется для обучения моделей.
Да, такая и задумка: Ellie Docs сам размещает и отображает публичный центр помощи, включая собственные домены, так что вам не придётся вести две системы параллельно.
Да. Если указать Ellie Docs спецификацию, он поддерживает по ней справочник и сверяет его с каждой новой версией по мере развития API. Если спецификации нет, Ellie выводит её из кода: эндпоинты из роутера, типы полей из валидаторов запросов, а для всего, что код не говорит прямо, проводит исследование, в котором нужно сослаться на строки, откуда взято каждое поле. Выведенные эндпоинты остаются приватными, пока вы их не проверите, поэтому внутренние маршруты не попадут в публичный справочник.
Используйте Ellie Docs вместе с Ellie Desk (ранний доступ): закрытые тикеты поддержки можно превращать в новые статьи одним щелчком, а ИИ-черновики Desk автоматически опираются на вашу опубликованную документацию.
Бесплатный тариф, затем от $65 в месяц при оплате за год. Смотреть цены →
