Add technical docs structure
This commit is contained in:
21
README.md
21
README.md
@@ -8,12 +8,12 @@ A ideia é construir, em conjunto, uma base confiável para encaixar missões, a
|
||||
|
||||
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.
|
||||
O Gitea do PPGAO/ITA é 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;
|
||||
- o Gitea 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.
|
||||
|
||||
@@ -24,6 +24,7 @@ arara_oarmp/
|
||||
raw/
|
||||
pre_process/
|
||||
processed/
|
||||
docs/
|
||||
CONTEXTO.md
|
||||
LOG.md
|
||||
README.md
|
||||
@@ -32,6 +33,7 @@ arara_oarmp/
|
||||
- `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.
|
||||
- `docs/`: documentação técnica, autoria e histórico de versões.
|
||||
- `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.
|
||||
@@ -46,11 +48,11 @@ Usamos tags curtas para identificar quem fez cada alteração relevante:
|
||||
|
||||
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
|
||||
## Como usar pelo site do Gitea
|
||||
|
||||
Este caminho é bom para quem só quer ver arquivos, baixar documentos ou conferir o histórico.
|
||||
|
||||
1. Abra o repositório no GitHub.
|
||||
1. Abra o repositório no Gitea do PPGAO/ITA.
|
||||
2. Entre nas pastas para ver os arquivos.
|
||||
3. Use `raw/` para consultar documentos originais.
|
||||
4. Use `pre_process/` para consultar arquivos intermediários.
|
||||
@@ -64,9 +66,16 @@ Para baixar um arquivo pelo site:
|
||||
2. Clique em `Download raw file` ou no botão de download.
|
||||
3. Salve no computador.
|
||||
|
||||
## Documentação
|
||||
|
||||
- `docs/about.md`: descrição técnica, 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.
|
||||
- `LOG.md`: diário operacional detalhado.
|
||||
|
||||
## Como usar no computador
|
||||
|
||||
Este caminho é para quem vai mexer nos arquivos e devolver alterações ao GitHub.
|
||||
Este caminho é para quem vai mexer nos arquivos e devolver alterações ao Gitea.
|
||||
|
||||
Primeiro, instale o Git:
|
||||
|
||||
@@ -107,7 +116,7 @@ Crie um commit com uma mensagem curta:
|
||||
git commit -m "Descreva a alteração feita"
|
||||
```
|
||||
|
||||
Envie para o GitHub:
|
||||
Envie para o Gitea:
|
||||
|
||||
```powershell
|
||||
git push
|
||||
|
||||
Reference in New Issue
Block a user