A Maneira Correta de Usar o CLAUDE.md
A Maneira Correta de Usar o CLAUDE.md
CLAUDE.md é um arquivo especial colocado no diretório raiz do projeto, usado para informar ao assistente de IA (como o Claude) sobre as informações cruciais do seu projeto. Escrever este arquivo corretamente permite que a IA entenda e ajude você melhor.
Por que preciso de um CLAUDE.md?
Imagine que você tem um novo colega. Quanto tempo você precisa para fazê-lo entender seu projeto? CLAUDE.md é o "manual do projeto", permitindo que a IA comece rapidamente.
Os Cinco Conteúdos Essenciais do CLAUDE.md
1. Visão Geral do Projeto
Descreva brevemente o que este projeto faz, quais problemas ele resolve e para quais usuários ele é direcionado.
# Visão Geral do Projeto Este é um sistema de gerenciamento de back-end de comércio eletrônico para gerenciar produtos, pedidos e usuários.
2. Stack de Tecnologia
Liste as principais tecnologias e frameworks usados pelo projeto.
`# Stack de Tecnologia
- Frontend: React + TypeScript
- Backend: Node.js + Express
- Banco de Dados: PostgreSQL
- Implantação: Docker + Kubernetes`
3. Estrutura de Arquivos
Explique a função dos principais diretórios.
# Estrutura de Arquivos /src /components - Componentes de UI /pages - Páginas /utils - Funções utilitárias /api - Chamadas de API
4. Comandos Comuns
Liste os comandos comumente usados no desenvolvimento.
# Comandos Comuns npm run dev - Inicia o servidor de desenvolvimento npm run build - Constrói a versão de produção npm run test - Executa os testes
5. Regras
Defina as regras que a IA deve seguir ao ajudá-lo a escrever código.
`# Regras de Codificação
- Use componentes funcionais
- Siga a configuração do ESLint
- Use PascalCase para nomes de componentes
- Use camelCase para nomes de variáveis`
Um Exemplo Completo
`# Nome do Projeto: Task Manager
Visão Geral do Projeto
Um aplicativo simples de gerenciamento de tarefas que suporta a criação, edição, exclusão e categorização de tarefas.
Stack de Tecnologia
- React 18
- TypeScript
- Tailwind CSS
- Vite
Estrutura de Arquivos
/src /components - Componentes de UI /hooks - Hooks personalizados /types - Definições de tipo TypeScript /utils - Funções utilitárias
Comandos Comuns
- npm run dev: Inicia o servidor de desenvolvimento
- npm run build: Constrói a versão de produção
- npm run lint: Verificação de código
Padrões de Codificação
- Use escrita funcional para componentes
- Use Tailwind CSS para estilos
- Coloque cada componente em uma pasta separada`
Dicas
- Mantenha a simplicidade: não escreva muito, a IA também vai "se cansar"
- Atualize regularmente: lembre-se de atualizar o CLAUDE.md quando o projeto mudar
- Priorize exemplos: dar exemplos de código específicos é mais eficaz do que descrições abstratas
- Concentre-se nos pontos problemáticos: explique os lugares onde é fácil cometer erros
Escreva um bom CLAUDE.md e deixe a IA se tornar seu assistente útil!
