70 lines
2.2 KiB
Text
70 lines
2.2 KiB
Text
---
|
|
type: template
|
|
name: modulo-dominio
|
|
description: Template canônico para documentação de domínio funcional e técnico de módulos
|
|
updatedAt: "2026-09-02"
|
|
---
|
|
|
|
<!--
|
|
DESTINO CANÔNICO NO PROJETO:
|
|
- Wiki do Usuário (Pilar 3): <modulo-wiki>/<modulo-id>/index.md
|
|
- Wiki de Desenvolvimento (Pilar 4): <modulo-wiki>/dev/<modulo-id>/index.md
|
|
|
|
VARIÁVEIS A PREENCHER:
|
|
- <modulo-id>: ID obtido em memorias-ia/modulo.yml
|
|
- <modulo-wiki>: Caminho da Wiki obtido em memorias-ia/modulo.yml (fallback: ../wiki)
|
|
- <NOME DO MÓDULO>: Nome legível do módulo
|
|
-->
|
|
|
|
# Módulo: <NOME DO MÓDULO>
|
|
|
|
## Identidade e Propósito
|
|
- **ID do Módulo (`modulo-id`):** `<modulo-id>`
|
|
- **Rota Base (`modulo-caminho`):** `<modulo-caminho>`
|
|
- **Propósito:** <Descrever o problema operacional central que este módulo resolve>
|
|
|
|
---
|
|
|
|
## Glossário e Conceitos do Domínio
|
|
|
|
| Termo | Definição no Domínio | Contexto de Aplicação |
|
|
| :--- | :--- | :--- |
|
|
| `<Termo 1>` | `<Definição clara>` | `<Onde aparece na operação>` |
|
|
| `<Termo 2>` | `<Definição clara>` | `<Onde aparece na operação>` |
|
|
|
|
---
|
|
|
|
## Entidades e Dados Centrais
|
|
|
|
- **Entidade A**: <Descrição da entidade, papel no negócio e atributos principais>
|
|
- **Entidade B**: <Descrição da entidade, papel no negócio e atributos principais>
|
|
|
|
---
|
|
|
|
## Legislação e Normas Aplicáveis
|
|
<Listar normas técnicas (CONAMA, ABNT), leis ou portarias que balizam as regras deste módulo>
|
|
- Norma/Lei 1: [...]
|
|
- Norma/Lei 2: [...]
|
|
|
|
---
|
|
|
|
## Fluxos Operacionais Principais
|
|
- **Fluxo 1**: <Descrição resumida do fluxo operacional>
|
|
- **Fluxo 2**: <Descrição resumida do fluxo operacional>
|
|
|
|
---
|
|
|
|
## Vocabulário de Interface (Linguagem Ubíqua)
|
|
<Termos específicos que DEVEM ser usados nos botões, títulos e mensagens da UI para consistência com o usuário>
|
|
- `<Ação>`: `<Termo recomendado na UI>`
|
|
|
|
---
|
|
|
|
## Manuais, Diagramas e Anexos (MinIO Paiol)
|
|
<!--
|
|
ATENÇÃO: Mídias pesadas, vídeos, imagens e manuais em PDF NUNCA devem ser commitados no Git da Wiki.
|
|
Envie via: ./.agent/scripts/upload-paiol-wiki.sh <arquivo> <slug>
|
|
Insira abaixo apenas as URLs públicas geradas:
|
|
-->
|
|
- [Manual Operacional (PDF)](https://paiol.idz.one/wiki/<modulo-id>/manual-<aleatorio>.pdf)
|
|
|