Por que a documentação é importante

A documentação fornece contexto atualizado e preciso. Sem ela, os modelos usam dados de treinamento desatualizados ou incompletos. A documentação ajuda os modelos a entender coisas como:
  • APIs e parâmetros atuais
  • Boas práticas
  • Convenções da organização
  • Terminologia do domínio
E muito mais. Continua lendo pra aprender como usar a documentação direto no Cursor sem precisar trocar de contexto.

Data-limite de conhecimento do modelo

Modelos de linguagem de grande porte são treinados com dados até um momento específico no tempo, chamado de “data-limite de conhecimento”. Isso significa:
  • Atualizações recentes de bibliotecas podem não estar refletidas
  • Novos frameworks ou ferramentas podem ser desconhecidos
  • Alterações de APIs após a data-limite podem passar despercebidas
  • As melhores práticas podem ter evoluído desde o treinamento
Por exemplo, se a data-limite de conhecimento de um modelo for no início de 2024, ele não vai saber sobre recursos lançados no final de 2024, mesmo em frameworks populares.

Qual ferramenta usar?

Usa essa árvore de decisão pra determinar rapidinho a melhor abordagem pras tuas necessidades de documentação:

Modelo mental

FerramentaModelo mental
@DocsComo navegar e ler a documentação oficial
@WebComo buscar soluções na internet
MCPComo acessar tua documentação interna

Documentação pública

A documentação externa aborda informações públicas sobre as quais os modelos podem ter conhecimento limitado ou desatualizado. O Cursor oferece duas maneiras principais de acessar essas informações.

Usando @Docs

@Docs conecta o Cursor à documentação oficial de ferramentas e frameworks populares. Usa quando tu precisa de informações atuais e confiáveis sobre:
  • Referências de API: Assinaturas de funções, parâmetros, tipos de retorno
  • Guias de primeiros passos: Instalação, configuração, uso básico
  • Boas práticas: Padrões recomendados pela fonte
  • Depuração específica de framework: Guias oficiais de solução de problemas
@
@Docs Next.js How do I set up dynamic routing with catch-all routes?
Agent⌘I
Auto

Usando @Web

@Web pesquisa a internet em tempo real por informações atualizadas, posts de blog e discussões da comunidade. Usa quando precisar de:
  • Tutoriais recentes: conteúdo gerado pela comunidade e exemplos
  • Comparações: artigos comparando diferentes abordagens
  • Atualizações recentes: atualizações ou anúncios bem recentes
  • Múltiplas perspectivas: diferentes maneiras de abordar problemas
@
@Web latest performance optimizations for React 19
Agent⌘I
Auto

Documentação interna

A documentação interna inclui informações específicas da tua organização que os modelos de IA não viram durante o treinamento. Isso pode incluir:
  • APIs internas: Serviços e microsserviços personalizados
  • Padrões da empresa: Convenções de código, padrões de arquitetura
  • Sistemas proprietários: Ferramentas, bancos de dados e fluxos de trabalho personalizados
  • Conhecimento do domínio: Regras de negócio, requisitos de conformidade

Acessando docs internas com MCP

O Model Context Protocol (MCP) oferece uma forma padronizada de trazer tuas documentações e sistemas privados pro Cursor. O MCP funciona como uma camada fina entre o Cursor e teus recursos internos. Por que o MCP importa:
  • Modelos não adivinham tuas convenções internas
  • Documentação de API de serviços customizados não é pública
  • Lógica de negócios e conhecimento de domínio são específicos da tua organização
  • Requisitos de conformidade e segurança variam de empresa pra empresa

Integrações MCP comuns

IntegraçãoAcessoExemplos
ConfluenceSpaces do Confluence da empresaDocumentação de arquitetura, especificações de API de serviços internos, padrões e diretrizes de código, documentação de processos
Google DriveDocumentos e pastas compartilhadosDocumentos de especificação, notas de reunião e registros de decisão, documentos e requisitos de design, bases de conhecimento do time
NotionBancos de dados e páginas do workspaceDocumentação de projeto, wikis de time, bases de conhecimento, requisitos de produto, especificações técnicas
CustomSistemas e bancos de dados internosAPIs proprietárias, sistemas legados de documentação, bases de conhecimento customizadas, ferramentas e fluxos de trabalho especializados

Soluções customizadas

Pra necessidades específicas, tu pode criar servidores MCP customizados que:
  • Fazem scraping de sites ou portais internos
  • Conectam a bancos de dados proprietários
  • Acessam sistemas de documentação customizados
  • Buscam conteúdo em wikis internas ou bases de conhecimento
Se tu criar um servidor MCP customizado, tu também pode expor ferramentas pro Cursor atualizar a documentação
Exemplo de servidor MCP customizado pra fazer scraping de docs internas:
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);

Mantendo a documentação atualizada

A documentação fica desatualizada rápido. O Cursor ajuda a manter a documentação atual e útil, gerando e atualizando com base no teu código real e nas conversas de desenvolvimento.

A partir de código existente

Usa o Cursor pra criar documentação direto do teu código:
@
Gera a documentação da API para este router do Express, incluindo todos os endpoints, parâmetros e formatos de resposta
Agent⌘I
Auto

De sessões de chat

Suas conversas com o Cursor têm muita informação útil que dá para virar documentação.
Depois de resolver um problema complexo:
@
Resume nossa conversa sobre a configuração de autenticação em um guia passo a passo para o wiki do time
Agent⌘I
Auto

Principais pontos

  • Usar a documentação como contexto deixa o Cursor mais preciso e atualizado
  • Usa @Docs para a documentação oficial e @Web para o conhecimento da comunidade
  • MCP conecta o Cursor aos teus sistemas internos
  • Gera documentação a partir do código e das conversas para manter o conhecimento atualizado
  • Combina fontes de documentação externas e internas para uma compreensão completa