Improve project context and log traceability
This commit is contained in:
38
CONTEXTO.md
Normal file
38
CONTEXTO.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# Contexto do Projeto
|
||||
|
||||
## Objetivo
|
||||
|
||||
Organizar, preservar e processar documentos relacionados ao projeto `fab_oamrp`, mantendo rastreabilidade das alterações e separando arquivos originais, intermediários e processados.
|
||||
|
||||
## 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.
|
||||
|
||||
## Colaboradores
|
||||
|
||||
- `VTO`: Vitor Cesa.
|
||||
- `GNR`: Generoso.
|
||||
- `JOM`: João Marcos.
|
||||
|
||||
## 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/`.
|
||||
- Registrar no `LOG.md` toda entrada, alteração, processamento ou decisão relevante.
|
||||
- Usar o formato de log com data, hora, tag do colaborador e descrição objetiva da ação.
|
||||
- Registrar a origem de cada documento, quando conhecida.
|
||||
- Informar scripts executados e parâmetros importantes.
|
||||
- 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/`.
|
||||
|
||||
## Formato Recomendado do Log
|
||||
|
||||
```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 |
|
||||
```
|
||||
Reference in New Issue
Block a user