Суммаризация документации
Дока на 6 000 слов — в пункты, которые вам нужны.
Справки по API и гайды пишут для полноты, а читают ради трёх фактов: параметры, лимиты, подводные камни. Отправьте ссылку на документацию в @vustSummaryBot — и получите структуру самой страницы сканируемыми ключевыми пунктами, по-русски даже из англоязычных доков, с терминами без перевода.
Честные рамки
Суммаризатор доков — не парсер OpenAPI
Выжимка сжимает то, что страница говорит текстом: она не исполняет примеры кода, не разбирает спецификации и не проверяет, что endpoint всё ещё работает как описано. Одна страница за проход, примерно до 5 000 слов — дальше честное уведомление об усечении. Доки за логином загружаются только вставкой текста. Если нужен машинный разбор схем — это другой инструмент; если нужно быстро понять, что страница на самом деле говорит, — этот.
До и после
Реальные страницы документации — и что от них остаётся после выжимки.
Длинная документация — в ту часть, которая вам нужна
- Разработчику в дедлайн
- Между вами и одним интеграционным решением — справка на 6 000 слов
- Вставьте ссылку на доку и получите её собственную структуру в виде ключевых пунктов: что делает endpoint, какие входные параметры обязательны и какие предупреждения страница прячет в абзацах.
- Выбор библиотеки
- Сравнить две библиотеки — значит прочитать два комплекта документации целиком
- Суммируйте getting-started и страницы лимитов каждой в параллельные выжимки и решайте, глядя на различия, а не на сорок открытых вкладок.
- Доки только на английском
- Документация есть только на английском, и медленно продираться сквозь неё дорого
- Структурированная выжимка приходит по-русски: терминология остаётся, время на чтение — нет.
Как работает суммаризация документации
- 01
Вставьте ссылку на доку или текст
Отправьте ссылку на страницу документации (или вставьте текст) в @vustSummaryBot. Страницы загружаются напрямую, для трудноскрейпаемых сайтов есть reader-режим.
- 02
Структура страницы — сжатая
Выжимка следует секциям самой страницы — установка, параметры, лимиты, предостережения, которые страница сама называет, — в виде сканируемых пунктов, а не одной строки TL;DR.
- 03
За логином? Вставьте текст
Публичные страницы загружаются по ссылке; доки за авторизацией или пейволом стоят одного copy-paste нужного раздела — структура выжимки та же.
Выжимка из доки — в Telegram
Отправьте ссылку на документацию в @vustSummaryBot и получите её секции ключевыми пунктами — старт бесплатный, без карты.
Честные рамки — что это и чем это не является
Суммаризатор, а не парсер кода
Выжимка сжимает то, что страница говорит, — она не исполняет примеры кода, не разбирает OpenAPI-спеки и не проверяет, что endpoint всё ещё ведёт себя как задокументировано. Странице из сплошных код-блоков без прозы суммировать почти нечего; инструмент силён на справочных страницах, где всё объяснено абзацами.
Одна страница за проход, ~5 000 слов
Одна выжимка покрывает один URL или вставленный текст объёмом примерно до 5 000 слов — дальше вы получите явное уведомление об усечении, а не молчаливый обрез. Загрузка всего сайта документации и вопросы поперёк страниц — не фича, и мы не будем делать вид, что это так.
Доки за логином — только вставкой
Страницы за авторизацией или пейволом по URL не загрузятся — скопируйте нужный раздел и вставьте текстом. Публичные доки, README и базы знаний загружаются нормально.
Частые вопросы
Он умеет суммировать API-документацию, а не только статьи?
Да — это и есть задача этой страницы. Отправьте ссылку на доку (справку по API, гайд библиотеки, страницу базы знаний) в @vustSummaryBot — выжимка последует секциям самой страницы: что делает инструмент, его параметры, лимиты и предостережения, которые страница проговаривает текстом. Лучше всего работает на справочных страницах с объяснениями абзацами; странице из сплошных код-блоков сжимать почти нечего.
Какой длины страницу он потянет?
Примерно 5 000 слов за проход. Более длинные страницы суммируются с начала до этого окна, и вы получаете явное уведомление об усечении — никогда молча неполную выжимку. Для очень длинной справки надёжнее идти по секции за раз: вставляйте текст раздела.
Он сам загрузит URL или нужно вставлять текст?
Работает и так, и так. Публичные страницы загружаются напрямую, для сопротивляющихся скрейпингу сайтов есть reader-режим. Доки за логином, пейволом или во внутренней корпоративной сети по URL не загрузятся — скопируйте нужный раздел и вставьте текстом.
Он вытащит каждый endpoint и параметр в таблицу?
Нет, и мы не будем делать вид, что да. Это суммаризатор: он сжимает то, что страница говорит, сохраняя её структуру, — это не парсер OpenAPI, он не строит исчерпывающие таблицы параметров и не валидирует схемы. Вы получаете читаемую версию страницы: ключевые пункты, лимиты, предупреждения — по порядку.
Можно получить выжимку по-русски из англоязычной доки?
Да. Язык выжимки следует за вами, а не за источником: англоязычная справка возвращается структурированными русскими заметками, а технические термины остаются на английском там, где перевод навредил бы — имена endpoint'ов, параметров и коды ошибок не трогаются.
Чем это отличается от /summary/pdf и /summary/article?
Движок тот же, форма источника разная. /summary/pdf — загруженные файлы (научные статьи, отчёты, до 50 страниц); /summary/article — длинная журналистская проза; эта страница — про веб-документацию для разработчиков: справки по API, гайды, README-страницы, где на выходе нужны параметры, лимиты и предостережения, а не сюжет аргументации.
Суммаризация, поиск по документации, веб-поиск или чат для кода — что выбрать?
Это четыре разные задачи. Суммаризатор (эта страница) сжимает одну страницу документации, которая у вас уже есть, до решений и оговорок. Получение документации по версии — то, что делают сервисы вроде Context7, — подтягивает актуальный фрагмент документации под точную библиотеку и версию прямо в момент ответа ИИ-инструмента. Веб-поиск находит сегодняшние страницы, но версию не фиксирует. А чат для кода вроде @vustbot рассуждает над тем, что вы вставили. Если вопрос «что написано на ЭТОЙ странице» — суммаризируйте её; если «какой сейчас API у библиотеки X версии Y» — это уже поиск по документации, а не суммаризация.
Суммаризация любого источника — на одном Балансе.
Можно начинать
Документация — минус время на чтение.
Вставьте ссылку на доку и получите структурированную выжимку того, что там на самом деле написано — параметры, лимиты, предостережения — в Telegram, по-русски.