Por que a documentação é importante
- APIs e parâmetros atuais
- Boas práticas
- Convenções da organização
- Terminologia do domínio
Data-limite de conhecimento do modelo
- 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
Qual ferramenta usar?
Modelo mental
Ferramenta | Modelo mental |
---|---|
@Docs | Como navegar e ler a documentação oficial |
@Web | Como buscar soluções na internet |
MCP | Como acessar tua documentação interna |
Documentação pública
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
- 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
- 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ção | Acesso | Exemplos |
---|---|---|
Confluence | Spaces do Confluence da empresa | Documentação de arquitetura, especificações de API de serviços internos, padrões e diretrizes de código, documentação de processos |
Google Drive | Documentos e pastas compartilhados | Documentos de especificação, notas de reunião e registros de decisão, documentos e requisitos de design, bases de conhecimento do time |
Notion | Bancos de dados e páginas do workspace | Documentação de projeto, wikis de time, 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 customizadas, ferramentas e fluxos de trabalho especializados |
Soluções customizadas
- 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
Mantendo a documentação atualizada
A partir de código existente
@
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
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