Wiki-страницы
Викикод автоматически генерирует 20 тематических wiki-страниц для каждого проекта. Каждая страница описывает отдельный аспект проекта и обновляется при изменении кодовой базы.
Список страниц
Основные
| Название | Что содержит |
|---|---|
| Обзор проекта | Цель и назначение проекта, ключевые технологии, структура каталогов, краткое описание каждого модуля |
| Архитектура | Диаграмма архитектуры, паттерны проектирования, слои приложения, взаимодействие компонентов |
| API Reference | Все HTTP-эндпоинты, форматы запросов и ответов, коды ошибок (для бэкенд-проектов) |
| AI Контекст | Ключевые концепции проекта и архитектурные решения — специально для AI-ассистентов |
| Модули и компоненты | Карта модулей, что делает каждый, зависимости между ними |
Техническая документация
| Название | Что содержит |
|---|---|
| База данных | Схема БД, описание таблиц и полей, связи, индексы |
| Авторизация | Механизм входа, OAuth-провайдеры, роли и права пользователей |
| Потоки данных | Как данные проходят через систему — от ввода до сохранения |
| Конфигурация | Переменные окружения, конфигурационные файлы, значения по умолчанию |
| Развёртывание | Инструкции по деплою, Docker, CI/CD, системные требования |
Frontend
Генерируются только если в проекте есть UI-файлы (
.tsx,.jsx,.vue,.svelte,.css)
| Название | Что содержит |
|---|---|
| Дизайн-система | Цветовая палитра, типографика, макеты, UI-библиотеки |
| Компоненты UI | Каталог компонентов: параметры, состояния, примеры |
Процессы и метрики
| Название | Что содержит |
|---|---|
| Решения (ADR) | Архитектурные решения: контекст, варианты, итоговый выбор |
| Журнал изменений | История изменений проекта |
| Гид для новичков | Как поднять проект, где что находится, с чего начать |
| Каталог ошибок | Типичные ошибки, причины, способы решения |
| Тест-покрытие | Обзор тестирования: типы тестов, покрытие, рекомендации |
| Производительность | Узкие места, рекомендации по оптимизации |
| Аудит зависимостей | Внешние библиотеки: версии, лицензии, риски |
| Руководства | Пошаговые инструкции: как добавить фичу, подключить модуль |
Генерация
Wiki-страницы создаются автоматически при глубоком сканировании. Также можно запустить отдельно:
Ctrl+Shift+P → Викикод: Создать базу знанийДля этого необходимо, чтобы документация файлов уже была создана.
Обновление отдельной страницы
Правый клик на странице в дереве → Обновить документацию
Страница перегенерируется с актуальным контекстом.
Модульные страницы
Кроме 20 тематических страниц, для каждого каталога проекта с двумя и более файлами автоматически создаётся модульная страница. Она содержит:
- Назначение модуля
- Список файлов и их функций
- Связи с другими модулями
- Рекомендации по развитию
Количество модульных страниц зависит от тарифа (5 / без ограничений / без ограничений).
Просмотр
Нажмите на страницу в дереве — она откроется с:
- Рендерингом Markdown с подсветкой синтаксиса
- Оглавлением в боковой панели
- Mermaid-диаграммами с возможностью зума
- Навигацией между страницами по ссылкам
- Кнопкой «Копировать» рядом с заголовками для копирования разделов