From 1cbcfea5a2276263d63eb43da721d2c6579e4277 Mon Sep 17 00:00:00 2001 From: Cesa-V Date: Mon, 15 Jun 2026 15:41:54 -0300 Subject: [PATCH] Improve project context and log traceability --- CONTEXTO.md | 38 ++++++++++++++++++++++++++++++++++++++ LOG.md | 35 ++++++++++------------------------- 2 files changed, 48 insertions(+), 25 deletions(-) create mode 100644 CONTEXTO.md diff --git a/CONTEXTO.md b/CONTEXTO.md new file mode 100644 index 0000000..75e3d93 --- /dev/null +++ b/CONTEXTO.md @@ -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 | +``` diff --git a/LOG.md b/LOG.md index f9be6f8..2c64161 100644 --- a/LOG.md +++ b/LOG.md @@ -1,29 +1,14 @@ # Log do Projeto -## 2026-06-15 +Legenda de autores: -- Repositório Git criado para o projeto `fab_oamrp`. -- Documentos originais movidos para `raw/`. -- Pastas criadas: - - `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. -- PDF `raw/documento joaomarcos.pdf` lido e pré-processado. -- Arquivos gerados a partir do PDF: - - `pre_process/documento_joaomarcos_texto.txt` - - `pre_process/documento_joaomarcos_inspecoes.json` - - `pre_process/documento_joaomarcos_inspecoes.csv` -- Total extraído do PDF: 18 inspeções. -- Observação: as grafias originais do PDF foram preservadas, inclusive ocorrências de `INPEÇÃO`. +- `VTO`: Vitor Cesa. +- `GNR`: Generoso. +- `JOM`: João Marcos. -## O que registrar aqui - -- Data de entrada ou alteração de novos documentos em `raw/`. -- Origem de cada documento, quando conhecida. -- O que foi feito em cada etapa de pré-processamento. -- Scripts executados e parâmetros importantes. -- Quantidade de registros extraídos, descartados ou corrigidos. -- Problemas encontrados nos arquivos originais, como erros de digitação, páginas ilegíveis, campos ausentes ou tabelas quebradas. -- Decisões de padronização, por exemplo nomes de colunas, unidades, formatos de data e tratamento de acentos. -- Critérios para mover dados de `pre_process/` para `processed/`. -- Mudanças relevantes feitas por colaboradores. +| Data | Hora | Autor | Ação | Arquivos | Observações | +| --- | --- | --- | --- | --- | --- | +| 2026-06-15 | 15:41 | VTO | Criou repositório Git do projeto | `.gitignore`; `.gitattributes` | Projeto versionado na branch `main`. | +| 2026-06-15 | 15:41 | VTO | Organizou estrutura inicial de dados | `raw/`; `pre_process/`; `processed/` | Documentos originais movidos para `raw/`; pastas vazias preservadas com `.gitkeep`. | +| 2026-06-15 | 15:41 | VTO | Pré-processou PDF de inspeções | `raw/documento joaomarcos.pdf`; `pre_process/documento_joaomarcos_texto.txt`; `pre_process/documento_joaomarcos_inspecoes.json`; `pre_process/documento_joaomarcos_inspecoes.csv`; `pre_process/preprocess_pdf.py` | 18 inspeções extraídas; grafias originais preservadas, inclusive `INPEÇÃO`. | +| 2026-06-15 | 15:41 | VTO | Separou orientações permanentes do histórico | `CONTEXTO.md`; `LOG.md` | Orientações movidas para `CONTEXTO.md`; `LOG.md` passou a usar data, hora e tag de autor. |