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

Atualiza documentacao da estrutura OAMRP

Browse Source
This commit is contained in:
Cesa-V
2026-06-15 19:03:24 -03:00
parent 1131267ea2
commit f570091e19
6 changed files with 91 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
CONTEXTO.md
View File

@@ -2,13 +2,14 @@
## Objetivo
Organizar, preservar e processar documentos relacionados ao projeto `arara_oarmp`, mantendo rastreabilidade das alterações e separando arquivos originais, intermediários e processados.
Organizar, preservar e processar documentos relacionados ao projeto Arara OAMRP, mantendo rastreabilidade das alterações e separando arquivos originais, intermediários, processados e modelos de software.
## Estrutura de Pastas
- `raw/`: arquivos originais, sem alteração.
- `pre_process/`: scripts e saídas intermediárias de pré-processamento.
- `processed/`: dados finais limpos, consolidados ou prontos para análise.
- `db/raw/`: arquivos originais, sem alteração.
- `db/pre_process/`: scripts e saídas intermediárias de pré-processamento.
- `db/processed/`: dados finais limpos, consolidados ou prontos para análise.
- `software/`: modelos, scripts analíticos e protótipos executáveis do OAMRP.
- `docs/`: documentação técnica, autoria e histórico de versões.
## Arquivos de Documentação
@@ -28,8 +29,9 @@ Organizar, preservar e processar documentos relacionados ao projeto `arara_oarmp
## Orientações de Trabalho
- Manter documentos originais sempre em `raw/`.
- Não alterar arquivos dentro de `raw/`; quando necessário, gerar cópias ou saídas em `pre_process/`.
- Manter documentos originais sempre em `db/raw/`.
- Não alterar arquivos dentro de `db/raw/`; quando necessário, gerar cópias ou saídas em `db/pre_process/`.
- Manter modelos e protótipos executáveis em `software/`.
- Registrar no `LOG.md` toda entrada, alteração, processamento ou decisão relevante.
- Registrar em `docs/changelog.md` mudanças significativas de versão, como novo parser, novo conjunto de dados, mudança estrutural ou nova funcionalidade.
- Usar o formato de log com data, hora, tag do colaborador e descrição objetiva da ação.
@@ -38,7 +40,7 @@ Organizar, preservar e processar documentos relacionados ao projeto `arara_oarmp
- Registrar quantidade de registros extraídos, descartados, corrigidos ou validados.
- Registrar problemas encontrados nos arquivos originais, como erros de digitação, páginas ilegíveis, campos ausentes ou tabelas quebradas.
- Registrar decisões de padronização, por exemplo nomes de colunas, unidades, formatos de data e tratamento de acentos.
- Explicitar os critérios usados para mover dados de `pre_process/` para `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.
## Formato Recomendado do Log
@@ -46,5 +48,5 @@ Organizar, preservar e processar documentos relacionados ao projeto `arara_oarmp
```text
| Data | Hora | Autor | Ação | Arquivos | Observações |
| --- | --- | --- | --- | --- | --- |
| 2026-06-15 | 15:41 | VTO | Pré-processou PDF de inspeções | raw/documento.pdf; pre_process/saida.csv | 18 inspeções extraídas |
| 2026-06-15 | 15:41 | VTO | Pré-processou PDF de inspeções | db/raw/documento.pdf; db/pre_process/saida.csv | 18 inspeções extraídas |
```