Atualizações automáticas da documentação
Saiba como a skill /update-jamdesk do Claude Code transforma mudanças de código voltadas ao usuário em atualizações correspondentes na sua documentação Jamdesk.
A skill /update-jamdesk do Claude Code acompanha as mudanças no seu código e gera atualizações correspondentes na documentação. Execute-a depois de lançar um recurso voltado ao usuário. Ela identifica as páginas de documentação a criar ou editar.
Procurando dicas gerais de escrita com IA? Veja Claude Code para a configuração da ferramenta. Veja Escrever com IA para orientações mais amplas sobre como escrever documentação com ferramentas de IA.
Quando usar
Use quando: você fez mudanças voltadas ao usuário em APIs, comandos da CLI, interface, opções de configuração ou comportamento de componentes.
Ignore quando: refatorações internas, mudanças apenas em testes, configuração de build/CI ou trabalho de desempenho sem mudança de comportamento.
Pré-requisitos
- Claude Code instalado e configurado
- Um projeto de documentação Jamdesk com
docs.json - Opcional: CLI do Jamdesk para verificação (
npm install -g jamdesk)
Início rápido
Crie um arquivo .jamdesk-docs-path no repositório do seu código apontando para a sua documentação:
docs_path: ../my-docsO caminho pode ser relativo (a partir do arquivo de configuração) ou absoluto.
Execute depois de implementar um recurso:
/update-jamdeskO Claude analisa suas mudanças e faz perguntas de esclarecimento antes de escrever a documentação.
Revise a documentação gerada. O Claude a verifica com jamdesk validate e jamdesk broken-links antes do commit.
Formato do arquivo de configuração
O arquivo .jamdesk-docs-path informa ao Claude onde está a sua documentação.
Formato simples, apenas com o caminho:
../my-docs
Formato completo, com opções:
# Path to documentation repository
docs_path: ../my-docs
# Optional: Branch for doc updates (default: main)
docs_branch: mainA skill localiza o arquivo de configuração subindo a partir do diretório atual até a raiz do git. Coloque-o na raiz do seu repositório.
Como funciona
O Claude executa estas etapas para /update-jamdesk:
- Localiza sua documentação: encontra o arquivo de configuração
.jamdesk-docs-path - Faz perguntas: esclarece a estratégia de branch, o escopo e o conteúdo
- Analisa a documentação existente: procura conteúdo relacionado para atualizar ou ampliar
- Escreve a documentação: cria ou atualiza páginas seguindo os padrões do Jamdesk, com exemplos simples primeiro
- Revisa o tom: verifique a saída em busca de enchimento típico de IA. O Claude escreve melhor com um CLAUDE.md que define a voz (veja Claude Code)
- Verifica: executa
jamdesk validateejamdesk broken-links - Faz commit: prepara as mudanças e oferece commit/push/PR
Execute git checkout . antes do commit para reverter todas as edições.
| Cenário | Ação |
|---|---|
| Novo recurso | Criar nova página |
| Mudança de comportamento | Atualizar página existente |
| Pequena adição | Adicionar seção a uma página existente |
| Capacidade principal | Nova página independente |
| Descontinuação/remoção | Atualizar a existente e adicionar notas de migração |
Exemplo de sessão
User: I just added a webhook feature. Can you document it?
Claude: I'm using the update-jamdesk skill to update your documentation.
Found .jamdesk-docs-path: ../customer-docs
How should I handle changes to the docs repository?
1. Create a new feature branch (recommended)
2. Update directly on main
3. Use current branch
User: 1
Claude: Based on the webhook implementation, I plan to:
- Create: webhooks/overview.mdx
- Update: getting-started.mdx (add link)
Any changes to this plan?
User: Looks good
Claude: [Creates documentation...]
✓ jamdesk validate passed
✓ jamdesk broken-links passed
Commit these changes?
Modo de visualização prévia
Execute com --preview para ver o que mudaria sem fazer edições:
/update-jamdesk --preview
O modo de pré-visualização permite:
- Verificar que documentação precisa ser atualizada
- Revisar as mudanças propostas antes do commit
- Ver a análise da skill sem efeitos colaterais
Sugestões proativas
O Claude pode sugerir isto depois que você fizer commit de mudanças de código voltadas ao usuário:
Tip: These changes affect user-facing features.
Run /update-jamdesk to update your documentation.
Isto aparece quando:
- Você tem um arquivo de configuração
.jamdesk-docs-path, E - Seu commit inclui arquivos que correspondem a padrões voltados ao usuário (API, CLI, componentes)
Instalar a skill
Instale a skill /update-jamdesk usando a CLI de skills:
npx skills add jamdesk/skills --skill update-jamdesk
Isto instala a skill em .claude/skills/update-jamdesk/ no seu projeto.
Instala no diretório do projeto atual:
npx skills add jamdesk/skills --skill update-jamdeskA skill fica disponível ao trabalhar neste projeto.
Listar skills disponíveis
Veja todas as skills do Jamdesk:
npx skills add jamdesk/skills --list
Atualizar
Execute o comando de instalação novamente para obter a versão mais recente:
npx skills add jamdesk/skills --skill update-jamdesk
Reinicie o Claude Code ou inicie uma nova sessão depois de instalar ou atualizar.
Solução de problemas
Verifique se o arquivo da skill está em .claude/skills/update-jamdesk/SKILL.md. Depois, reinicie sua sessão do Claude Code.
Crie .jamdesk-docs-path na raiz do seu repositório com o caminho para o diretório da documentação. A skill procura a partir do diretório atual até a raiz do git.
Instale com npm install -g jamdesk. A skill funciona sem ela, mas pula a validação automatizada.
