Guia CLAUDE.md

Escreva o CLAUDE.md ideal

CLAUDE.md e o arquivo que define como o Claude entende seu projeto. Um arquivo bem escrito significa menos correcoes, codigo melhor e agentes que realmente sabem no que estao trabalhando.

Este guia percorre cada secao de um arquivo CLAUDE.md, desde declaracoes de stack tecnico ate instrucoes especificas por agente. Acompanhe passo a passo e construa o seu.

O que e CLAUDE.md?

CLAUDE.md e um arquivo markdown que voce coloca na raiz do seu projeto. Quando o Claude Code inicia uma sessao, ele le esse arquivo primeiro. Tudo que esta nele se torna parte do contexto do Claude: seu stack tecnico, sua estrutura de arquivos, as convencoes da sua equipe e qualquer instrucao que voce queira que cada agente siga.

Pense nele como um documento de briefing. Sem ele, o Claude precisa adivinhar como seu projeto esta organizado. Com um bom CLAUDE.md, o Claude ja sabe onde as coisas ficam, quais padroes seguir e o que evitar. A diferenca na qualidade dos resultados e significativa.

Investir 10 minutos no CLAUDE.md economiza horas corrigindo codigo gerado por IA que nao corresponde aos padroes 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

  • Instrucoes vagas como "use boas praticas" sem detalhes
  • Sem mapa de arquivos; o Claude adivinha onde colocar codigo novo
  • Convencoes ausentes; o estilo varia entre sessoes
  • Sem comandos de build ou test, levando a sugestoes quebradas

CLAUDE.md solido

  • Stack tecnico explicito com versoes: React 19, Vite 6, Zustand 5, Tailwind 4
  • Mapa claro de diretorios e seus propositos
  • Padroes de nomenclatura, tratamento de erros e preferencias de estilo documentados
  • Comandos de build, test e dev prontos para copiar e executar

6 secoes essenciais

Um CLAUDE.md bem estruturado cobre essas seis areas. Cada uma fornece ao Claude informacoes concretas que ele pode usar imediatamente.

Declaracao do stack tecnico

Liste seus frameworks, bibliotecas e versoes de forma explicita. Inclua seu gerenciador de pacotes, versao do Node e quaisquer requisitos de execucao. O Claude usa isso para gerar codigo compativel sem adivinhar.

Mapa da estrutura de arquivos

Descreva seus diretorios principais e o que cada um contem. Componentes, stores, servicos, rotas de API, tipos. Um diagrama de arvore curto com uma linha de descricao por pasta funciona bem.

Convencoes de codigo

Documente seus padroes de nomenclatura (camelCase para arquivos, PascalCase para componentes), sua abordagem de tratamento de erros, a ordem dos imports e qualquer regra especifica do projeto. Isso mantem a saida do Claude consistente com seu codigo 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 usara exatamente os comandos que seu projeto espera.

Instrucoes por papel de agente

Se voce usa varios agentes (QA, frontend, backend, DevOps), adicione uma secao descrevendo o foco de cada papel. Isso e especialmente util com a configuracao multi-agente do AgentsRoom.

Areas a evitar

Diga ao Claude o que NAO fazer. Nao modificar arquivos de configuracao, nao mexer no sistema de autenticacao, nao refatorar a camada de banco de dados. Limites explicitos impedem que os agentes facam mudancas indesejadas.

Construa seu CLAUDE.md em 4 passos

Nao precisa escrever tudo de uma vez. Comece pelo basico e expanda conforme voce 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 versoes. Verifique os requisitos de execucao (versao do Node, versao do Python, banco de dados). Isso se torna sua secao de stack tecnico.

package.json + versoes runtime + banco de dados

2

Mapeie sua arvore de arquivos

Execute um tree rapido do seu diretorio src. Identifique as pastas de primeiro nivel e escreva uma descricao de uma linha para cada uma. Foque em onde ficam os componentes, stores, servicos, tipos e rotas de API.

Arvore src/ com anotacoes de proposito

3

Documente suas convencoes

Observe seu codigo existente e anote os padroes: como voce nomeia arquivos, como trata erros, como estrutura imports, se usa exports padrao ou nomeados. Escreva-os como regras curtas.

Nomenclatura, imports, tratamento de erros, exports

4

Adicione secoes por agente

Se voce trabalha com agentes especializados, adicione areas 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.

Areas de foco + areas a evitar por papel

Por que o AgentsRoom para CLAUDE.md?

AgentsRoom foi construido com o CLAUDE.md como conceito central, nao como algo secundario.

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.

Visualizacao ao vivo por agente

Veja como cada agente interpreta seu CLAUDE.md em tempo real. Observe a saida do terminal para verificar que os agentes seguem suas convencoes e respeitam suas areas a evitar.

Contexto por projeto

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

Integracao com papeis de agentes

Os 14 papeis de agentes do AgentsRoom se combinam diretamente com as secoes do CLAUDE.md. Defina areas de foco e areas a evitar por papel, e cada agente pega exatamente as instrucoes destinadas a ele.

FAQ sobre CLAUDE.md

Onde devo colocar meu arquivo CLAUDE.md?+
Coloque-o na raiz do diretorio do seu projeto, ao lado do seu package.json ou arquivo de configuracao equivalente. O Claude Code o le automaticamente ao iniciar uma sessao naquele diretorio. Voce tambem pode ter arquivos CLAUDE.md aninhados em subdiretorios para contexto mais especifico.
Qual deve ser o tamanho de um CLAUDE.md?+
Nao ha um limite rigido, mas mire entre 50 e 300 linhas. Cubra o essencial: stack tecnico, estrutura de arquivos, convencoes e comandos. Curto demais e o Claude carece de contexto. Longo demais e voce arrisca diluir o importante com ruido.
CLAUDE.md funciona com todos os modelos do Claude?+
Sim. O CLAUDE.md e lido pelo Claude Code independente do modelo selecionado (Opus, Sonnet ou Haiku). Todos os modelos se beneficiam de contexto de projeto explicito, embora modelos maiores como o Opus consigam absorver e aplicar instrucoes mais detalhadas.
Devo fazer commit do CLAUDE.md no controle de versao?+
Sim, para instrucoes de projeto compartilhadas. Sua equipe se beneficia de um comportamento de IA consistente entre todos os desenvolvedores. Para preferencias pessoais, o AgentsRoom suporta configuracoes de agentes pessoais que sao automaticamente adicionadas ao gitignore.
Posso usar CLAUDE.md com configuracoes multi-agente?+
Com certeza. No AgentsRoom, cada agente do seu projeto le o mesmo CLAUDE.md. Voce pode adicionar secoes especificas por papel (por exemplo, notas para o agente QA vs. o agente frontend) para que cada especialista receba instrucoes direcionadas.
Com que frequencia devo atualizar meu CLAUDE.md?+
Atualize-o sempre que a estrutura ou convencoes do seu projeto mudarem. Adicionou um novo framework? Atualize o stack tecnico. Mudou a organizacao dos diretorios? Atualize o mapa de arquivos. Um CLAUDE.md desatualizado leva a sugestoes desatualizadas.

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 instrucoes, codigo melhor.

Baixar AgentsRoom

Gratis para sempre. Traga sua propria API key.