---
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 <base_projeto>/../wiki/dev/<modulo-id>/...`

## 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 (`<base_projeto>/../wiki/<modulo-id>/`)
Aplicação VitePress voltada ao **acesso dos usuários e clientes**. Contém manuais operacionais, tutoriais e conceitos funcionais.
- **Estrutura:** `<base_projeto>/../wiki/<modulo-id>/` (ex: `<base_projeto>/../wiki/e-licencie.sigma/`)
- **Skill:** `skills/documentar-dominio-modulo/SKILL.md`

## 4. Wiki de Desenvolvimento (`<base_projeto>/../wiki/dev/<modulo-id>/`)
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:** `<base_projeto>/../wiki/dev/<modulo-id>/` (ex: `<base_projeto>/../wiki/dev/e-licencie.sigma/`)
- **Regras de Negócio:** `<base_projeto>/../wiki/dev/<modulo-id>/` (ver `rules/regras-negocio-md.md`)
- **ADRs Técnicos:** `<base_projeto>/../wiki/dev/<modulo-id>/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 <modulo-caminho>llm.md`

## 6. Memória das Ações da IA e Identidade (`<base_projeto>/memorias-ia/`)
Identidade canônica do projeto pai e registros de sessões, otimizações e decisões da IA.
- **Identidade do Módulo:** `<base_projeto>/memorias-ia/modulo.yml` (mandatório com `modulo-id`, `modulo-caminho`, `modulo-descricao`, `modulo-tipo`)
- **Índice Central de Ações:** `<base_projeto>/memorias-ia/historico-acoes.md` (tabela: `Data | Memória / Ação | Arquivo Memoria | Citações no Código-Fonte`)
- **Arquivos Individuais de Sessão:** `<base_projeto>/memorias-ia/sessao-AAAA-MM-DD-slug.md`
- **Regra:** `rules/identidade-modulo.md`
- **Diretório:** `<base_projeto>/memorias-ia/` (na raiz do projeto pai)
- **Workflows e Skills:** `global/workflows/doc.md`, `global/workflows/documentacao.md`, `global/workflows/aprimora-ia.md`

---

## Templates Padronizados (`DOCUMENTACAO/templates/`)

- **Identidade do Módulo (Pilar 6):** [`DOCUMENTACAO/templates/modulo.yml.template`](./templates/modulo.yml.template)
- **Índice de Ações da IA (Pilar 6):** [`DOCUMENTACAO/templates/historico-acoes.md.template`](./templates/historico-acoes.md.template)
- **Registro de Sessão da IA (Pilar 6):** [`DOCUMENTACAO/templates/sessao-memoria.md.template`](./templates/sessao-memoria.md.template)
- **Domínio do Módulo (Pilares 3 e 4):** [`DOCUMENTACAO/templates/modulo-dominio.md.template`](./templates/modulo-dominio.md.template)
- **Regras de Negócio (Pilar 4):** [`DOCUMENTACAO/templates/regra-negocio.md.template`](./templates/regra-negocio.md.template)
- **Decisões Arquiteturais - ADRs (Pilar 4):** [`DOCUMENTACAO/templates/adr.md.template`](./templates/adr.md.template)
- **Ajuda na Tela / UI (Pilar 2):** [`DOCUMENTACAO/templates/ajuda-tela.md.template`](./templates/ajuda-tela.md.template)
- **Contratos de API (Pilar 5):** [`DOCUMENTACAO/templates/contrato-api.md.template`](./templates/contrato-api.md.template)
- **Fluxos de Usuário (Pilar 3):** [`DOCUMENTACAO/templates/fluxo-usuario.md.template`](./templates/fluxo-usuario.md.template)