53 lines
2.8 KiB
Text
53 lines
2.8 KiB
Text
---
|
|
type: structural
|
|
name: README
|
|
description: Manifesto e guia para o Desenvolvimento Orientado a Documentação (DDD)
|
|
updatedAt: "2026-08-12"
|
|
---
|
|
|
|
# Documentation-Driven Development (DDD)
|
|
|
|
## Manifesto
|
|
No ecossistema Azteca, a documentação precede o código. Nenhum artefato (regra, skill, workflow, módulo, API, decisão técnica) deve ser implementado sem documentação prévia. A documentação é a especificação viva.
|
|
|
|
## Princípios
|
|
1. **Doc First** — Nenhum artefato novo sem documentação prévia.
|
|
2. **Doc como Contrato** — A documentação é a especificação; o código a implementa.
|
|
3. **Código Satisfaz Doc** — Se o código diverge da doc, o código está errado.
|
|
4. **Sincronia Obrigatória** — Mudança no código → atualização da doc; mudança na doc → atualização no código.
|
|
5. **Templates Padronizados** — Cada categoria tem seu template; nenhuma documentação é criada do zero.
|
|
6. **Leitura Antes de Escrita** — Antes de documentar, leia o que já existe.
|
|
|
|
## Categorias de Documentação
|
|
|
|
| Categoria | Diretório | O que documenta | Template |
|
|
| :--- | :--- | :--- | :--- |
|
|
| Arquitetura | `DOCUMENTACAO/arquitetura/` | Decisões técnicas e arquiteturais (ADRs) | `_template-adr` |
|
|
| Módulos | `DOCUMENTACAO/modulos/` | Domínio, glossário e entidades de cada módulo | `_template-modulo` |
|
|
| Regras de Negócio | `DOCUMENTACAO/regras-negocio/` | Regras extraídas do código ou definidas pelo operador | `_template-regra` |
|
|
| Contratos | `DOCUMENTACAO/contratos/` | Contratos de API, schemas, endpoints | `_template-contrato` |
|
|
| Fluxos | `DOCUMENTACAO/fluxos/` | Jornadas do usuário e fluxos de uso | `_template-fluxo` |
|
|
|
|
## Workflow DDD
|
|
1. **Receber demanda**
|
|
2. **Documentar** (criar/atualizar documentação na categoria apropriada usando o template)
|
|
3. **Revisar** (apresentar a documentação ao operador para validação)
|
|
4. **Implementar** (codificar de acordo com a documentação aprovada)
|
|
5. **Validar** (verificar se o código satisfaz a doc 100%)
|
|
6. **Sincronizar** (atualizar a documentação se a implementação revelou ajustes necessários)
|
|
|
|
## Integração com o Ecossistema
|
|
|
|
| Artefato | Como Integra com DDD |
|
|
| :--- | :--- |
|
|
| `rules/regras-negocio-md.md` | Define formato e obrigatoriedade de documentar regras de negócio |
|
|
| `skills/documentar-decisao-tecnica` | Fornece habilidade para criar e atualizar ADRs |
|
|
| `skills/documentar-dominio-modulo` | Estrutura para levantar glossário e domínio de módulos |
|
|
| `skills/documentar-regras-negocio` | Habilidade para extrair e redigir regras |
|
|
| `rules/diagnostico-antes-correcao.md`| Diagnóstico exige leitura e alinhamento com doc antes de corrigir bugs |
|
|
|
|
## Referências
|
|
- `rules/ddd-documentacao-primeiro.md`
|
|
- `skills/documentar-decisao-tecnica`
|
|
- `skills/documentar-dominio-modulo`
|
|
- `skills/documentar-regras-negocio`
|