Skip to main content
O Claude Code é a ferramenta CLI oficial da Anthropic. Este guia ajudará você a configurar o Claude Code para ajudá-lo a escrever e manter sua documentação.

​
Pré-requisitos

  • Assinatura ativa do Claude (Pro, Max ou acesso à API)

​
Configuração

  1. Instale o Claude Code globalmente:
npm install -g @anthropic-ai/claude-code
  1. Navegue até o diretório da sua documentação.
  2. (Opcional) Adicione o arquivo CLAUDE.md abaixo ao seu projeto.
  3. Execute claude para começar.

​
Criar CLAUDE.md

Crie um arquivo CLAUDE.md na raiz do seu repositório de documentação para treinar o Claude Code nos seus padrões específicos de documentação: 
# Documentação Mintlify

## Relacionamento de trabalho
- Você pode questionar ideias - isso pode levar a uma documentação melhor. Cite fontes e explique seu raciocínio quando fizer isso
- SEMPRE peça esclarecimentos em vez de fazer suposições
- NUNCA minta, adivinhe ou invente informações

## Contexto do projeto
- Formato: Arquivos MDX com frontmatter YAML
- Config: docs.json para navegação, tema, configurações
- Componentes: Componentes Mintlify

## Estratégia de conteúdo
- Documente apenas o suficiente para o sucesso do usuário - nem muito, nem pouco
- Priorize a precisão e a usabilidade das informações
- Torne o conteúdo perene quando possível
- Procure informações existentes antes de adicionar novo conteúdo. Evite duplicação, a menos que seja feito por uma razão estratégica
- Verifique padrões existentes para consistência
- Comece fazendo as menores alterações razoáveis

## Requisitos de frontmatter para páginas
- title: Título de página claro e descritivo
- description: Resumo conciso para SEO/navegação

## Padrões de escrita
- Voz em segunda pessoa ("você")
- Pré-requisitos no início do conteúdo procedural
- Teste todos os exemplos de código antes de publicar
- Corresponda ao estilo e formatação das páginas existentes
- Inclua casos de uso básicos e avançados
- Tags de idioma em todos os blocos de código
- Texto alternativo em todas as imagens
- Caminhos relativos para links internos

## Fluxo de trabalho Git
- NUNCA use --no-verify ao fazer commit
- Pergunte como lidar com alterações não commitadas antes de começar
- Crie um novo branch quando não houver um branch claro para alterações
- Faça commit frequentemente durante o desenvolvimento
- NUNCA pule ou desabilite hooks de pre-commit

## Não faça
- Pule frontmatter em qualquer arquivo MDX
- Use URLs absolutas para links internos
- Inclua exemplos de código não testados
- Faça suposições - sempre peça esclarecimentos