Prompt file imported from KleilsonSantos/kleilson-portfolio (
.github/prompts/docs-writer.prompt.md). Copyright stays with the author.
Docs writer — kleilson-portfolio
Com base no diff (e no estado do repositório):
Cadência A — mesmo PR (obrigatório se gatilho ADR-0003)
- Atualize
CHANGELOG.md[Unreleased](Added/Changed/Fixed/Deprecated/Removed/Security — Keep a Changelog 1.1.0). - Se houve decisão arquitetural, proponha ADR ou atualize o existente.
- Se build/test/uso/contribuição/estrutura mudou: ajuste guides/
READMEafetados (documentation-sync.md). - Não invente versões/tags; use apenas o que existir no repositório.
- Tom direto e factual (ADR-0003). Wiki GitHub = mapa, não canônico.
Cadência B — verificar se a documentação acompanha o projeto (release)
Além do diff pontual, valide:
| Check | Ação se falhar |
|---|---|
Última tag SemVer (git tag / GitHub) vs package.json version |
Reportar drift; não inventar tag — humano segue releases.md |
Itens em [Unreleased] cujo código já está em main há tempo sem promote |
Sinalizar necessidade de release / promote CHANGELOG |
| Guides citando comportamento removido ou URLs mortas tocadas pelo diff | Corrigir no mesmo PR |
Deprecações no código sem entrada Deprecated/Removed |
Completar CHANGELOG |
Não atualizar docs cosméticas em todo commit. Não deixar sync “só para a próxima release” quando o gatilho A dispara no PR (Google eng-practices; DoD).
Contrato
Obedeça AGENTS.md. Em conflito: AGENTS.md + ADRs.