Atualizações automáticas de docs
Mantenha a documentação sincronizada com o código usando a skill /update-jamdesk para Claude Code e atualize páginas ao lançar recursos.
A skill /update-jamdesk para Claude Code acompanha as alterações no seu código e gera atualizações correspondentes na documentação. Depois de lançar um recurso voltado aos usuários, execute a skill para identificar quais páginas precisam ser criadas ou editadas.
Procurando dicas gerais de escrita com IA? Esta página aborda a skill /update-jamdesk para atualizações automatizadas da documentação. Para configurar a ferramenta, consulte Claude Code. Para orientações mais amplas sobre o uso de ferramentas de IA para escrever documentação, consulte Escrevendo com IA.
Quando usar
Use quando: você tiver feito alterações voltadas aos usuários em APIs, comandos da CLI, UI, opções de configuração ou comportamento de componentes.
Ignore quando: forem refatorações internas, alterações apenas em testes, configuração de build/CI ou trabalho de desempenho sem mudança de comportamento. Essas alterações não precisam de documentação voltada aos usuários.
Pré-requisitos
- Claude Code instalado e configurado
- Um projeto de documentação do Jamdesk com
docs.json - Opcional: Jamdesk CLI 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 documentação:
docs_path: ../my-docsO caminho pode ser relativo (a partir do arquivo de configuração) ou absoluto.
Depois de implementar um recurso, execute:
/update-jamdeskClaude analisará suas alterações e fará perguntas de esclarecimento antes de escrever a documentação.
Revise a documentação gerada. Em seguida, Claude a verificará com jamdesk validate e jamdesk broken-links antes de fazer o commit.
Formato do arquivo de configuração
O arquivo .jamdesk-docs-path informa ao Claude onde sua documentação está localizada.
Formato simples — apenas o caminho:
../my-docsFormato completo — com opções:
# Path to documentation repository
docs_path: ../my-docs
# Optional: Branch for doc updates (default: main)
docs_branch: mainO arquivo de configuração é localizado percorrendo os diretórios acima do diretório atual até a raiz do git. Para obter melhores resultados, coloque-o na raiz do repositório.
Como funciona
Quando você executa /update-jamdesk, Claude:
- Localiza sua documentação — encontra o arquivo de configuração
.jamdesk-docs-path - Faz perguntas — esclarece a estratégia de branches, 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, começando com exemplos simples
- Revisa o tom — verifica se há conteúdo genérico de IA. Claude escreve melhor com um
CLAUDE.mdque define a voz (consulte Claude Code) - Verifica — executa
jamdesk validateejamdesk broken-links - Faz commit — prepara as alterações e oferece opções para fazer commit, push ou abrir um PR
Não gostou das alterações? Execute git checkout . antes de fazer o 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 à página existente |
| Capacidade importante | Nova página independente |
| Descontinuação/remoção | Atualizar a página 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 seria alterado sem fazer edições:
/update-jamdesk --previewO modo de visualização prévia permite:
- Verificar qual documentação precisa ser atualizada
- Revisar as alterações propostas antes de fazer o commit
- Ver a análise da skill sem efeitos colaterais
Sugestões proativas
Depois de fazer commit de alterações no código voltadas aos usuários, Claude pode sugerir:
Tip: These changes affect user-facing features.
Run /update-jamdesk to update your documentation.Isso aparece quando:
- Você tem um arquivo de configuração
.jamdesk-docs-path, e - Seu commit inclui arquivos que correspondem a padrões voltados aos usuários (API, CLI, componentes)
Instalar a skill
Instale a skill /update-jamdesk usando a CLI de skills:
npx skills add jamdesk/skills --skill update-jamdeskIsso instala a skill em .claude/skills/update-jamdesk/ no seu projeto.
Instala no diretório atual do projeto:
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 --listAtualizar
Execute novamente o comando de instalação para obter a versão mais recente:
npx skills add jamdesk/skills --skill update-jamdeskDepois de instalar ou atualizar, reinicie o Claude Code ou inicie uma nova sessão para que as alterações entrem em vigor.
Solução de problemas
Verifique se o arquivo da skill está em .claude/skills/update-jamdesk/SKILL.md e 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 pesquisa do diretório atual até a raiz do git.
Instale com npm install -g jamdesk. A skill funcionará sem ela, mas não executará a validação automatizada.