Викикод — Руководство пользователя

Содержание

1. Что такое Викикод
2. Установка
3. Вход в аккаунт
4. Главный экран
5. Онбординг
6. Создание базы знаний
7. Дерево документации
8. Просмотр документации
9. Что такое база знаний
10. Модульные страницы
11. Документация файлов
12. Как задать вопрос по коду
13. Автоматическое обновление (Git Hook)
14. Подключение к AI-ассистентам (MCP)
15. Экспорт документации
16. Статистика и лимиты
17. Тарифные планы
18. Какие файлы читает сервис
19. Где хранится документация
20. Выход из аккаунта
21. Частые вопросы

---

Что такое Викикод

Викикод — расширение для VS Code и совместимых редакторов (Cursor, VSCodium, Windsurf), которое автоматически создаёт документацию по вашему проекту на русском языке. Вы нажимаете одну кнопку — и получаете полную базу знаний: описание архитектуры, модулей, API, базы данных, руководства и многое другое.

Что вы получаете:

• Документация каждого файла в проекте
• 20 тематических страниц базы знаний
• Отдельная документация каждого модуля (каталога)
• Возможность задавать вопросы по коду и получать ответы
• Автоматическое обновление после каждого коммита
• Интеграция с AI-ассистентами (Claude, Cursor, Copilot и другие)

---

Установка

1. Скачайте файл расширения (.vsix) с сайта wikicode.ru
2. Откройте VS Code
3. Нажмите Ctrl+Shift+P и введите Extensions: Install from VSIX...
4. Выберите скачанный файл
5. Перезагрузите VS Code

После установки в боковой панели появится иконка Викикод (зелёный пиксельный логотип).

Расширение автоматически проверяет обновления при каждом запуске VS Code. Если доступна новая версия — появится уведомление с предложением обновить.

---

Вход в аккаунт

Для работы с Викикодом необходим аккаунт.

1. Нажмите на иконку Викикод в боковой панели VS Code
2. Вы увидите экран входа с двумя кнопками:
   • Войти через GitHub
   • Войти через Яндекс
3. Нажмите на любую кнопку — откроется браузер
4. Подтвердите авторизацию на сайте провайдера
5. Вы автоматически вернётесь в VS Code

Авторизация сохраняется между сессиями. Повторный вход не требуется.

---

Главный экран

После входа панель Викикод показывает:

Профиль

• Аватар и имя — ваш аккаунт
• Тариф — текущий план (Бесплатный / Про / Ультима)
• Кнопка «Улучшить» — переход на страницу смены тарифа (для планов ниже Ультима)

Статус базы знаний

• «База знаний не создана» — если сканирование ещё не запускалось. Нажмите «Создать базу знаний»
• «42 файлов · 15 мин. назад» — если база уже создана. Показывает количество файлов и время последнего сканирования
• «Анализирую файлы...» — идёт сканирование

Нижняя часть

• Викикод ↗ — ссылка на сайт
• Помощь — ссылка на документацию
• Создано в Нейрика — разработчик

---

Онбординг

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

Шаг 1 — Git Hook. Автоматически обновляет документацию после каждого коммита. Рекомендуем установить сразу — тогда документация всегда будет актуальной. Можно пропустить и настроить позже через Ctrl+Shift+P → «Викикод: Установить Git Hook».

Шаг 2 — MCP-сервер. Подключает документацию к AI-ассистентам (Claude, Cursor, Copilot). Если вы ими пользуетесь — настройте сейчас. Можно пропустить и настроить позже.

Шаг 3 — База знаний. Нажмите «Создать базу знаний» — Викикод начнёт анализировать проект. Этот шаг нельзя пропустить.

---

Создание базы знаний

Это главная операция Викикода. Викикод анализирует все исходные файлы проекта, создаёт документацию для каждого из них, а затем генерирует 20 тематических wiki-страниц и страницы для каждого модуля.

Время: зависит от размера проекта. Обычно 2–10 минут.

При первом запуске база знаний создаётся через онбординг — после входа в аккаунт визард автоматически предложит нажать «Создать базу знаний».

Для повторного запуска или обновления:

• Кнопка «Обновить» на главном экране панели
• Ctrl+Shift+P → «Викикод: Глубокое сканирование проекта»
• Правый клик на папке в проводнике → «Глубокое сканирование проекта»

---

Дерево документации

После авторизации под главной панелью появляется дерево «Документация». Оно содержит три секции:

База знаний

20 тематических страниц (подробнее — ниже).

Модули

Документация каталогов проекта. Для каждого каталога с 2+ файлами генерируется отдельная страница.

Файлы

Документация отдельных файлов, сгруппированных по каталогам (как в проводнике).

Цветовая индикация

Цвет квадрата	Значение
🟢 Зелёный	Документация актуальна
🟡 Жёлтый	Файл изменён — документация устарела
Нет цвета	Документация ещё не сгенерирована

---

Просмотр документации

Нажмите на любой элемент с зелёным или жёлтым индикатором в дереве. Документация откроется во встроенном просмотрщике:

• Markdown с подсветкой синтаксиса
• Оглавление (Table of Contents) в боковой панели
• Диаграммы Mermaid с возможностью увеличения
• Навигация ссылками между страницами
• Кнопка «Копировать» — появляется при наведении на заголовок раздела (H2, H3). Копирует весь раздел в буфер обмена в формате Markdown.

---

Что такое база знаний

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

Список страниц

Страница	Что в ней написано
Обзор проекта	Цель проекта, ключевые технологии, структура каталогов, назначение каждого модуля
Архитектура	Диаграмма архитектуры, паттерны проектирования, слои приложения, взаимодействие компонентов
API Reference	Все HTTP-эндпоинты, форматы запросов и ответов, коды ошибок (для бэкенд-проектов)
AI Контекст	Сжатое описание проекта для AI-ассистентов: ключевые термины, концепции, решения
Модули и компоненты	Карта всех модулей проекта, что делает каждый, зависимости между ними (диаграмма)
База данных	Схема БД, описание таблиц, полей, связей, индексов (для проектов с БД)
Авторизация	Механизм аутентификации, провайдеры OAuth, JWT, роли, flow авторизации
Руководства	Пошаговые инструкции: как добавить фичу, подключить модуль, мигрировать данные
Потоки данных	Как данные проходят через систему — от ввода до сохранения (sequence-диаграммы)
Конфигурация	Все переменные окружения, конфигурационные файлы, значения по умолчанию
Развёртывание	Инструкции по деплою, Docker, CI/CD, системные требования
Дизайн-система	Общий обзор UI: палитра, типографика, макеты, UI-библиотеки (только для frontend)
Компоненты UI	Каталог компонентов: пропсы, состояния, примеры (только для frontend)
Решения (ADR)	Архитектурные решения: контекст, варианты, итоговый выбор и обоснование
Журнал изменений	История изменений проекта
Гид для новичков	Как поднять проект, где что находится, с чего начать новому разработчику
Каталог ошибок	Типичные ошибки, причины возникновения, способы исправления
Тест-покрытие	Обзор тестирования: типы тестов, покрытие, рекомендации
Производительность	Узкие места, рекомендации по оптимизации, кэширование
Аудит зависимостей	Внешние зависимости: версии, лицензии, потенциальные риски

Страницы Дизайн-система и Компоненты UI генерируются только если в проекте есть frontend-файлы (.tsx, .jsx, .vue, .svelte, .css).

---

Модульные страницы

Для каждого каталога верхнего уровня, в котором находятся 2 или более файлов, автоматически генерируется модульная страница. Она содержит:

• Назначение модуля
• Все файлы модуля и их роль
• Зависимости модуля от других модулей
• Внутренние связи между файлами
• Рекомендации по развитию

Пример: если проект имеет каталоги src/auth/, src/api/, src/utils/ — для каждого будет модуль в дереве.

---

Документация файлов

Для каждого исходного файла генерируется подробная документация:

• Назначение файла
• Экспортируемые функции, классы, типы
• Зависимости и импорты
• Детали реализации
• Примеры использования
• Диаграммы (при необходимости)

Обновление одного файла:

• Правый клик на файле в проводнике → «Сгенерировать документацию для файла»
• Или правый клик на файле в дереве документации → «Обновить документацию файла»

---

Как задать вопрос по коду

Вы можете задать вопрос по проекту, и AI ответит на основе сгенерированной документации.

1. Ctrl+Shift+P → «Викикод: Задать вопрос по кодовой базе»
2. Введите вопрос — например:
   • «Как работает авторизация?»
   • «Какие эндпоинты есть в API?»
   • «Как добавить новый модуль?»
3. Ответ откроется в новой вкладке

Расширение автоматически найдёт нужные фрагменты документации и использует их как контекст для ответа.

---

Автоматическое обновление (Git Hook)

Рекомендуемый способ поддерживать документацию актуальной — установить Git Hook. После этого при каждом git commit документация изменённых файлов будет автоматически обновляться.

Установка

Ctrl+Shift+P → «Викикод: Установить Git Hook» → «Установить»

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

1. Вы делаете git commit как обычно
2. Hook определяет, какие файлы были изменены
3. Для каждого изменённого файла в фоне отправляется запрос на обновление документации
4. Коммит не блокируется — всё происходит асинхронно

Управление

Повторный запуск команды предложит:

• Удалить hook — отключить автообновление
• Показать содержимое — посмотреть, что делает hook
• Переустановить — обновить (полезно при смене аккаунта)

Требования

• Python 3 — должен быть установлен и доступен в PATH

---

Подключение к AI-ассистентам (MCP)

Викикод может передавать документацию вашего проекта напрямую AI-ассистентам через стандарт MCP (Model Context Protocol).

Поддерживаемые ассистенты

• Claude Desktop
• Cursor
• GitHub Copilot
• Antigravity
• Qoder
• Zed

Как подключить

1. Ctrl+Shift+P → «Викикод: Настроить MCP сервер»
2. Выберите AI-клиент из списка (расширение автоматически определит установленные)
3. Перезапустите выбранный AI-клиент

Теперь AI-ассистент сможет:

• Искать по документации вашего проекта
• Получать документацию конкретного файла
• Читать wiki-страницы (архитектура, API, модули и т.д.)
• Давать более точные ответы на основе контекста проекта

---

Экспорт документации

Всю документацию можно экспортировать для публикации.

Ctrl+Shift+P → «Викикод: Экспортировать документацию»

Доступные форматы

Формат	Описание
Markdown	Простые .md файлы, готовые для Git-репозитория
VitePress	Структура для сайта на VitePress (с конфигом и сайдбаром)
Docusaurus	Структура для сайта на Docusaurus

---

Статистика и лимиты

Где посмотреть

Статистика отображается на главном экране панели Викикод:

• Тариф — ваш текущий план
• Статус базы — количество файлов и время последнего сканирования

Подробные лимиты можно увидеть через команду Ctrl+Shift+P → «Викикод: Настройки аккаунта».

Что расходует лимиты

Действие	Что расходуется
Создать базу знаний / Глубокое сканирование	1 сканирование
Сгенерировать документацию файла	1 обновление файла
Обновление через Git Hook (1 файл)	1 обновление файла
Задать вопрос по кодовой базе	1 вопрос

Что НЕ расходует лимиты

• Просмотр документации
• Навигация по дереву
• Поиск по документации
• Экспорт
• Чтение через MCP
• Копирование разделов
• Установка Git Hook

---

Тарифные планы

	Бесплатный	Про	Ультима
Глубокие сканирования / мес.	5	50	∞
Обновления файлов / мес.	50	500	∞
Вопросы / мес.	50	500	∞
Проекты	3	10	∞
Модули	5	∞	∞
Макс. файлов	50	500	∞
Wiki-страницы	✅	✅	✅
MCP	✅	✅	✅
Git Hook	✅	✅	✅
Экспорт	✅	✅	✅
Приоритетная очередь	—	—	✅

Лимиты сбрасываются 1 числа каждого месяца.

Как улучшить: кнопка «Улучшить» на главном экране или Ctrl+Shift+P → «Викикод: Улучшить тариф».

---

Какие файлы читает сервис

При сканировании Викикод анализирует файлы следующих типов:

Расширение	Язык
.ts, .tsx	TypeScript
.js, .jsx	JavaScript
.py	Python
.go	Go
.rs	Rust
.java	Java
.kt	Kotlin
.rb	Ruby
.php	PHP
.swift	Swift
.c, .cpp, .h, .hpp	C / C++
.vue	Vue
.svelte	Svelte
.css, .scss	CSS
.html	HTML

Что автоматически исключается

• node_modules/ — зависимости npm
• .git/ — внутренние файлы Git
• dist/, build/ — результаты сборки
• .wikicode/ — документация самого Викикода
• coverage/ — отчёты покрытия тестами
• __pycache__/ — кеш Python
• vendor/ — зависимости Go/PHP

---

Где хранится документация

Документация сохраняется в папке .wikicode/ в корне проекта. Она также хранится на сервере — это нужно для работы MCP и поиска.

Рекомендуем добавить .wikicode/ в git — тогда документация будет доступна всей команде и корректно откатится при git revert.

---

Выход из аккаунта

Способ 1: Меню ⋮ в панели Викикод → «Выйти из аккаунта»

Способ 2: Ctrl+Shift+P → «Викикод: Выйти из аккаунта»

При выходе:

• Токен отзывается на сервере
• Локальные токены удаляются
• Документация на диске не удаляется — вы сможете просматривать её без авторизации

---

Частые вопросы

Безопасно ли отправлять код?

Да. Код передаётся по HTTPS. На сервере сохраняется только сгенерированная документация, а не исходный код.

Нужен ли интернет?

Для генерации — да. Для просмотра уже сгенерированной документации — нет.

Что если я откачу коммит?

Если .wikicode/ закоммичена в git, то git revert или git checkout откатит и документацию. Дерево расширения покажет предыдущую версию.

Как удалить всю документацию?

rm -rf .wikicode/

Как обновить устаревшую документацию вручную?

Ctrl+Shift+P → «Викикод: Обновить устаревшую документацию» — перегенерирует все изменившиеся файлы.

Git Hook не работает

1. Проверьте наличие Python 3: python3 --version
2. Проверьте права на файл: ls -la .git/hooks/post-commit
3. Переустановите: Ctrl+Shift+P → «Викикод: Установить Git Hook» → «Переустановить»

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

1. Убедитесь, что вы авторизованы
2. Запустите глубокое сканирование
3. Проверьте, что в проекте есть файлы поддерживаемых типов

Генерация зависает или долго работает

AI-сервер может быть загружен — подождите или попробуйте позже. Для больших проектов (100+ файлов) сканирование может занять до 10 минут.

---

Поддержка

• Сайт: wikicode.ru
• Разработчик: Нейрика