​
Почему документация важна

Документация предоставляет актуальный и точный контекст. Без неё модели используют устаревшие или неполные данные обучения. Документация помогает моделям понимать такие вещи, как:
  • Текущие API и параметры
  • Лучшие практики
  • Соглашения организации
  • Терминология предметной области
И многое другое. Читайте дальше, чтобы узнать, как использовать документацию прямо в Cursor без необходимости переключения контекста.

​
Граница знаний модели

Большие языковые модели обучаются на данных до определенного момента времени, называемого “границей знаний”. Это означает:
  • Недавние обновления библиотек могут не отражаться
  • Новые фреймворки или инструменты могут быть неизвестны
  • Изменения API после даты границы знаний пропускаются
  • Лучшие практики могли развиться с момента обучения
Например, если граница знаний модели приходится на начало 2024 года, она не будет знать о функциях, выпущенных в конце 2024 года, даже для популярных фреймворков.

​
Какой инструмент следует использовать?

Используйте это дерево решений, чтобы быстро определить лучший подход для ваших потребностей в документации:

​
Ментальная модель

ИнструментМентальная модель
@DocsКак просмотр и чтение официальной документации
@WebКак поиск решений в интернете
MCPКак доступ к вашей внутренней документации

​
Публичная документация

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

​
Использование @Docs

@Docs подключает Cursor к официальной документации популярных инструментов и фреймворков. Используйте его, когда вам нужна актуальная, авторитетная информация о:
  • Справочники API: Сигнатуры функций, параметры, типы возвращаемых значений
  • Руководства по началу работы: Настройка, конфигурация, базовое использование
  • Лучшие практики: Рекомендуемые паттерны от источника
  • Отладка, специфичная для фреймворка: Официальные руководства по устранению неполадок
@
@Docs Next.js Как настроить динамическую маршрутизацию с catch-all маршрутами?
∞
Agent⌘I
Auto

​
Использование @Web

@Web ищет в живом интернете актуальную информацию, блог-посты и обсуждения сообщества. Используйте его, когда вам нужны:
  • Свежие руководства: Контент и примеры, созданные сообществом
  • Сравнения: Статьи, сравнивающие различные подходы
  • Последние обновления: Очень свежие обновления или объявления
  • Множественные перспективы: Различные подходы к решению проблем
@
@Web последние оптимизации производительности для React 19
∞
Agent⌘I
Auto

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

Внутренняя документация включает информацию, специфичную для вашей организации, с которой модели ИИ никогда не сталкивались во время обучения. Это может быть:
  • Внутренние API: Пользовательские сервисы и микросервисы
  • Корпоративные стандарты: Соглашения по кодированию, архитектурные паттерны
  • Проприетарные системы: Пользовательские инструменты, базы данных, рабочие процессы
  • Доменные знания: Бизнес-логика, требования соответствия

​
Доступ к внутренней документации с помощью MCP

Model Context Protocol (MCP) предоставляет стандартизированный способ подключения вашей приватной документации и систем к Cursor. MCP выступает в качестве тонкого слоя между Cursor и вашими внутренними ресурсами. Почему MCP важен:
  • Модели не могут угадать ваши внутренние соглашения
  • Документация API для пользовательских сервисов недоступна публично
  • Бизнес-логика и знания предметной области уникальны для вашей организации
  • Требования к соответствию и безопасности различаются в зависимости от компании

​
Распространенные интеграции MCP

ИнтеграцияДоступПримеры
ConfluenceКорпоративные пространства ConfluenceДокументация архитектуры, спецификации API для внутренних сервисов, стандарты кодирования и руководства, процессная документация
Google DriveОбщие документы и папкиДокументы спецификаций, заметки встреч и записи решений, проектные документы и требования, базы знаний команды
NotionБазы данных и страницы рабочего пространстваДокументация проектов, командные вики, базы знаний, требования к продукту, технические спецификации
ПользовательскиеВнутренние системы и базы данныхПроприетарные API, устаревшие системы документации, пользовательские базы знаний, специализированные инструменты и рабочие процессы

​
Пользовательские решения

Для уникальных потребностей вы можете создать пользовательские MCP-серверы, которые:
  • Сканируют внутренние веб-сайты или порталы
  • Подключаются к проприетарным базам данных
  • Получают доступ к пользовательским системам документации
  • Извлекают данные из внутренних вики или баз знаний
Если вы создаете пользовательский MCP-сервер, вы также можете предоставить инструменты для Cursor для обновления документации
Пример пользовательского MCP-сервера для сканирования внутренней документации: 
import { McpServer, ResourceTemplate } from "@modelcontextprotocol/sdk/server/mcp.js";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
import { z } from "zod";
import TurndownService from "turndown";

// Создание MCP-сервера для сканирования внутренней документации
const server = new McpServer({
  name: "internal-docs",
  version: "1.0.0"
});

const turndownService = new TurndownService();

// Добавление инструмента для сканирования внутренней документации
server.tool("get_doc",
  { url: z.string() },
  async ({ url }) => {
    try {
      const response = await fetch(url);
      const html = await response.text();
      
      // Преобразование HTML в markdown
      const markdown = turndownService.turndown(html);
      
      return {
        content: [{ type: "text", text: markdown }]
      };
    } catch (error) {
      return {
        content: [{ type: "text", text: `Ошибка сканирования ${url}: ${error.message}` }]
      };
    }
  }
);

// Начало получения сообщений через stdin и отправки сообщений через stdout
const transport = new StdioServerTransport();
await server.connect(transport);

​
Поддержание документации в актуальном состоянии

Документация быстро устаревает. Cursor может помочь вам поддерживать актуальную и полезную документацию, генерируя и обновляя её на основе вашего реального кода и разговоров о разработке.

​
Из существующего кода

Используйте Cursor для создания документации непосредственно из вашей кодовой базы:
@
Создайте документацию API для этого Express роутера, включая все эндпоинты, параметры и форматы ответов
∞
Agent⌘I
Auto

​
Из чат-сессий

Ваши разговоры с Cursor содержат ценную информацию, которую можно превратить в документацию.
После решения сложной проблемы:
@
Обобщи наш разговор о настройке аутентификации в пошаговое руководство для командной вики
∞
Agent⌘I
Auto

​
Выводы

  • Документация как контекст делает Cursor более точным и актуальным
  • Используйте @Docs для официальной документации и @Web для знаний сообщества
  • MCP устраняет разрыв между Cursor и вашими внутренними системами
  • Генерируйте документацию из кода и разговоров, чтобы поддерживать знания в актуальном состоянии
  • Объединяйте внешние и внутренние источники документации для всестороннего понимания