FAQ — Часто задаваемые вопросы
Общие вопросы
Что такое Викикод?
Викикод — расширение VS Code, которое автоматически создаёт документацию по вашему проекту на русском языке. Вы нажимаете кнопку — и получаете полную базу знаний: описание архитектуры, модулей, API и многое другое.
Какие языки программирования поддерживаются?
TypeScript, JavaScript, Python, Go, Rust, Java, Kotlin, Ruby, PHP, Swift, C, C++, а также Vue, Svelte, CSS и HTML.
На каком языке генерируется документация?
Документация генерируется на русском языке. Названия функций, классов и библиотек остаются в оригинале.
Нужен ли интернет для работы?
Для генерации документации — да. Для просмотра уже сгенерированной — нет, всё хранится локально.
Документация
Где хранится документация?
Документация сохраняется в папке .wikicode/ в корне вашего проекта. Она также синхронизируется с сервером — это нужно для работы MCP и поиска.
Нужно ли коммитить .wikicode/ в git?
Рекомендуется. Если добавить .wikicode/ в git — документация будет доступна всей команде и корректно откатится при git revert.
Можно включить автокоммит: Ctrl+, → wikicode.autoCommit → true.
Что произойдёт при откате коммита?
Если .wikicode/ закоммичена, то git revert или git checkout откатит и документацию — дерево в расширении покажет предыдущую версию.
Как удалить всю документацию?
bash
rm -rf .wikicode/После этого дерево документации станет пустым. Для восстановления запустите глубокое сканирование.
Как обновить устаревшую документацию?
Три способа:
- Git Hook (рекомендуется) — автоматически после каждого коммита
- Вручную —
Ctrl+Shift+P→Викикод: Обновить устаревшую документацию - Глубокое сканирование — полная пересборка всей документации
Токены и лимиты
Расходуются ли лимиты на просмотр документации?
Нет. Просмотр, поиск, навигация, экспорт и чтение через MCP — бесплатны. Лимиты расходуются только на генерацию: глубокое сканирование, обновление файла, вопрос по коду.
Когда сбрасываются лимиты?
1 числа каждого месяца. Неиспользованные лимиты не переносятся.
Как узнать остаток лимитов?
В боковой панели Викикод отображается текущий тариф и статус базы знаний.
Безопасность
Безопасно ли отправлять код на сервер?
Код передаётся по зашифрованному соединению. На сервере сохраняется только сгенерированная документация, исходный код не хранится.
Где хранятся токены авторизации?
В зашифрованном хранилище VS Code, специфичном для вашей операционной системы.
Что происходит при выходе из аккаунта?
Сессия завершается, токен удаляется с устройства. Документация на диске остаётся.
Git Hook
Блокирует ли hook коммит?
Нет. Обновление документации происходит в фоне — коммит завершается мгновенно.
Нужен ли Python для Git Hook?
Да, Python 3 должен быть установлен на вашем компьютере.
Как долго действует hook?
Ключ, который записывается в hook, действует 1 год. После истечения переустановите hook: Ctrl+Shift+P → Викикод: Установить Git Hook → Переустановить.
MCP
Что такое MCP и зачем он нужен?
MCP позволяет AI-ассистентам (Claude, Cursor, Copilot и другим) читать документацию вашего проекта прямо во время разговора. Ассистент будет давать точные ответы на основе актуального контекста вашего кода.
Какие AI-клиенты поддерживаются?
Claude Desktop, Cursor, GitHub Copilot, Antigravity, Qoder, Zed.
Устранение неполадок
Расширение не активируется
- Убедитесь, что VS Code версии 1.93.0 или выше
- Откройте папку проекта, а не отдельный файл
Ctrl+Shift+P→Developer: Reload Window
Ошибка авторизации
- Проверьте интернет-соединение
- Попробуйте другой способ входа (GitHub / Яндекс)
- Выйдите и войдите заново
Генерация зависает или долго работает
- Проверьте интернет-соединение
- Для больших проектов (100+ файлов) сканирование может занять до 10 минут
- Если проблема сохраняется — попробуйте позже
Дерево документации пустое
- Убедитесь, что вы авторизованы
- Запустите глубокое сканирование
- Убедитесь, что в проекте есть файлы поддерживаемых типов
Git Hook не срабатывает
- Проверьте наличие Python 3:
python3 --version - Переустановите hook:
Ctrl+Shift+P→Викикод: Установить Git Hook→Переустановить
Поддержка
- Сайт: wikicode.ru
- Разработчик: Нейрика