Trabalhando com Documentação

Como aproveitar a documentação de forma eficaz no Cursor usando prompts, fontes externas e contexto interno

Por que a documentação importa

A documentação fornece contexto atual 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
• Melhores 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 alternar de contexto.

Data de corte do conhecimento do modelo

Modelos de linguagem de grande porte são treinados com dados até um ponto específico no tempo, chamado de “data de corte do conhecimento”. Isso significa:

• Atualizações recentes de bibliotecas podem não estar refletidas
• Novos frameworks ou ferramentas podem ser desconhecidos
• Mudanças de API após a data de corte podem não ser capturadas
• Boas práticas podem ter evoluído desde o treinamento

Por exemplo, se a data de corte do conhecimento de um modelo for no início de 2024, ele não vai saber sobre recursos lançados no fim de 2024, mesmo em frameworks populares.

Qual ferramenta devo usar?

Use esta árvore de decisão para determinar rapidamente a melhor abordagem para tuas necessidades de documentação:

Modelo mental

Ferramenta	Modelo mental
@Docs	Como navegar e ler a documentação oficial
@Web	Como pesquisar soluções na internet
MCP	Como acessar a sua documentação interna

Documentação pública

A documentação externa abrange informações publicamente disponíveis sobre as quais os modelos podem ter conhecimento limitado ou desatualizado. O Cursor oferece duas formas principais de acessar essas informações.

Usando @Docs

@Docs conecta o Cursor à documentação oficial de ferramentas e frameworks populares. Usa quando precisar de informações atuais e confiáveis sobre:

• Referências de API: Assinaturas de funções, parâmetros, tipos de retorno
• Guias de introdução: Setup, configuração, uso básico
• Boas práticas: Padrões recomendados pela fonte oficial
• Depuração específica de framework: Guias oficiais de troubleshooting

@

@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 atuais, postagens de blog e discussões da comunidade. Usa quando você precisar de:

• Tutoriais recentes: Conteúdo e exemplos gerados pela comunidade
• Comparações: Artigos que comparam 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 modelos de IA nunca viram durante o treinamento. Isso pode incluir:

• APIs internas: Serviços customizados e microsserviços
• Padrões da empresa: Convenções de código, padrões de arquitetura
• Sistemas proprietários: Ferramentas customizadas, bancos de dados, fluxos de trabalho
• Conhecimento de domínio: Regras de negócio, requisitos de conformidade

Acessando docs internas com MCP

O Model Context Protocol (MCP) fornece uma forma padronizada de trazer tua documentação e sistemas privados para o Cursor. O MCP atua como uma camada fina entre o Cursor e teus recursos internos.

Por que o MCP é importante:

• Modelos não conseguem adivinhar tuas convenções internas
• A documentação de API para serviços personalizados não é publicamente disponível
• Regras de negócio e conhecimento de domínio são exclusivos da tua organização
• Requisitos de conformidade e segurança variam de empresa para empresa

Integrações MCP comuns

Integração	Acesso	Exemplos
Confluence	Spaces do Confluence da empresa	Documentação de arquitetura, especificações de API para serviços internos, padrões e diretrizes de codificação, documentação de processos
Google Drive	Documentos e pastas compartilhadas	Documentos de especificação, notas de reunião e registros de decisão, documentos e requisitos de design, bases de conhecimento da equipe
Notion	Bancos de dados e páginas do workspace	Documentação de projetos, wikis de equipe, bases de conhecimento, requisitos de produto, especificações técnicas
Custom	Sistemas e bancos de dados internos	APIs proprietárias, sistemas legados de documentação, bases de conhecimento personalizadas, ferramentas e fluxos de trabalho especializados

Soluções personalizadas

Para necessidades específicas, tu podes criar servidores MCP personalizados que:

• Fazem scraping de sites ou portais internos
• Conectam a bancos de dados proprietários
• Acessam sistemas de documentação personalizados
• Extraem de wikis internos ou bases de conhecimento

Se tu construíres um servidor MCP personalizado, também podes expor ferramentas para o Cursor atualizar a documentação

Exemplo de servidor MCP personalizado para fazer scraping de docs internas:

TypeScript

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 rapidamente. O Cursor pode te ajudar a manter a documentação atual e útil, gerando e atualizando-a com base no teu código real e nas tuas conversas de desenvolvimento.

A partir de código existente

Usa o Cursor pra criar documentação direto do teu codebase:

API Documentation

@

Generate API documentation for this Express router, including all endpoints, parameters, and response formats

∞

Agent⌘I

Auto

↑

De sessões de chat

Suas conversas com o Cursor contêm intenção valiosa que pode virar documentação.

Resolução de Problemas

Depois de resolver um problema complexo:

@

Resume nossa conversa sobre configurar autenticação em um guia passo a passo para o wiki do time

∞

Agent⌘I

Auto

↑

Principais pontos

• Usar 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 faz a ponte entre o Cursor e teus sistemas internos
• Gera documentação a partir do código e de conversas para manter o conhecimento atualizado
• Combina fontes de documentação externas e internas para uma compreensão abrangente