Compare commits

...

6 Commits

Author SHA1 Message Date
SyntaxError
a6e5685d82 docs README-docs.md: adicionando novas regras (como a ADR 0003) e reformatando 2026-01-07 23:30:46 -03:00
SyntaxError
2c630b66eb docs architecture.md: adicionando arquivo de arquiterura do projeto, explicará sobre o neochan e informações técnicas 2026-01-07 23:27:45 -03:00
SyntaxError
7dd1ff8c1b docs decisions: migrando decisions.md para decisions/ 2026-01-07 23:26:49 -03:00
synt-xerror
15424a982c docs: removendo pasta desnecessária 2026-01-06 08:42:46 -03:00
SyntaxError
ae47d38bb6 2 alterações: todo.md, decisions.md
todo.md:
- 2 novas tarefas, estudo e estrutura

decisions.md:
- registrado a criação da branch docs
2025-12-31 00:29:32 -03:00
SyntaxError
ec05222bfd docs: criando nova branch apenas para documentação e comunicação 2025-12-31 00:17:13 -03:00
9 changed files with 268 additions and 4 deletions

217
README-docs.md Normal file
View File

@@ -0,0 +1,217 @@
# Regras do repositório `docs/`
Este diretório contém a **comunicação técnica e organizacional** do projeto.
Não é um chat, não é um fórum, não é lugar para código grande.
O objetivo é:
* manter histórico claro
* registrar decisões importantes
* reduzir ruído
* permitir que qualquer pessoa entenda o projeto no futuro
---
## Idioma
A comunicação em `docs/` é feita em **português**.
Este diretório é voltado para quem participa do projeto.
---
## Estrutura oficial
```text
docs/
├── README-docs.md # este arquivo
├── assinaturas.txt # identificação das pessoas
├── ideas.md # ideias abertas
├── questions.md # dúvidas abertas
├── todo.md # tarefas práticas
├── architecture.md # visão geral do sistema
└── decisions/ # decisões estruturais (ADR)
```
Não criar novos arquivos sem consenso.
---
## Identificação das pessoas (obrigatório)
### Git
Cada pessoa deve usar **nome e email consistentes** no Git.
O email pode ser específico do projeto.
```bash
git config --global user.name "Nome Sobrenome"
git config --global user.email "nome@projeto.org"
```
### Assinatura nos documentos
Toda entrada relevante termina com assinatura simples:
```md
— Nome (YYYY-MM-DD)
```
* usar data ISO 8601
* sem apelidos
* sem emojis
* sem conversa informal
---
## Regra global de edição
> **Conteúdo novo entra sempre no topo do arquivo**
Motivo:
* o que importa agora fica visível
* histórico permanece preservado
---
## Papel de cada arquivo
### `ideas.md`
* ideias ainda não decididas
* propostas iniciais
* pensamento cru
Formato:
* uma ideia por seção
* separador obrigatório `---`
---
### `questions.md`
* dúvidas reais
* pontos em aberto
Quando resolvida:
* marcar como `(RESOLVIDO)`
* **não apagar**
---
### `todo.md`
* tarefas objetivas
* cada tarefa deve ter responsável
```md
- [ ] Criar schema do banco (Pedro)
```
Quando concluída, remover.
---
### `architecture.md`
* descreve o **estado atual** do sistema
* visão geral dos componentes
* não registra discussões
* não explica decisões históricas
Mudanças estruturais devem ser refletidas aqui **após** uma decisão formal.
---
### `decisions/` (ADR)
Contém **decisões arquiteturais importantes**.
Cada arquivo representa **uma decisão fechada**.
Formato recomendado:
```text
0001-titulo-curto.md
```
Regras:
* decisão clara
* contexto mínimo
* consequências explícitas
* não editar depois de aceita
Se algo mudar no futuro:
* criar um novo ADR
---
## Fluxo oficial de informação
```text
idea → dúvida → decisão (ADR) → arquitetura
```
* ideias nascem em `ideas.md`
* incertezas vão para `questions.md`
* decisões estruturais viram ADR
* `architecture.md` reflete o resultado
---
## Padrão de commit (obrigatório)
Formato:
```
<área>: <ação curta>
```
Exemplos válidos:
```
docs: adicionar ADR sobre boards
docs ideas: nova proposta de moderação
docs architecture: atualizar fluxo de dados
```
Exemplos inválidos:
```
update
testando
conversa
```
Evitar commits com múltiplos objetivos.
---
## O que é proibido
* desabafo
* conversa de chat
* opinião sem contexto
* texto vago
* código grande em `docs/`
---
## O que é esperado
* texto curto e direto
* ideias bem descritas
* dúvidas objetivas
* decisões claras
* histórico preservado
---
## Regra final
Se não ajuda alguém a entender o projeto no futuro,
**não pertence ao `docs/`**.

View File

@@ -1,4 +0,0 @@
# Neochan
Where Neocities engages.
Work in Progress.

18
architecture.md Normal file
View File

@@ -0,0 +1,18 @@
# Arquitetura Neochan
Este documento descreve a arquitetura atual do projeto.
Ele não registra decisões históricas e nem discussões, apenas o estado
aceito do sistema.
Mudanças arquiteturais relevantes devem ser registradas como ADRs em
`docs/decisions/`
---
## Visão geral
O Neochan se trata de um Imageboard simples, focado em simplicidade,
anonimato e baixo acoplamento entre componentes.
A ideia nasceu como um projeto para colocar em prática conceitos de
colaboração de software e versionamento.

View File

@@ -0,0 +1,10 @@
## 2025-12-30
Decidido:
- Comunicação será feita no repositório git.
- Para informações mais sigilosas o uso de uma lista de e-mails será adotado.
- Para informações rápidas ou menos formais será feito o uso do Discord ou WhatsApp.
Motivo:
- Seguro para manter um histórico durável por muito tempo.
-- Rafael (2025-12-30)

View File

@@ -0,0 +1,9 @@
## Nova branch docs
Decidido:
- Nova branch exclusiva para documentação e comunicação (docs)
Motivo:
- Organização do repositório
-- Rafael (2025-12-31)

View File

@@ -0,0 +1,10 @@
# Evite commits com multiplas mudanças
Decisão:
- Acabar com commits com várias mudanças de uma só vez
Motivos:
- É desorganizado
- Dificulta voltar mudanças
-- Rafael (2026-01-07)

0
ideas.md Normal file
View File

0
questions.md Normal file
View File

4
todo.md Normal file
View File

@@ -0,0 +1,4 @@
# Tarefas
- [ ] Estudar PHP e Git (Rafael)
- [ ] Fazer a estrutura inicial do site, o mínimo funcional (Rafael)