Руководство по сценариям

Руководство по сценариям

Подробные руководства для каждого из 20 сценариев анализа CodeGraph.

Обзор

CodeGraph предоставляет 20 специализированных сценариев анализа, организованных по ролям пользователей:

┌─────────────────────────────────────────────────────────────────────────────┐
│                         20 сценариев анализа                                │
├─────────────────────────────────────────────────────────────────────────────┤
│  Разработчик    │  Безопасность      │  QA/Тестирование │  Автоматизация   │
│  ├─ Онбординг   │  ├─ Аудит безоп.   │  ├─ Покрытие     │  ├─ Редактир.    │
│  ├─ Разработка  │  ├─ Соответствие   │  └─ Код-ревью    │  ├─ Оптимизация  │
│  ├─ Рефакторинг │  ├─ Инциденты      │                  │  ├─ Стандарты    │
│  └─ Отладка     │  ├─ Точки входа    │                  │  └─ Зависимости  │
│                 │  └─ Зависимости    │                  │                  │
├─────────────────────────────────────────────────────────────────────────────┤
│  Тех. писатель  │  Продвинутые                                              │
│  ├─ Документация│  ├─ Производит.    ├─ Кросс-репо     ├─ Композитные     │
│  └─ Архитектура │  ├─ Тех. долг      └─ Масс. рефактор.└─ Workflows       │
└─────────────────────────────────────────────────────────────────────────────┘

Сценарии для разработчиков

# Сценарий Описание Руководство
01 Онбординг Изучение кодовой базы Руководство
04 Разработка Добавление новых функций Руководство
05 Рефакторинг Очистка и рефакторинг кода Руководство
15 Отладка Помощь в отладке Руководство

Сценарии безопасности

# Сценарий Описание Руководство
02 Аудит безопасности Сканирование уязвимостей Руководство
08 Соответствие Проверка соответствия стандартам Руководство
14 Инциденты Расследование инцидентов безопасности Руководство
16 Точки входа Маппинг API-поверхности Руководство
20 Зависимости Анализ уязвимостей зависимостей Руководство

Сценарии QA/Тестирования

# Сценарий Описание Руководство
07 Покрытие тестами Анализ пробелов в покрытии Руководство
09 Код-ревью Автоматизированный код-ревью Руководство

Сценарии для технических писателей

# Сценарий Описание Руководство
03 Документация Генерация API-документации Руководство
11 Архитектура Документация архитектуры Руководство

Продвинутые сценарии

# Сценарий Описание Руководство
06 Производительность Анализ производительности Руководство
10 Кросс-репозиторий Межрепозиторный анализ Руководство
12 Технический долг Оценка технического долга Руководство
13 Массовый рефакторинг Масштабный рефакторинг Руководство

Сценарии автоматизации

# Сценарий Описание Руководство
17 Редактирование файлов Модификации кода на основе AST Руководство
18 Оптимизация кода AI-оптимизация с подтверждением Руководство
19 Проверка стандартов Проверка соответствия документам Руководство
20 Зависимости Анализ и аудит зависимостей Руководство

Композитные workflows

Сценарии 18 и 19 могут работать как композитные оркестраторы, вызывая несколько подсценариев:

Оркестратор Подсценарии Описание
S18 (Оптимизация) S02, S05, S06, S11, S12 Комплексная оптимизация кода
S19 (Стандарты) S08, S17 Проверка соответствия документам

См. Руководство по композитным workflows для подробной архитектуры и использования.

Быстрый выбор

# TUI: Выбор сценария по номеру
/select 01   # Онбординг
/select 02   # Аудит безопасности
/select 03   # Документация
...
/select 17   # Редактирование файлов
/select 18   # Оптимизация кода
/select 19   # Проверка стандартов
/select 20   # Зависимости

# CLI: Запуск сценария напрямую
codegraph scenario security "Найти SQL-инъекции"
codegraph scenario onboarding "Объясните модуль executor"
codegraph scenario optimize "Улучшить производительность в src/"
codegraph scenario dependencies "Проверить уязвимости"

# CLI: Запуск композитного workflow
codegraph composition run "Оптимизировать src/" -o s18
codegraph composition run "Проверить стандарты" -o s19

# API: Выполнение запроса сценария
POST /api/v1/scenarios/02/query
{
  "query": "Найти потенциальные переполнения буфера"
}

# API: Выполнение композитного workflow
POST /api/v1/composition/query
{
  "query": "Комплексная оптимизация",
  "orchestrator": "scenario_18"
}

Руководство по выбору сценария

Задача Рекомендуемый сценарий
Новичок в кодовой базе 01 - Онбординг
Оценка безопасности 02 - Аудит безопасности
Добавление новой функции 04 - Разработка
Очистка кода 05 - Рефакторинг
Проблемы производительности 06 - Производительность
Написание тестов 07 - Покрытие тестами
Проверка кода 09 - Код-ревью
Управление тех. долгом 12 - Технический долг
Расследование инцидента 14 - Инциденты
Проблемы с отладкой 15 - Отладка
Точные правки в коде 17 - Редактирование файлов
Комплексная оптимизация 18 - Оптимизация кода
Соответствие стандартам 19 - Проверка стандартов
Безопасность зависимостей 20 - Зависимости

Связанная документация