agente documentação
This commit is contained in:
parent
b92dc7b06e
commit
5f11352ab7
11 changed files with 239 additions and 158 deletions
|
|
@ -1,40 +1,64 @@
|
|||
---
|
||||
type: structural
|
||||
name: INDICE
|
||||
description: Índice central navegável de todas as categorias de documentação
|
||||
description: Índice central navegável da documentação organizada por funcionalidade
|
||||
updatedAt: "2026-08-12"
|
||||
---
|
||||
|
||||
# Índice de Documentação
|
||||
# Índice de Documentação — Qualifica
|
||||
|
||||
Este documento serve como ponto central de navegação para todas as documentações do ecossistema. Os documentos serão listados aqui conforme forem criados.
|
||||
Este documento serve como ponto central de navegação para toda a documentação do módulo Qualifica. A documentação é organizada por **funcionalidade**, onde cada pasta agrupa especificação técnica, regras de negócio, contratos e fluxos.
|
||||
|
||||
## Arquitetura
|
||||
Decisões técnicas e arquiteturais (ADRs) que impactam o sistema.
|
||||
**Template**: `DOCUMENTACAO/arquitetura/_template-adr`
|
||||
**Templates**: `DOCUMENTACAO/_templates/`
|
||||
**Funcionalidades**: `DOCUMENTACAO/funcionalidades/`
|
||||
|
||||
---
|
||||
|
||||
## Avaliações
|
||||
Ciclos de avaliação, envios, análise e preenchimento — funcionalidade core do sistema.
|
||||
|
||||
- `funcionalidades/avaliacoes/especificacao.md` — Spec técnica (schemas Zod, DDL, fluxos)
|
||||
- `funcionalidades/avaliacoes/regras-negocio.md` — Ciclos, prazos, envios e reenvios
|
||||
|
||||
## Empresas
|
||||
Cadastro de empresas, painel da empresa, empreendedores, empreendimentos e contatos.
|
||||
|
||||
- *(Nenhum documento criado ainda)*
|
||||
|
||||
## Módulos
|
||||
Documentação do domínio, glossário e entidades de cada módulo do sistema.
|
||||
**Template**: `DOCUMENTACAO/modulos/_template-modulo`
|
||||
## Formulários
|
||||
Builder de formulários, seções, campos e respostas.
|
||||
|
||||
- *(Nenhum documento criado ainda)*
|
||||
|
||||
## Regras de Negócio
|
||||
Regras operacionais e de negócio extraídas do código ou definidas pelos operadores.
|
||||
**Template**: `DOCUMENTACAO/regras-negocio/_template-regra`
|
||||
## Contratos Comerciais
|
||||
Gestão de contratos comerciais.
|
||||
|
||||
- *(Nenhum documento criado ainda)*
|
||||
|
||||
## Contratos
|
||||
Definição de contratos de API, schemas de dados e especificações de endpoints.
|
||||
**Template**: `DOCUMENTACAO/contratos/_template-contrato`
|
||||
## Relatórios
|
||||
Relatórios em PDF, histórico, documentos e eventos.
|
||||
|
||||
- *(Nenhum documento criado ainda)*
|
||||
|
||||
## Fluxos
|
||||
Mapeamento de jornadas do usuário, interações de interface e fluxos de uso do sistema.
|
||||
**Template**: `DOCUMENTACAO/fluxos/_template-fluxo`
|
||||
## Importador
|
||||
Importação de dados externos.
|
||||
|
||||
- *(Nenhum documento criado ainda)*
|
||||
|
||||
## Ajuda e Suporte
|
||||
Sistema de chamados, diagnóstico de ambiente e suporte contextual.
|
||||
|
||||
- `funcionalidades/ajuda-suporte/especificacao.md` — Arquitetura, componentes, fluxos e UX
|
||||
|
||||
## Validade
|
||||
Controle de validade.
|
||||
|
||||
- *(Nenhum documento criado ainda)*
|
||||
|
||||
---
|
||||
|
||||
## Transversais
|
||||
Decisões arquiteturais (ADRs) e documentação que cruza funcionalidades.
|
||||
**Template ADR**: `_templates/_template-adr`
|
||||
|
||||
- *(Nenhum documento criado ainda)*
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue