---
title: "Padrão de Documentação"
id: padrao-de-documentacao
created: 2026-07-13
updated: 2026-07-13
author: "TODO"
status: publicado
tags:
  - documentacao
  - architecture
related:
  - "[[Início]]"
  - "[[Modelo de Documento]]"
---

# Padrão de Documentação

## Objetivo
Definir o padrão obrigatório de escrita, metadados e ligações usado em todos os documentos Markdown deste diretório, para que a base seja lida facilmente por humanos, por IA e pelo grafo em `memory-viewer/`.

## Descrição
Todo arquivo `.md` desta base segue duas partes: um bloco de metadados (frontmatter YAML) e um corpo com seções fixas.

### Frontmatter obrigatória
```yaml
---
title: "Nome do Documento"
id: nome-do-documento
created: AAAA-MM-DD
updated: AAAA-MM-DD
author: "Nome"
status: rascunho | publicado | revisao | obsoleto
tags:
  - tag1
  - tag2
related:
  - "[[Outro Documento]]"
---
```

### Seções obrigatórias do corpo
```
# Título

## Objetivo
## Descrição
## Regras
## Fluxo
## Dependências
## Arquivos relacionados
## Histórico
```

## Regras
- `title` é o nome exibido e também o texto usado nas ligações `[[Nome]]` — deve ser único em toda a base.
- `id` é um identificador único em `kebab-case`, usado como referência estável mesmo que o título mude.
- `status` aceita: `rascunho`, `publicado`, `revisao`, `obsoleto`.
- `tags` sempre em lista YAML (uma por linha), sem `#`. Tags sugeridas: `flutter`, `laravel`, `api`, `wallet`, `evento`, `financeiro`, `bug`, `feature`, `database`, `architecture` — outras podem ser criadas conforme necessário.
- Dentro do corpo do texto também é possível marcar tags inline com `#tag` (ex.: `#laravel`), além da lista em `tags`.
- Ligações entre documentos são sempre feitas com `[[Nome Documento]]`, usando o `title` exato do documento de destino. Nunca usar caminho de arquivo (`../pasta/arquivo.md`) como link.
- Se a informação não estiver confirmada, usar `[a confirmar]` ou `TODO` em vez de inventar conteúdo.
- Antes de criar um documento novo, procurar se já existe um arquivo sobre o mesmo assunto e atualizá-lo em vez de duplicar.

## Fluxo
1. Copiar [[Modelo de Documento]].
2. Preencher a frontmatter completa.
3. Escrever o conteúdo nas seções fixas (deixar `[a confirmar]` onde faltar informação).
4. Adicionar `[[Links]]` para todo documento relacionado.
5. Salvar na subpasta temática correta (`regras/`, `dicas/`, `funcionamento/`, `planos/`, `geral/`).
6. Abrir `memory-viewer/index.html` para conferir a nova conexão no grafo.

## Dependências
- [[Modelo de Documento]]

## Arquivos relacionados
- [[Início]]
- [[Modelo de Documento]]
- [[Pendências de Conteúdo]]

## Histórico
- 2026-07-13 — Criação do padrão de documentação.