Почему документация важна
- Актуальные API и параметры
- Рекомендации по лучшим практикам
- Принятые в компании соглашения
- Отраслевая терминология
Дата отсечения знаний модели
- Недавние обновления библиотек могут не учитываться
- Новые фреймворки или инструменты могут быть неизвестны
- Изменения в API после даты отсечения не попадут в модель
- Лучшие практики могли измениться с момента обучения
Какой инструмент выбрать?
Ментальная модель
Инструмент | Ментальная модель |
---|---|
@Docs | Похоже на просмотр и чтение официальной документации |
@Web | Похоже на поиск решений в интернете |
MCP | Похоже на доступ к твоей внутренней документации |
Публичная документация
Использование @Docs
@Docs
подключает Cursor к официальной документации популярных инструментов и фреймворков. Пользуйся им, когда нужна актуальная, авторитетная информация о:
- Справочниках по API: сигнатуры функций, параметры, типы возвращаемых значений
- Руководствах для начала работы: установка, конфигурация, базовое использование
- Рекомендованных практиках: рекомендуемые паттерны из первоисточника
- Отладке, специфичной для фреймворков: официальные руководства по устранению неполадок
@
@Docs Next.js How do I set up dynamic routing with catch-all routes?
∞
Agent⌘I
Auto
Использование @Web
@Web
ищет в интернете актуальную информацию, посты в блогах и обсуждения в сообществе. Используй это, когда нужно:
- Свежие руководства: Материалы и примеры от сообщества
- Сравнения: Статьи, сопоставляющие разные подходы
- Недавние обновления: Самые свежие обновления или анонсы
- Несколько точек зрения: Разные подходы к решению задач
@
@Web latest performance optimizations for React 19
∞
Agent⌘I
Auto
Внутренняя документация
- Внутренние API: Пользовательские сервисы и микросервисы
- Стандарты компании: Код-стайл, архитектурные паттерны
- Закрытые системы: Собственные инструменты, базы данных, рабочие процессы
- Отраслевые знания: Бизнес-логика, требования комплаенса
Доступ к внутренней документации с помощью MCP
- Модели не знают твоих внутренних соглашений
- Документация по API для собственных сервисов недоступна публично
- Бизнес-логика и доменная экспертиза уникальны для твоей организации
- Требования к комплаенсу и безопасности различаются от компании к компании
Распространённые интеграции MCP
Интеграция | Доступ | Примеры |
---|---|---|
Confluence | Корпоративные пространства Confluence | Архитектурная документация, спецификации API для внутренних сервисов, стандарты и рекомендации по кодингу, процессная документация |
Google Drive | Общие документы и папки | Спецификации, заметки встреч и записи решений, дизайн-документы и требования, командные базы знаний |
Notion | Базы данных и страницы рабочего пространства | Проектная документация, командные вики, базы знаний, продуктовые требования, технические спецификации |
Custom | Внутренние системы и базы данных | Проприетарные API, легаси-системы документации, кастомные базы знаний, специализированные инструменты и процессы |
Кастомные решения
- Скрейпят внутренние сайты или порталы
- Подключаются к проприетарным базам данных
- Доступаются к кастомным системам документации
- Подтягивают данные из внутренних вики или баз знаний
Если ты делаешь кастомный MCP‑сервер, можно также выставить инструменты, чтобы Cursor мог обновлять документацию
Поддержание актуальности документации
Из существующего кода
@
Сгенерируй документацию по API для этого роутера Express, включая все эндпоинты, параметры и форматы ответов
∞
Agent⌘I
Auto
Из чатов
После решения сложной задачи:
@
Summarize our conversation about setting up authentication into a step-by-step guide for the team wiki
∞
Agent⌘I
Auto
Главное
- Документация как контекст делает Cursor точнее и актуальнее
- Используй
@Docs
для официальной документации и@Web
для знаний сообщества - MCP связывает Cursor с твоими внутренними системами
- Генерируй документацию из кода и диалогов, чтобы поддерживать знания в актуальном состоянии
- Комбинируй внешнюю и внутреннюю документацию для более полного понимания