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

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

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

Большие языковые модели обучаются на данных лишь до определённого момента, который называется «knowledge cutoff» (дата отсечения знаний). Это значит:
  • Недавние обновления библиотек могут не учитываться
  • Новые фреймворки или инструменты могут быть неизвестны
  • Изменения 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 много полезных идей, которые можно превратить в документацию.
После решения сложной задачи:
@
Суммируй нашу беседу о настройке аутентификации и оформи пошаговое руководство для вики команды
Agent⌘I
Auto

Главное

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