otimização do agent para docuemntação

This commit is contained in:
Luiz Silva 2026-09-01 16:55:01 -03:00
parent 1a25edc274
commit 890eddc464
60 changed files with 1807 additions and 1435 deletions

View file

@ -1,40 +1,52 @@
---
type: structural
name: INDICE
description: Índice central navegável de todas as categorias de documentação
updatedAt: "2026-08-12"
description: Índice central navegável dos 6 pilares de documentação e memória do ecossistema
updatedAt: "2026-09-01"
---
# Índice de Documentação
# Índice Geral de Documentação e Memória
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 mapa de navegação para os **6 pilares de documentação** do ecossistema.
## Arquitetura
Decisões técnicas e arquiteturais (ADRs) que impactam o sistema.
**Template**: `DOCUMENTACAO/arquitetura/_template-adr`
---
- *(Nenhum documento criado ainda)*
## 1. Código-Fonte (JSDoc e Comentários de Aplicação)
Documentação interna nos arquivos `.ts`, `.vue`, `.js` com foco na aplicação prática no sistema.
- **Regra:** `rules/jsdoc-padrao.md`
- **Referência de regras de negócio no código:** `// Regras de negócio: ver ../../wiki/dev/<modulo>/...`
## Módulos
Documentação do domínio, glossário e entidades de cada módulo do sistema.
**Template**: `DOCUMENTACAO/modulos/_template-modulo`
## 2. Ajuda na Tela (UI - `.ajuda.md`)
Arquivos Markdown co-localizados nos componentes de tela e modais.
- **Padrão:** `modalX.vue` $\rightarrow$ `modalX.ajuda.md`
- **Skill / Workflow:** `skills/adicionar-ajuda/SKILL.md`
- *(Nenhum documento criado ainda)*
## 3. Wiki do Usuário (`../../wiki/<modulo>/`)
Aplicação VitePress voltada ao **acesso dos usuários e clientes**. Contém manuais operacionais, tutoriais e conceitos funcionais.
- **Estrutura:** `../../wiki/<modulo>/` (ex: `../../wiki/e-licencie.sigma/`)
- **Skill:** `skills/documentar-dominio-modulo/SKILL.md`
## 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`
## 4. Wiki de Desenvolvimento (`../../wiki/dev/<modulo>/`)
Aplicação VitePress com **acesso interno exclusivo pela equipe de desenvolvimento e arquitetura**. Contém arquitetura técnica, modelos de banco, regras de negócio detalhadas (`{modulo}.regras-negocio.md`), fluxos de filas, CRONs e ADRs.
- **Estrutura:** `../../wiki/dev/<modulo>/` (ex: `../../wiki/dev/e-licencie.sigma/`)
- **Regras de Negócio:** `../../wiki/dev/<modulo>/` (ver `rules/regras-negocio-md.md`)
- **ADRs Técnicos:** `../../wiki/dev/<modulo>/adrs/` (ver `skills/documentar-decisao-tecnica/SKILL.md`)
- *(Nenhum documento criado ainda)*
## 5. Rota de Integração de IA (`/llm.md`)
Especificação dinâmica servida pelo backend para consumo por agentes e LLMs.
- **Rota padrão:** `GET /llm.md` ou `GET /sigma/llm.md`
## Contratos
Definição de contratos de API, schemas de dados e especificações de endpoints.
**Template**: `DOCUMENTACAO/contratos/_template-contrato`
## 6. Memória das Ações da IA (`<base_projeto>/memorias-ia/`)
Registros de sessões, otimizações executadas e decisões de arquitetura.
- **Diretório:** `<base_projeto>/memorias-ia/` (na raiz do projeto pai)
- **Workflow:** `global/workflows/aprimora-ia.md`
- *(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`
## Templates Padronizados (`DOCUMENTACAO/`)
- *(Nenhum documento criado ainda)*
- **ADRs:** `DOCUMENTACAO/arquitetura/_template-adr`
- **Módulos / Domínio:** `DOCUMENTACAO/modulos/_template-modulo`
- **Regras de Negócio:** `DOCUMENTACAO/regras-negocio/_template-regra`
- **Contratos de API:** `DOCUMENTACAO/contratos/_template-contrato`
- **Fluxos:** `DOCUMENTACAO/fluxos/_template-fluxo`