Claude Code é uma ferramenta de linha de comando com agentes que pode ajudar você a manter sua documentação. Ela pode criar novos conteúdos, revisar páginas existentes e manter a documentação atualizada. Você pode treinar o Claude Code para entender seus padrões e fluxos de trabalho de documentação adicionando um arquivo CLAUDE.md ao seu projeto e refinindo-o ao longo do tempo.

​
Primeiros passos

Pré-requisitos:
  • Assinatura ativa do Claude (Pro, Max ou acesso à API)
Configuração:
  1. Instale o Claude Code:
  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.

​
Modelo de CLAUDE.md

Salve um arquivo CLAUDE.md na raiz do diretório de documentação para ajudar o Claude Code a entender seu projeto. Este arquivo treina o Claude Code sobre seus padrões, preferências e fluxos de trabalho de documentação. Consulte Gerenciar a memória do Claude na documentação da Anthropic para mais informações. Copie este modelo de exemplo ou adapte-o às especificações da sua documentação: 
# Documentação da Mintlify

## Relação de trabalho
- Você pode contestar 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, chute ou invente informações

## Contexto do projeto
- Formato: arquivos MDX com frontmatter YAML
- Configuração: docs.json para navegação, tema e configurações
- Componentes: Componentes (Mintlify)

## Estratégia de conteúdo
- Documente o suficiente para o sucesso do usuário — nem demais, nem de menos
- Priorize a precisão e a usabilidade das informações
- Torne o conteúdo perene sempre que possível
- Busque informações existentes antes de adicionar novo conteúdo. Evite duplicações, a menos que haja motivo estratégico
- Verifique padrões existentes para manter a consistência
- Comece fazendo as menores mudanças razoáveis

## docs.json

- Consulte o [esquema do docs.json](https://mintlify.com/docs.json) ao criar o arquivo docs.json e a navegação do site

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

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

## Fluxo de trabalho com Git
- NUNCA use --no-verify ao fazer commits
- Pergunte como lidar com mudanças não commitadas antes de começar
- Crie uma nova branch quando não houver uma clara para as mudanças
- Faça commits com frequência ao longo do desenvolvimento
- NUNCA ignore ou desative hooks de pre-commit

## Não faça
- Omitir frontmatter em qualquer arquivo MDX
- Usar URLs absolutas para links internos
- Incluir exemplos de código não testados
- Fazer suposições — sempre peça esclarecimentos

​
Exemplos de prompts

Depois de configurar o Claude Code, experimente estes prompts para ver como ele pode ajudar em tarefas comuns de documentação. Você pode copiar e colar esses exemplos diretamente ou adaptá-los às suas necessidades específicas.

​
Converter anotações em documentação aprimorada

Transforme rascunhos em páginas Markdown bem formatadas, com componentes e frontmatter. Prompt de exemplo: 
Converta este texto em uma página MDX corretamente formatada: [cole seu texto aqui]

​
Revisar a documentação em busca de consistência

Obtenha sugestões para melhorar o estilo, a formatação e o uso de componentes. Exemplo de prompt: 
Review the files in docs/ and suggest improvements for consistency and clarity

​
Atualize a documentação quando os recursos mudarem

Mantenha a documentação atualizada conforme o produto evolui. Prompt de exemplo: 
Nossa API agora exige um parâmetro de versão. Atualize nossa documentação para incluir version=2024-01 em todos os exemplos

​
Gere exemplos de código completos

Crie exemplos em várias linguagens com tratamento de erros. Exemplo de prompt: 
Create code examples for [your API endpoint] in JavaScript, Python, and cURL with error handling

​
Estendendo o Claude Code

Além de solicitar o Claude Code manualmente, você pode integrá-lo aos seus fluxos de trabalho existentes.

​
Automação com GitHub Actions

Execute o Claude Code automaticamente quando houver alterações no código para manter a documentação atualizada. Você pode disparar revisões de documentação em pull requests ou atualizar exemplos quando mudanças na API forem detectadas.

​
Fluxos de trabalho com várias instâncias

Use sessões separadas do Claude Code para tarefas diferentes — uma para redigir novo conteúdo e outra para revisão e controle de qualidade. Isso ajuda a manter a consistência e a detectar problemas que uma única sessão pode não perceber. ---MDX_CONTENTEND---

​
Colaboração em equipe

Compartilhe o arquivo CLAUDE.md aprimorado com sua equipe para garantir padrões de documentação consistentes entre todos os colaboradores. As equipes geralmente desenvolvem prompts e fluxos de trabalho específicos do projeto que passam a fazer parte do processo de documentação.

​
Comandos personalizados

Crie comandos de barra reutilizáveis em .claude/commands/ para tarefas de documentação frequentes, específicas do seu projeto ou equipe.