52 lines
1.6 KiB
Text
52 lines
1.6 KiB
Text
---
|
|
type: template
|
|
name: _template-especificacao
|
|
description: Template para especificação técnica de uma funcionalidade do módulo
|
|
updatedAt: "2026-08-12"
|
|
---
|
|
|
|
# Especificação: <PREENCHER NOME DA FUNCIONALIDADE>
|
|
|
|
## Área de Conhecimento
|
|
<Descrever brevemente o domínio de negócio desta funcionalidade. Qual sua responsabilidade principal dentro do módulo?>
|
|
|
|
## Glossário
|
|
|
|
| Termo | Definição | Contexto de Uso |
|
|
| :--- | :--- | :--- |
|
|
| `<Termo 1>` | `<Definição>` | `<Contexto>` |
|
|
|
|
## Entidades Principais
|
|
<Descrever as entidades de dados que compõem esta funcionalidade>
|
|
- **Entidade A**: <Descrição do papel e principais atributos>.
|
|
|
|
## Schemas Zod
|
|
<Referenciar os schemas Zod em `qualifica-comuns/src/tabelas/` que sustentam esta funcionalidade>
|
|
- `_entidade.ts` — <descrição>
|
|
|
|
## Estrutura de Dados (DDL)
|
|
<Se aplicável, descrever a estrutura SQL das tabelas envolvidas>
|
|
```sql
|
|
-- DDL da tabela principal
|
|
```
|
|
|
|
## Componentes de Interface
|
|
<Listar as páginas e componentes Vue envolvidos nesta funcionalidade>
|
|
- `PaginaX/` — <descrição>
|
|
- `ComponenteY.vue` — <descrição>
|
|
|
|
## Fluxos do Domínio
|
|
<Listar os fluxos de negócio orquestrados por esta funcionalidade, referenciando `fluxo.md` co-localizado se existir>
|
|
- **Fluxo Principal**: [...]
|
|
|
|
## Legislação Aplicável
|
|
<Listar leis, normas técnicas ou portarias que afetam esta funcionalidade, se aplicável>
|
|
- [...]
|
|
|
|
## Vocabulário de Interface
|
|
<Termos específicos que devem ser usados na UI para manter consistência com a linguagem ubíqua do domínio>
|
|
- [...]
|
|
|
|
## Referências
|
|
- Regras de negócio: `regras-negocio.md` (co-localizado)
|
|
- [...]
|