---
type: structural
name: INDICE
description: Índice central navegável dos 6 pilares de documentação e memória do ecossistema
updatedAt: "2026-09-01"
---

# Índice Geral de Documentação e Memória

Este documento serve como mapa de navegação para os **6 pilares de documentação** do ecossistema.

---

## 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>/...`

## 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`

## 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`

## 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`)

## 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`

## 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`

---

## Templates Padronizados (`DOCUMENTACAO/`)

- **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`