diff --git a/LOG.md b/LOG.md index 4dee144..eeb2111 100644 --- a/LOG.md +++ b/LOG.md @@ -14,3 +14,4 @@ Legenda de autores: | 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. | | 2026-06-15 | 15:47 | VTO | Renomeou PDF e artefatos derivados com nome descritivo | `raw/relatorio_ciclo_inspecoes_c105_2805_2026-06-15.pdf`; `pre_process/relatorio_ciclo_inspecoes_c105_2805_2026-06-15_texto.txt`; `pre_process/relatorio_ciclo_inspecoes_c105_2805_2026-06-15_inspecoes.json`; `pre_process/relatorio_ciclo_inspecoes_c105_2805_2026-06-15_inspecoes.csv`; `pre_process/preprocess_pdf.py` | Nome antigo removia contexto técnico; novo padrão usa tipo do documento, modelo, matrícula e data do relatório. | | 2026-06-15 | 15:54 | VTO | Separou campos de controle e duração no pré-processamento | `pre_process/preprocess_pdf.py`; `pre_process/relatorio_ciclo_inspecoes_c105_2805_2026-06-15_inspecoes.json`; `pre_process/relatorio_ciclo_inspecoes_c105_2805_2026-06-15_inspecoes.csv` | Criadas colunas `tso`, `letra`, `nivel`, `var_media`, `duracao`, `duracao_valor` e `duracao_unidade`; `D` tratado como dias e `H` como horas. | +| 2026-06-15 | 16:00 | VTO | Criou guia inicial do repositório | `README.md` | Explica o objetivo do projeto OAMRP, a estrutura de pastas, o uso básico do GitHub/Git e os cuidados de rastreabilidade. | diff --git a/README.md b/README.md new file mode 100644 index 0000000..fcd1fb4 --- /dev/null +++ b/README.md @@ -0,0 +1,149 @@ +# FAB OAMRP + +Este repositório organiza os arquivos e processamentos do projeto de OAMRP do Esquadrão Arara, em Manaus. + +A ideia é construir, em conjunto, uma base confiável para encaixar missões, aeronaves e manutenções. O repositório serve como lugar único para guardar documentos originais, registrar decisões, transformar relatórios em dados utilizáveis e manter um histórico claro do que foi feito por cada colaborador. + +## O que é um repositório + +Um repositório é uma pasta controlada pelo Git. Ele guarda os arquivos do projeto e também o histórico de alterações. + +O GitHub é o site onde esse repositório fica hospedado de forma privada, para que os colaboradores possam acessar, baixar, atualizar e enviar contribuições. + +Na prática: + +- o Git mostra o que mudou; +- o GitHub permite compartilhar o projeto; +- os commits são registros das alterações feitas; +- o `LOG.md` explica o motivo e o contexto das mudanças importantes. + +## Estrutura do projeto + +```text +fab_oamrp/ + raw/ + pre_process/ + processed/ + CONTEXTO.md + LOG.md + README.md +``` + +- `raw/`: documentos originais. Não editar esses arquivos diretamente. +- `pre_process/`: scripts e arquivos intermediários gerados a partir dos documentos originais. +- `processed/`: arquivos finais, limpos e prontos para análise ou uso. +- `CONTEXTO.md`: regras, combinados e orientações permanentes do projeto. +- `LOG.md`: histórico rastreável das ações feitas no projeto. +- `README.md`: este guia inicial. + +## Colaboradores + +Usamos tags curtas para identificar quem fez cada alteração relevante: + +- `VTO`: Vitor Cesa. +- `GNR`: Generoso. +- `JOM`: João Marcos. + +Sempre que alguém fizer uma mudança importante, deve registrar no `LOG.md` com data, hora, tag do autor, ação, arquivos e observações. + +## Como usar pelo site do GitHub + +Este caminho é bom para quem só quer ver arquivos, baixar documentos ou conferir o histórico. + +1. Abra o repositório no GitHub. +2. Entre nas pastas para ver os arquivos. +3. Use `raw/` para consultar documentos originais. +4. Use `pre_process/` para consultar arquivos intermediários. +5. Use `processed/` para consultar dados finais quando existirem. +6. Abra o `LOG.md` para entender o que já foi feito. +7. Abra o `CONTEXTO.md` para ver os combinados do projeto. + +Para baixar um arquivo pelo site: + +1. Clique no arquivo. +2. Clique em `Download raw file` ou no botão de download. +3. Salve no computador. + +## Como usar no computador + +Este caminho é para quem vai mexer nos arquivos e devolver alterações ao GitHub. + +Primeiro, instale o Git: + +```powershell +git --version +``` + +Se o comando não funcionar, o Git ainda não está instalado. + +Depois, clone o repositório: + +```powershell +git clone https://github.com/Cesa-V/fab_oamrp.git +cd fab_oamrp +``` + +Antes de começar a trabalhar, atualize sua cópia: + +```powershell +git pull +``` + +Depois de alterar arquivos, veja o que mudou: + +```powershell +git status +``` + +Adicione os arquivos modificados: + +```powershell +git add . +``` + +Crie um commit com uma mensagem curta: + +```powershell +git commit -m "Descreva a alteração feita" +``` + +Envie para o GitHub: + +```powershell +git push +``` + +## Fluxo recomendado de trabalho + +1. Rode `git pull` antes de começar. +2. Coloque documentos novos em `raw/`. +3. Gere arquivos intermediários em `pre_process/`. +4. Coloque resultados finais em `processed/`. +5. Atualize o `LOG.md`. +6. Faça commit. +7. Rode `git push`. + +## Cuidados importantes + +- Não editar arquivos originais dentro de `raw/`. +- Não apagar arquivos de outros colaboradores sem combinar. +- Não subir arquivos temporários do Office, como arquivos começando com `~$`. +- Não colocar senhas, tokens ou informações pessoais desnecessárias no repositório. +- Preferir nomes de arquivo descritivos, com tipo do documento, aeronave, matrícula e data quando possível. +- Registrar no `LOG.md` qualquer decisão que afete os dados. + +## Estado atual + +Já existe um pré-processamento do relatório de ciclo de inspeções da aeronave C-105 matrícula 2805, com data de relatório `2026-06-15`. + +Arquivos principais: + +```text +raw/relatorio_ciclo_inspecoes_c105_2805_2026-06-15.pdf +pre_process/relatorio_ciclo_inspecoes_c105_2805_2026-06-15_texto.txt +pre_process/relatorio_ciclo_inspecoes_c105_2805_2026-06-15_inspecoes.json +pre_process/relatorio_ciclo_inspecoes_c105_2805_2026-06-15_inspecoes.csv +pre_process/preprocess_pdf.py +``` + +Esse processamento extraiu 18 inspeções e separou campos como inspeção, referência, vencimento, TSO, letra, nível, duração, intervalo por horas de voo, meses contínuos e pousos.