Wiki-страницы
Викикод автоматически генерирует 25 тематических wiki-страниц для каждого проекта. Каждая страница описывает отдельный аспект проекта и обновляется при изменении кодовой базы.
Страницы сгруппированы по логике: от понимания продукта — к архитектуре, техническому ядру, инфраструктуре и инструментам разработчика.
Продукт и бизнес
| Страница | Что содержит |
|---|---|
| Обзор проекта | Назначение и бизнес-ценность, ключевые возможности, технологический стек, структура проекта, быстрый старт, решаемые проблемы |
| Кейс | Повествование по схеме «Проблема → Решение → Результат»: контекст, вызовы команды, ключевые решения, итоговая ценность |
| Рынок | Рыночная ниша, целевая аудитория (2–3 сегмента), анализ конкурентов и конкурентные преимущества |
| UX | Пользовательские пути с flowchart-схемами, информационная архитектура, пользовательские истории (US-NN) |
Бизнес-логика и архитектура
| Страница | Что содержит |
|---|---|
| Бизнес-логика | BPMN-подобные sequenceDiagram схемы ключевых сценариев: счастливый путь, ветвления, валидации, автоматические задачи, обработка исключений |
| Архитектура | Высокоуровневое описание, диаграмма компонентов, паттерны проектирования, точки расширения |
| Решения (ADR) | Задокументированные архитектурные решения: контекст, альтернативы, обоснование, последствия |
Техническое ядро
| Страница | Что содержит |
|---|---|
| Модули и компоненты | Карта модулей, назначение каждого, ключевые экспорты, зависимости между модулями |
| База данных | Схема БД с ER-диаграммой, описание таблиц и полей, связи, индексы, управление миграциями |
| Авторизация | Механизм аутентификации, OAuth-провайдеры, JWT-структура, роли и права, OAuth flow-диаграмма |
| API Reference | Все эндпоинты с параметрами, форматами запроса/ответа, кодами ошибок, curl-примерами |
| Потоки данных | Sequencediagram-схемы ключевых сценариев: happy path, обработка ошибок, фоновые процессы |
Frontend
Генерируются только если в проекте есть UI-файлы (
.tsx,.jsx,.vue,.svelte,.css)
| Страница | Что содержит |
|---|---|
| Дизайн-система | Цветовые токены с превью, типографика, отступы, каталог компонентов со ссылками |
| Компоненты UI | Спецификация каждого компонента: props, события, варианты, интерактивный preview, a11y |
Инфраструктура
| Страница | Что содержит |
|---|---|
| Конфигурация | Все переменные окружения, конфигурационные файлы, различия dev/prod, пример .env |
| Развёртывание | Пошаговый деплой, Docker, Nginx, SSL, systemd, мониторинг, rollback |
| Docker | Схема контейнеров, таблица сервисов с портами и env, volumes, сети, команды запуска |
Качество и надёжность
| Страница | Что содержит |
|---|---|
| Тест-покрытие | Виды тестов, карта покрытия по модулям, критические пути, команды запуска, пробелы |
| Каталог ошибок | Классификация ошибок, HTTP-статусы API, паттерны обработки ошибок, алгоритм диагностики |
| Производительность | Hotspots, анализ запросов к БД, кэширование, конкурентность, приоритизированные рекомендации |
| Аудит зависимостей | Прямые зависимости, анализ лицензий, риски безопасности, устаревшие пакеты, процесс обновления |
Для разработчика
| Страница | Что содержит |
|---|---|
| AI Контекст | Сжатое описание проекта для AI-ассистентов: стек, ключевые абстракции, правила и конвенции |
| Руководства | Онбординг за 15 минут, workflow добавления фичи, расширение системы, отладка, FAQ |
| Гид для новичков | Пошаговая установка с нуля, первая задача, структура кода, ключевые концепции, типичные ошибки |
| Журнал изменений | Changelog в формате Keep a Changelog, инструкции по ведению при создании PR |
Генерация
Wiki-страницы создаются автоматически при глубоком сканировании. Также можно запустить отдельно:
Ctrl+Shift+P → Викикод: Создать базу знанийДля этого необходимо, чтобы документация файлов уже была создана.
Обновление отдельной страницы
Правый клик на странице в дереве → Обновить документацию
Страница перегенерируется с актуальным контекстом.
Модульные страницы
Кроме 25 тематических страниц, для каждого каталога проекта с двумя и более файлами автоматически создаётся модульная страница. Она содержит:
- Назначение модуля
- Список файлов и их функций
- Связи с другими модулями
- Рекомендации для AI-ассистента по работе с модулем
Количество модульных страниц зависит от тарифа (5 / без ограничений / без ограничений).
Просмотр
Нажмите на страницу в дереве — она откроется с:
- Рендерингом Markdown с подсветкой синтаксиса
- Оглавлением в боковой панели
- Mermaid-диаграммами с возможностью зума и сохранением в PNG
- Навигацией между страницами по ссылкам
- Датой генерации в виде чипсы над заголовком
- Кнопкой «Копировать» рядом с заголовками для копирования разделов
- Кнопкой «Поделиться» — публикует страницу по публичной ссылке на 30 дней