Skip to content

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-диаграммами с возможностью зума
  • Навигацией между страницами по ссылкам
  • Кнопкой «Копировать» рядом с заголовками для копирования разделов

Документация Викикод