Contexto do Projeto

Objetivo

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

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

README.md: guia inicial para colaboradores e uso básico do repositório.
CONTEXTO.md: orientações permanentes e combinados de trabalho.
LOG.md: diário operacional detalhado, com data, hora, autor, ação, arquivos e observações.
docs/about.md: documentação técnica do projeto, fluxo de dados, limitações e oportunidades de melhoria.
docs/authors.md: autoria, colaboradores e regras de contribuição.
docs/changelog.md: histórico resumido de versões significativas.

Colaboradores

VTO: Vitor Cesa.
GNR: Generoso.
JOM: João Marcos.

Orientações de Trabalho

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.
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 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

| Data | Hora | Autor | Ação | Arquivos | Observações |
| --- | --- | --- | --- | --- | --- |
| 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 |

2.7 KiB Raw Blame History