36 lines
1.3 KiB
Text
36 lines
1.3 KiB
Text
---
|
|
type: template
|
|
name: _template-modulo
|
|
description: Template para documentação de módulos e domínios
|
|
updatedAt: "2026-08-12"
|
|
---
|
|
|
|
# Módulo: <PREENCHER NOME DO MÓDULO>
|
|
|
|
## Área de Conhecimento
|
|
<Descrever brevemente o domínio de negócio deste módulo. Qual sua responsabilidade principal e área de atuação no ecossistema?>
|
|
|
|
## Glossário do Módulo
|
|
|
|
| Termo | Definição | Contexto de Uso |
|
|
| :--- | :--- | :--- |
|
|
| `<Termo 1>` | `<Definição>` | `<Contexto>` |
|
|
| `<Termo 2>` | `<Definição>` | `<Contexto>` |
|
|
|
|
## Entidades Principais
|
|
<Descrever as entidades de dados fundamentais que compõem este módulo>
|
|
- **Entidade A**: <Descrição do papel da entidade e principais atributos>.
|
|
- **Entidade B**: <Descrição do papel da entidade e principais atributos>.
|
|
|
|
## Legislação Aplicável
|
|
<Listar leis, normas técnicas ou portarias que afetam as regras deste domínio, se aplicável>
|
|
- [...]
|
|
|
|
## Fluxos do Domínio
|
|
<Listar os fluxos de negócios centrais orquestrados por este módulo, referenciando documentos em `DOCUMENTACAO/fluxos/` se existirem>
|
|
- **Fluxo Principal X**: [...]
|
|
- **Fluxo Principal Y**: [...]
|
|
|
|
## Vocabulário de Interface
|
|
<Termos específicos que devem ser usados na UI para manter a consistência com a linguagem ubíqua do domínio>
|
|
- [...]
|