Работа со ScanSuite

AI-документация по коду

Создание учебного руководства по незнакомой кодовой базе с уклоном в безопасность.

Формирует учебное руководство по кодовой базе с уклоном в безопасность: какие в ней основные абстракции, как они связаны и что ревьюеру стоит понимать, прежде чем читать уязвимости. Включите его переключателем AI Code Documentation → Generate AI Code Documentation на странице Static Analysis.

Это особенно ценно для кодовой базы, которую никто в команде безопасности не писал, — приобретённого продукта, поставки от подрядчика или сервиса, авторы которого давно ушли.

Как это работает

Конвейер обходит файлы исходного кода для выбранного языка, а затем выполняет последовательность проходов модели:

  1. 01
    Выделение абстракций

    Какие значимые понятия есть в этой кодовой базе?

  2. 02
    Анализ связей

    Как эти абстракции зависят друг от друга и вызывают друг друга?

  3. 03
    Упорядочивание глав

    В каком порядке новичку стоит их читать?

  4. 04
    Написание глав

    По одной главе на абстракцию, написанной для читателя, который кода не видел.

  5. 05
    Сборка

    Главы собираются в единое руководство.

Как читать результат

Сформированная документация упаковывается в архив и публикуется так, чтобы её можно было читать прямо в веб-интерфейсе. Она также доступна по кнопке Report в разделе истории сканирований.

Стоимость

Генерация документации читает значительную часть кодовой базы — это одна из самых дорогих возможностей AI в пересчёте на запуск. Она же и та, которую вряд ли понадобится повторять: сформируйте её один раз, когда берётесь за незнакомую кодовую базу, а не на каждый коммит.

Выбор языка на странице Static Analysis определяет, какие файлы будут обойдены. Если репозиторий многоязычный, выберите All supported languages. Расход токенов фиксируется по каждому сканированию — см. AI-провайдеры и стоимость.

Проверено: 2026-08-16