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

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

Дата отсечения знаний модели

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

Какой инструмент выбрать?

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

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

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

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

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

Использование @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

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

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

ИнтеграцияДоступПримеры
ConfluenceКорпоративные пространства ConfluenceАрхитектурная документация, спецификации API для внутренних сервисов, стандарты и рекомендации по кодингу, процессная документация
Google DriveОбщие документы и папкиСпецификации, заметки встреч и записи решений, дизайн-документы и требования, командные базы знаний
NotionБазы данных и страницы рабочего пространстваПроектная документация, командные вики, базы знаний, продуктовые требования, технические спецификации
CustomВнутренние системы и базы данныхПроприетарные 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";

// Create an MCP server for scraping internal docs
const server = new McpServer({
  name: "internal-docs",
  version: "1.0.0"
});

const turndownService = new TurndownService();

// Add tool to scrape internal documentation
server.tool("get_doc",
  { url: z.string() },
  async ({ url }) => {
    try {
      const response = await fetch(url);
      const html = await response.text();
      
      // Convert HTML to markdown
      const markdown = turndownService.turndown(html);
      
      return {
        content: [{ type: "text", text: markdown }]
      };
    } catch (error) {
      return {
        content: [{ type: "text", text: `Error scraping ${url}: ${error.message}` }]
      };
    }
  }
);

// Start receiving messages on stdin and sending messages on stdout
const transport = new StdioServerTransport();
await server.connect(transport);

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

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

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

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

Из чатов

Твои разговоры с Cursor содержат ценные намерения, которые можно превратить в документацию.
После решения сложной задачи:
@
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 с твоими внутренними системами
  • Генерируй документацию из кода и диалогов, чтобы поддерживать знания в актуальном состоянии
  • Комбинируй внешнюю и внутреннюю документацию для более полного понимания