vitorcesavc/arara_oarmp
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Detalha checklist de atualizacao documental

Browse Source
This commit is contained in:
Cesa-V
2026-06-15 19:09:45 -03:00
parent f570091e19
commit 8d7dd07b18
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
CONTEXTO.md
View File

@@ -43,6 +43,25 @@ Organizar, preservar e processar documentos relacionados ao projeto Arara OAMRP,
- Explicitar os critérios usados para mover dados de `db/pre_process/` para `db/processed/`. - Explicitar os critérios usados para mover dados de `db/pre_process/` para `db/processed/`.
- Atualizar `docs/about.md` quando o fluxo técnico, campos extraídos ou limitações conhecidas mudarem. - Atualizar `docs/about.md` quando o fluxo técnico, campos extraídos ou limitações conhecidas mudarem.
## Checklist de Atualização Documental
Antes de fechar uma mudança relevante ou criar um commit, verificar se algum destes arquivos precisa ser atualizado:
- `LOG.md`: atualizar em toda entrada de documento, alteração de dados, execução de script, processamento, decisão técnica ou mudança estrutural relevante.
- `docs/changelog.md`: atualizar quando a mudança representar nova versão ou marco do projeto, como novo parser, novo modelo, novo conjunto de dados, alteração de estrutura, nova funcionalidade ou correção importante.
- `README.md`: atualizar quando mudar a forma de usar o projeto, a estrutura de pastas, comandos principais, estado atual, dependências esperadas ou orientação para colaboradores.
- `docs/about.md`: atualizar quando mudar o fluxo técnico, arquitetura, campos extraídos, modelo de dados, limitações conhecidas, fontes de dados ou oportunidades de melhoria.
- `docs/authors.md`: atualizar quando houver novo colaborador, mudança de papel, nova contribuição atribuída ou nova versão registrada no changelog.
- `CONTEXTO.md`: atualizar quando mudar regra permanente de trabalho, convenção de pastas, política de documentação, padrão de nomenclatura ou combinado do projeto.
- `.gitignore`: atualizar quando surgirem novos arquivos temporários, caches, saídas locais ou artefatos gerados que não devem ser versionados.
Critério prático:
- Mudança operacional ou decisão do dia: registrar no `LOG.md`.
- Mudança significativa para quem usa ou entende o projeto: registrar também em `docs/changelog.md`.
- Mudança que altera como trabalhar no repositório: atualizar `README.md` e, se for regra permanente, `CONTEXTO.md`.
- Mudança técnica interna: atualizar `docs/about.md`.
## Formato Recomendado do Log ## Formato Recomendado do Log
```text ```text