Guia CLAUDE.md

Escreva o CLAUDE.md ideal

CLAUDE.md é o arquivo que define como o Claude entende seu projeto. Um arquivo bem escrito significa menos correções, código melhor e agentes que realmente sabem no que estão trabalhando.

Este guia percorre cada seção de um arquivo CLAUDE.md, desde declarações de stack técnico até instruções específicas por agente. Acompanhe passo a passo e construa o seu.

O que é CLAUDE.md?

CLAUDE.md é um arquivo markdown que você coloca na raiz do seu projeto. Quando o Claude Code inicia uma sessão, ele lê esse arquivo primeiro. Tudo que está nele se torna parte do contexto do Claude: seu stack técnico, sua estrutura de arquivos, as convenções da sua equipe e qualquer instrução que você queira que cada agente siga.

Pense nele como um documento de briefing. Sem ele, o Claude precisa adivinhar como seu projeto está organizado. Com um bom CLAUDE.md, o Claude já sabe onde as coisas ficam, quais padrões seguir e o que evitar. A diferença na qualidade dos resultados é significativa.

“Investir 10 minutos no CLAUDE.md economiza horas corrigindo código gerado por IA que não corresponde aos padrões do seu projeto.”

Observado em centenas de projetos Claude Code

CLAUDE.md ruim vs. bom

A estrutura e a especificidade do seu CLAUDE.md impactam diretamente na qualidade do trabalho do Claude na sua codebase.

CLAUDE.md fraco

  • ✗Instruções vagas como "use boas práticas" sem detalhes
  • ✗Sem mapa de arquivos; o Claude adivinha onde colocar código novo
  • ✗Convenções ausentes; o estilo varia entre sessões
  • ✗Sem comandos de build ou test, levando a sugestões quebradas

CLAUDE.md sólido

  • ✓Stack técnico explícito com versões: React 19, Vite 6, Zustand 5, Tailwind 4
  • ✓Mapa claro de diretórios e seus propósitos
  • ✓Padrões de nomenclatura, tratamento de erros e preferências de estilo documentados
  • ✓Comandos de build, test e dev prontos para copiar e executar

6 seções essenciais

Um CLAUDE.md bem estruturado cobre essas seis áreas. Cada uma fornece ao Claude informações concretas que ele pode usar imediatamente.

Declaração do stack técnico

Liste seus frameworks, bibliotecas e versões de forma explícita. Inclua seu gerenciador de pacotes, versão do Node e quaisquer requisitos de execução. O Claude usa isso para gerar código compatível sem adivinhar.

Mapa da estrutura de arquivos

Descreva seus diretórios principais e o que cada um contém. Componentes, stores, serviços, rotas de API, tipos. Um diagrama de árvore curto com uma linha de descrição por pasta funciona bem.

Convenções de código

Documente seus padrões de nomenclatura (camelCase para arquivos, PascalCase para componentes), sua abordagem de tratamento de erros, a ordem dos imports e qualquer regra específica do projeto. Isso mantém a saída do Claude consistente com seu código existente.

Comandos de build e test

Inclua seus comandos de dev, build, test e lint. Quando o Claude precisar verificar que algo funciona ou sugerir um script, ele usará exatamente os comandos que seu projeto espera.

Instruções por papel de agente

Se você usa vários agentes (QA, frontend, backend, DevOps), adicione uma seção descrevendo o foco de cada papel. Isso é especialmente útil com a configuração multi-agente do AgentsRoom.

Áreas a evitar

Diga ao Claude o que NÃO fazer. Não modificar arquivos de configuração, não mexer no sistema de autenticação, não refatorar a camada de banco de dados. Limites explícitos impedem que os agentes façam mudanças indesejadas.

Construa seu CLAUDE.md em 4 passos

Não precisa escrever tudo de uma vez. Comece pelo básico e expanda conforme você descobre o que o Claude precisa saber.

1

Audite seu projeto

Abra seu package.json e liste cada framework, biblioteca e ferramenta que seu projeto usa. Anote as versões. Verifique os requisitos de execução (versão do Node, versão do Python, banco de dados). Isso se torna sua seção de stack técnico.

package.json + versões runtime + banco de dados

2

Mapeie sua árvore de arquivos

Execute um tree rápido do seu diretório src. Identifique as pastas de primeiro nível e escreva uma descrição de uma linha para cada uma. Foque em onde ficam os componentes, stores, serviços, tipos e rotas de API.

Árvore src/ com anotações de propósito

3

Documente suas convenções

Observe seu código existente e anote os padrões: como você nomeia arquivos, como trata erros, como estrutura imports, se usa exports padrão ou nomeados. Escreva-os como regras curtas.

Nomenclatura, imports, tratamento de erros, exports

4

Adicione seções por agente

Se você trabalha com agentes especializados, adicione áreas de foco para cada papel. O agente frontend deve conhecer sua biblioteca de componentes. O agente DevOps deve conhecer seu pipeline de deploy. O agente QA deve conhecer seu framework de testes.

Áreas de foco + áreas a evitar por papel

Por que o AgentsRoom para CLAUDE.md?

AgentsRoom foi construído com o CLAUDE.md como conceito central, não como algo secundário.

Editor CLAUDE.md integrado

Edite seu CLAUDE.md diretamente no AgentsRoom com destaque de sintaxe e salvamento em tempo real. Sem precisar trocar para seu editor de texto ou IDE.

Visualização ao vivo por agente

Veja como cada agente interpreta seu CLAUDE.md em tempo real. Observe a saída do terminal para verificar que os agentes seguem suas convenções e respeitam suas áreas a evitar.

Contexto por projeto

Cada projeto no AgentsRoom tem seu próprio CLAUDE.md. Alterne entre projetos e cada agente carrega automaticamente o arquivo de contexto correto para aquela codebase.

Integração com papéis de agentes

Os 14 papéis de agentes do AgentsRoom se combinam diretamente com as seções do CLAUDE.md. Defina áreas de foco e áreas a evitar por papel, e cada agente pega exatamente as instruções destinadas a ele.

Watch what your CLAUDE.md does to Claude Code token usage

CLAUDE.md is prepended to every Claude turn. A bloated CLAUDE.md silently inflates Claude Code token usage on every message. AgentsRoom puts a per-session token meter on each agent so you can see exactly how much your CLAUDE.md is costing you, with a live cache hit rate to confirm it stays cached.

See the Claude Code token usage tracker

FAQ sobre CLAUDE.md

Onde devo colocar meu arquivo CLAUDE.md?+
Coloque-o na raiz do diretório do seu projeto, ao lado do seu package.json ou arquivo de configuração equivalente. O Claude Code o lê automaticamente ao iniciar uma sessão naquele diretório. Você também pode ter arquivos CLAUDE.md aninhados em subdiretórios para contexto mais específico.
Qual deve ser o tamanho de um CLAUDE.md?+
Não há um limite rígido, mas mire entre 50 e 300 linhas. Cubra o essencial: stack técnico, estrutura de arquivos, convenções e comandos. Curto demais e o Claude carece de contexto. Longo demais e você arrisca diluir o importante com ruído.
CLAUDE.md funciona com todos os modelos do Claude?+
Sim. O CLAUDE.md é lido pelo Claude Code independente do modelo selecionado (Opus, Sonnet ou Haiku). Todos os modelos se beneficiam de contexto de projeto explícito, embora modelos maiores como o Opus consigam absorver e aplicar instruções mais detalhadas.
Devo fazer commit do CLAUDE.md no controle de versão?+
Sim, para instruções de projeto compartilhadas. Sua equipe se beneficia de um comportamento de IA consistente entre todos os desenvolvedores. Para preferências pessoais, o AgentsRoom suporta configurações de agentes pessoais que são automaticamente adicionadas ao gitignore.
Posso usar CLAUDE.md com configurações multi-agente?+
Com certeza. No AgentsRoom, cada agente do seu projeto lê o mesmo CLAUDE.md. Você pode adicionar seções específicas por papel (por exemplo, notas para o agente QA vs. o agente frontend) para que cada especialista receba instruções direcionadas.
Com que frequência devo atualizar meu CLAUDE.md?+
Atualize-o sempre que a estrutura ou convenções do seu projeto mudarem. Adicionou um novo framework? Atualize o stack técnico. Mudou a organização dos diretórios? Atualize o mapa de arquivos. Um CLAUDE.md desatualizado leva a sugestões desatualizadas.

Para se aprofundar

Comece a escrever arquivos CLAUDE.md melhores

Baixe o AgentsRoom e use o editor CLAUDE.md integrado para dar aos seus agentes o contexto que precisam. Melhores instruções, código melhor.

GrátisBaixar AgentsRoom

App complementar: acompanhe seus agentes em qualquer lugar

Use Claude, Codex, Antigravity CLI ou outro provedor de IA.

Instalar a extensão
Chrome Web Store

Envie bugs e pedidos direto para o seu backlog público.

Multi-projetos
Multi-provedor
Multi-agentes
Status ao vivo
Diff e commit
App mobile
Preview ao vivo
Equipes de agentes
Testes no navegador
Dev guiada por backlog
Biblioteca de prompts
Biblioteca de skills
Ver todas as funcionalidades