chore(agent): remover permissoes de commit da IA no projeto e wiki (apenas sugerir texto) e manter push automatico exclusivo no .agent
This commit is contained in:
parent
212d2578f4
commit
26a4f98dab
116 changed files with 1162 additions and 1315 deletions
|
|
@ -2,35 +2,35 @@
|
|||
type: structural
|
||||
name: INDICE
|
||||
description: Índice central navegável dos 6 pilares de documentação e memória do ecossistema
|
||||
updatedAt: "2026-09-01"
|
||||
updatedAt: "2026-10-14"
|
||||
---
|
||||
|
||||
# Í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.
|
||||
Este documento serve como mapa de navegação para os **6 pilares de documentação** do ecossistema, parametrizados pela identidade em `memorias-ia/modulo.yml`.
|
||||
|
||||
---
|
||||
|
||||
## 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>/...`
|
||||
- **Referência de regras de negócio no código:** `// Regras de negócio: ver <modulo-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/`)
|
||||
## 3. Wiki do Usuário (`<modulo-wiki>/<modulo-id>/`)
|
||||
Aplicação VitePress voltada ao **acesso dos usuários e clientes** (caminho `<modulo-wiki>` extraído de `memorias-ia/modulo.yml`, fallback `../wiki/`). Contém manuais operacionais, tutoriais e conceitos funcionais.
|
||||
- **Estrutura:** `<modulo-wiki>/<modulo-id>/`
|
||||
- **Skill:** `skills/documentar-dominio-modulo/SKILL.md`
|
||||
|
||||
## 4. Wiki de Desenvolvimento (`<base_projeto>/../wiki/dev/<modulo-id>/`)
|
||||
## 4. Wiki de Desenvolvimento (`<modulo-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`)
|
||||
- **Estrutura:** `<modulo-wiki>/dev/<modulo-id>/`
|
||||
- **Regras de Negócio:** `<modulo-wiki>/dev/<modulo-id>/` (ver `rules/regras-negocio-md.md`)
|
||||
- **ADRs Técnicos:** `<modulo-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.
|
||||
|
|
@ -38,7 +38,7 @@ Especificação dinâmica servida pelo backend para consumo por agentes e LLMs.
|
|||
|
||||
## 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`)
|
||||
- **Identidade do Módulo:** `<base_projeto>/memorias-ia/modulo.yml` (mandatório com `modulo-id`, `modulo-caminho`, `modulo-descricao`, `modulo-tipo`, `modulo-acesso`, `modulo-wiki`)
|
||||
- **Í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`
|
||||
|
|
|
|||
|
|
@ -2,35 +2,35 @@
|
|||
type: structural
|
||||
name: INDICE
|
||||
description: Índice central navegável dos 6 pilares de documentação e memória do ecossistema
|
||||
updatedAt: "2026-09-01"
|
||||
updatedAt: "2026-10-14"
|
||||
---
|
||||
|
||||
# Í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.
|
||||
Este documento serve como mapa de navegação para os **6 pilares de documentação** do ecossistema, parametrizados pela identidade em `memorias-ia/modulo.yml`.
|
||||
|
||||
---
|
||||
|
||||
## 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>/...`
|
||||
- **Referência de regras de negócio no código:** `// Regras de negócio: ver <modulo-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/`)
|
||||
## 3. Wiki do Usuário (`<modulo-wiki>/<modulo-id>/`)
|
||||
Aplicação VitePress voltada ao **acesso dos usuários e clientes** (caminho `<modulo-wiki>` extraído de `memorias-ia/modulo.yml`, fallback `../wiki/`). Contém manuais operacionais, tutoriais e conceitos funcionais.
|
||||
- **Estrutura:** `<modulo-wiki>/<modulo-id>/`
|
||||
- **Skill:** `skills/documentar-dominio-modulo/SKILL.md`
|
||||
|
||||
## 4. Wiki de Desenvolvimento (`<base_projeto>/../wiki/dev/<modulo-id>/`)
|
||||
## 4. Wiki de Desenvolvimento (`<modulo-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`)
|
||||
- **Estrutura:** `<modulo-wiki>/dev/<modulo-id>/`
|
||||
- **Regras de Negócio:** `<modulo-wiki>/dev/<modulo-id>/` (ver `rules/regras-negocio-md.md`)
|
||||
- **ADRs Técnicos:** `<modulo-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.
|
||||
|
|
@ -38,7 +38,7 @@ Especificação dinâmica servida pelo backend para consumo por agentes e LLMs.
|
|||
|
||||
## 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`)
|
||||
- **Identidade do Módulo:** `<base_projeto>/memorias-ia/modulo.yml` (mandatório com `modulo-id`, `modulo-caminho`, `modulo-descricao`, `modulo-tipo`, `modulo-acesso`, `modulo-wiki`)
|
||||
- **Í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`
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
type: structural
|
||||
name: README
|
||||
description: Manifesto e matriz canônica dos 6 pilares do Documentation-Driven Development (DDD)
|
||||
updatedAt: "2026-09-01"
|
||||
updatedAt: "2026-10-14"
|
||||
---
|
||||
|
||||
# Documentation-Driven Development (DDD)
|
||||
|
|
@ -35,7 +35,7 @@ No ecossistema Azteca, a documentação precede o código. Nenhum artefato (regr
|
|||
| **5. Integração de IA** | Rota Backend `/llm.md` | Markdown dinâmico | Agentes de IA / LLMs | Catálogo vivo de schemas Zod, enums canônicos e contratos de API para consumo por LLMs. |
|
||||
| **6. Memória das Ações da IA e Identidade** | `<base_projeto>/memorias-ia/` | YAML / Markdown | Agentes de IA / Auditoria | Arquivo mandatório `modulo.yml` (`modulo-id`, `modulo-caminho`, `modulo-descricao`, `modulo-tipo`, `modulo-acesso`, `modulo-wiki`), índice central `historico-acoes.md` (`Data \| Memória / Ação \| Arquivo Memoria \| Citações no Código-Fonte`) e arquivos dedicados de sessão `sessao-AAAA-MM-DD-slug.md`. |
|
||||
|
||||
> ℹ️ **Arquitetura VitePress (`<modulo-wiki>`, padrão: `<base_projeto>/../wiki`) e Identidade do Projeto**:
|
||||
> ℹ️ **Arquitetura VitePress (`<modulo-wiki>`, padrão: `../wiki`) e Identidade do Projeto**:
|
||||
> - `<modulo-wiki>` é uma aplicação **VitePress** cujo caminho é definido em `memorias-ia/modulo.yml` (fallback padrão: `../wiki/`).
|
||||
> - `<modulo-wiki>/<modulo-id>/` representa a documentação de **acesso dos usuários e operadores** (onde `<modulo-id>` provém de `memorias-ia/modulo.yml`).
|
||||
> - `<modulo-wiki>/dev/<modulo-id>/` representa a documentação de **acesso interno pela equipe de desenvolvimento e arquitetura**.
|
||||
|
|
@ -53,12 +53,12 @@ Todos os modelos canônicos para instanciar a documentação nos projetos reside
|
|||
| **Identidade do Módulo (Pilar 6)** | `<base_projeto>/memorias-ia/modulo.yml` | [`modulo.yml.template`](./templates/modulo.yml.template) |
|
||||
| **Índice de Ações da IA (Pilar 6)** | `<base_projeto>/memorias-ia/historico-acoes.md` | [`historico-acoes.md.template`](./templates/historico-acoes.md.template) |
|
||||
| **Registro de Sessão da IA (Pilar 6)** | `<base_projeto>/memorias-ia/sessao-AAAA-MM-DD-slug.md` | [`sessao-memoria.md.template`](./templates/sessao-memoria.md.template) |
|
||||
| **Domínio do Módulo (Pilar 3 e 4)** | `<base_projeto>/../wiki/<modulo-id>/index.md` | [`modulo-dominio.md.template`](./templates/modulo-dominio.md.template) |
|
||||
| **Regras de Negócio (Pilar 4)** | `<base_projeto>/../wiki/dev/<modulo-id>/<servico>.regras-negocio.md` | [`regra-negocio.md.template`](./templates/regra-negocio.md.template) |
|
||||
| **Decisões Arquiteturais - ADR (Pilar 4)** | `<base_projeto>/../wiki/dev/<modulo-id>/adrs/` | [`adr.md.template`](./templates/adr.md.template) |
|
||||
| **Domínio do Módulo (Pilar 3 e 4)** | `<modulo-wiki>/<modulo-id>/index.md` | [`modulo-dominio.md.template`](./templates/modulo-dominio.md.template) |
|
||||
| **Regras de Negócio (Pilar 4)** | `<modulo-wiki>/dev/<modulo-id>/<servico>.regras-negocio.md` | [`regra-negocio.md.template`](./templates/regra-negocio.md.template) |
|
||||
| **Decisões Arquiteturais - ADR (Pilar 4)** | `<modulo-wiki>/dev/<modulo-id>/adrs/` | [`adr.md.template`](./templates/adr.md.template) |
|
||||
| **Ajuda na Tela / UI (Pilar 2)** | `*-front/src/.../{componente}.ajuda.md` | [`ajuda-tela.md.template`](./templates/ajuda-tela.md.template) |
|
||||
| **Contratos de API (Pilar 5 e 4)** | Rota `/llm.md` ou `<base_projeto>/../wiki/dev/<modulo-id>/contratos/` | [`contrato-api.md.template`](./templates/contrato-api.md.template) |
|
||||
| **Fluxos e Telas (Pilar 3 e 4)** | `<base_projeto>/../wiki/<modulo-id>/fluxos/` | [`fluxo-usuario.md.template`](./templates/fluxo-usuario.md.template) |
|
||||
| **Contratos de API (Pilar 5 e 4)** | Rota `/llm.md` ou `<modulo-wiki>/dev/<modulo-id>/contratos/` | [`contrato-api.md.template`](./templates/contrato-api.md.template) |
|
||||
| **Fluxos e Telas (Pilar 3 e 4)** | `<modulo-wiki>/<modulo-id>/fluxos/` | [`fluxo-usuario.md.template`](./templates/fluxo-usuario.md.template) |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -76,6 +76,7 @@ Todos os modelos canônicos para instanciar a documentação nos projetos reside
|
|||
## Referências
|
||||
|
||||
- Rule: `rules/ddd-documentacao-primeiro.md`
|
||||
- Rule: `rules/identidade-modulo.md`
|
||||
- Rule: `rules/jsdoc-padrao.md`
|
||||
- Rule: `rules/regras-negocio-md.md`
|
||||
- Skill: `skills/adicionar-ajuda/SKILL.md`
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
type: structural
|
||||
name: README
|
||||
description: Manifesto e matriz canônica dos 6 pilares do Documentation-Driven Development (DDD)
|
||||
updatedAt: "2026-09-01"
|
||||
updatedAt: "2026-10-14"
|
||||
---
|
||||
|
||||
# Documentation-Driven Development (DDD)
|
||||
|
|
@ -30,16 +30,17 @@ No ecossistema Azteca, a documentação precede o código. Nenhum artefato (regr
|
|||
| :--- | :--- | :--- | :--- | :--- |
|
||||
| **1. Código-Fonte** | `.ts`, `.vue`, `.js` | JSDoc + comentários inline | Desenvolvedores / IA | Comentários claros e coerentes quanto à aplicação prática e contexto de negócio. |
|
||||
| **2. Ajuda na Tela (UI)** | `*-front/.../{componente}.ajuda.md` | Markdown co-localizado | Usuários da UI | Para `modalX.vue`, o arquivo **DEVE** ser `modalX.ajuda.md`. Explica objetivo, botões, campos e instruções de uso. |
|
||||
| **3. Wiki do Usuário** | `<base_projeto>/../wiki/<modulo-id>/` | Markdown (VitePress) | Usuários / Clientes | Aplicação VitePress voltada ao acesso dos usuários. Manuais operacionais, tutoriais de uso, conceitos de negócio e fluxos da aplicação. |
|
||||
| **4. Wiki de Desenvolvimento** | `<base_projeto>/../wiki/dev/<modulo-id>/` | Markdown (VitePress) | Desenvolvedores / Arquitetos | Aplicação VitePress com acesso interno exclusivo da equipe de desenvolvimento. Arquitetura técnica, modelos de banco, regras de negócio (`{modulo}.regras-negocio.md`), filas BullMQ, CRONs e ADRs. |
|
||||
| **3. Wiki do Usuário** | `<modulo-wiki>/<modulo-id>/` | Markdown (VitePress) | Usuários / Clientes | Aplicação VitePress voltada ao acesso dos usuários. Manuais operacionais, tutoriais de uso, conceitos de negócio e fluxos da aplicação. Arquivos e mídias pesadas no MinIO Paiol. |
|
||||
| **4. Wiki de Desenvolvimento** | `<modulo-wiki>/dev/<modulo-id>/` | Markdown (VitePress) | Desenvolvedores / Arquitetos | Aplicação VitePress com acesso interno exclusivo da equipe de desenvolvimento. Arquitetura técnica, modelos de banco, regras de negócio (`{modulo}.regras-negocio.md`), filas BullMQ, CRONs e ADRs. |
|
||||
| **5. Integração de IA** | Rota Backend `/llm.md` | Markdown dinâmico | Agentes de IA / LLMs | Catálogo vivo de schemas Zod, enums canônicos e contratos de API para consumo por LLMs. |
|
||||
| **6. Memória das Ações da IA e Identidade** | `<base_projeto>/memorias-ia/` | YAML / Markdown | Agentes de IA / Auditoria | Arquivo mandatório `modulo.yml` (`modulo-id`, `modulo-caminho`, `modulo-descricao`, `modulo-tipo`), índice central `historico-acoes.md` (`Data \| Memória / Ação \| Arquivo Memoria \| Citações no Código-Fonte`) e arquivos dedicados de sessão `sessao-AAAA-MM-DD-slug.md`. |
|
||||
| **6. Memória das Ações da IA e Identidade** | `<base_projeto>/memorias-ia/` | YAML / Markdown | Agentes de IA / Auditoria | Arquivo mandatório `modulo.yml` (`modulo-id`, `modulo-caminho`, `modulo-descricao`, `modulo-tipo`, `modulo-acesso`, `modulo-wiki`), índice central `historico-acoes.md` (`Data \| Memória / Ação \| Arquivo Memoria \| Citações no Código-Fonte`) e arquivos dedicados de sessão `sessao-AAAA-MM-DD-slug.md`. |
|
||||
|
||||
> ℹ️ **Arquitetura VitePress (`<base_projeto>/../wiki`) e Identidade do Projeto**:
|
||||
> - `<base_projeto>/../wiki/` é uma aplicação **VitePress**.
|
||||
> - `<base_projeto>/../wiki/<modulo-id>/` representa a documentação de **acesso dos usuários e operadores** (onde `<modulo-id>` provém de `memorias-ia/modulo.yml`).
|
||||
> - `<base_projeto>/../wiki/dev/<modulo-id>/` representa a documentação de **acesso interno pela equipe de desenvolvimento e arquitetura**.
|
||||
> - O arquivo `<base_projeto>/memorias-ia/modulo.yml` é **obrigatório em todos os projetos** e define `modulo-id`, `modulo-caminho`, `modulo-descricao` e `modulo-tipo`.
|
||||
> ℹ️ **Arquitetura VitePress (`<modulo-wiki>`, padrão: `../wiki`) e Identidade do Projeto**:
|
||||
> - `<modulo-wiki>` é uma aplicação **VitePress** cujo caminho é definido em `memorias-ia/modulo.yml` (fallback padrão: `../wiki/`).
|
||||
> - `<modulo-wiki>/<modulo-id>/` representa a documentação de **acesso dos usuários e operadores** (onde `<modulo-id>` provém de `memorias-ia/modulo.yml`).
|
||||
> - `<modulo-wiki>/dev/<modulo-id>/` representa a documentação de **acesso interno pela equipe de desenvolvimento e arquitetura**.
|
||||
> - O arquivo `<base_projeto>/memorias-ia/modulo.yml` é **obrigatório em todos os projetos**.
|
||||
> - **Mídias e Arquivos no MinIO Paiol:** Imagens, manuais em PDF, gravações em vídeo e anexos pesados **NUNCA** devem ser commitados no Git da Wiki; devem ser enviados ao MinIO Paiol via `./.agent/scripts/upload-paiol-wiki.sh` e referenciados via URLs `https://paiol.idz.one/wiki/...`.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -52,12 +53,12 @@ Todos os modelos canônicos para instanciar a documentação nos projetos reside
|
|||
| **Identidade do Módulo (Pilar 6)** | `<base_projeto>/memorias-ia/modulo.yml` | [`modulo.yml.template`](./templates/modulo.yml.template) |
|
||||
| **Índice de Ações da IA (Pilar 6)** | `<base_projeto>/memorias-ia/historico-acoes.md` | [`historico-acoes.md.template`](./templates/historico-acoes.md.template) |
|
||||
| **Registro de Sessão da IA (Pilar 6)** | `<base_projeto>/memorias-ia/sessao-AAAA-MM-DD-slug.md` | [`sessao-memoria.md.template`](./templates/sessao-memoria.md.template) |
|
||||
| **Domínio do Módulo (Pilar 3 e 4)** | `<base_projeto>/../wiki/<modulo-id>/index.md` | [`modulo-dominio.md.template`](./templates/modulo-dominio.md.template) |
|
||||
| **Regras de Negócio (Pilar 4)** | `<base_projeto>/../wiki/dev/<modulo-id>/<servico>.regras-negocio.md` | [`regra-negocio.md.template`](./templates/regra-negocio.md.template) |
|
||||
| **Decisões Arquiteturais - ADR (Pilar 4)** | `<base_projeto>/../wiki/dev/<modulo-id>/adrs/` | [`adr.md.template`](./templates/adr.md.template) |
|
||||
| **Domínio do Módulo (Pilar 3 e 4)** | `<modulo-wiki>/<modulo-id>/index.md` | [`modulo-dominio.md.template`](./templates/modulo-dominio.md.template) |
|
||||
| **Regras de Negócio (Pilar 4)** | `<modulo-wiki>/dev/<modulo-id>/<servico>.regras-negocio.md` | [`regra-negocio.md.template`](./templates/regra-negocio.md.template) |
|
||||
| **Decisões Arquiteturais - ADR (Pilar 4)** | `<modulo-wiki>/dev/<modulo-id>/adrs/` | [`adr.md.template`](./templates/adr.md.template) |
|
||||
| **Ajuda na Tela / UI (Pilar 2)** | `*-front/src/.../{componente}.ajuda.md` | [`ajuda-tela.md.template`](./templates/ajuda-tela.md.template) |
|
||||
| **Contratos de API (Pilar 5 e 4)** | Rota `/llm.md` ou `<base_projeto>/../wiki/dev/<modulo-id>/contratos/` | [`contrato-api.md.template`](./templates/contrato-api.md.template) |
|
||||
| **Fluxos e Telas (Pilar 3 e 4)** | `<base_projeto>/../wiki/<modulo-id>/fluxos/` | [`fluxo-usuario.md.template`](./templates/fluxo-usuario.md.template) |
|
||||
| **Contratos de API (Pilar 5 e 4)** | Rota `/llm.md` ou `<modulo-wiki>/dev/<modulo-id>/contratos/` | [`contrato-api.md.template`](./templates/contrato-api.md.template) |
|
||||
| **Fluxos e Telas (Pilar 3 e 4)** | `<modulo-wiki>/<modulo-id>/fluxos/` | [`fluxo-usuario.md.template`](./templates/fluxo-usuario.md.template) |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -75,6 +76,7 @@ Todos os modelos canônicos para instanciar a documentação nos projetos reside
|
|||
## Referências
|
||||
|
||||
- Rule: `rules/ddd-documentacao-primeiro.md`
|
||||
- Rule: `rules/identidade-modulo.md`
|
||||
- Rule: `rules/jsdoc-padrao.md`
|
||||
- Rule: `rules/regras-negocio-md.md`
|
||||
- Skill: `skills/adicionar-ajuda/SKILL.md`
|
||||
|
|
|
|||
|
|
@ -7,10 +7,11 @@ updatedAt: "2026-09-02"
|
|||
|
||||
<!--
|
||||
DESTINO CANÔNICO NO PROJETO:
|
||||
- Wiki de Desenvolvimento (Pilar 4): ../../wiki/dev/<modulo-id>/adrs/{numero}-{titulo-kebab-case}.md
|
||||
- Wiki de Desenvolvimento (Pilar 4): <modulo-wiki>/dev/<modulo-id>/adrs/{numero}-{titulo-kebab-case}.md
|
||||
(onde <modulo-wiki> e <modulo-id> são extraídos de memorias-ia/modulo.yml; fallback de wiki: ../wiki)
|
||||
|
||||
EXEMPLO:
|
||||
../../wiki/dev/e-licencie.sigma/adrs/001-adopcao-bullmq-processamento-noturno.md
|
||||
<modulo-wiki>/dev/<modulo-id>/adrs/001-adopcao-bullmq-processamento-noturno.md
|
||||
-->
|
||||
|
||||
# ADR [NUMERO]: [TÍTULO DA DECISÃO ARQUITETURAL]
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ updatedAt: "2026-09-02"
|
|||
<!--
|
||||
DESTINO CANÔNICO NO PROJETO:
|
||||
- Rota Dinâmica de IA (Pilar 5): servido dinamicamente pelo backend em /llm.md ou <modulo-caminho>llm.md
|
||||
- Wiki de Desenvolvimento (Pilar 4): ../../wiki/dev/<modulo-id>/contratos/{servico}.contrato.md
|
||||
- Wiki de Desenvolvimento (Pilar 4): <modulo-wiki>/dev/<modulo-id>/contratos/{servico}.contrato.md
|
||||
-->
|
||||
|
||||
# Contrato de API — [Nome do Serviço / Endpoint]
|
||||
|
|
|
|||
|
|
@ -7,8 +7,8 @@ updatedAt: "2026-09-02"
|
|||
|
||||
<!--
|
||||
DESTINO CANÔNICO NO PROJETO:
|
||||
- Wiki do Usuário (Pilar 3): ../../wiki/<modulo-id>/fluxos/{nome-do-fluxo}.md
|
||||
- Wiki de Desenvolvimento (Pilar 4 - Fluxos Técnicos/Jobs): ../../wiki/dev/<modulo-id>/fluxos/{nome-do-fluxo}.md
|
||||
- Wiki do Usuário (Pilar 3): <modulo-wiki>/<modulo-id>/fluxos/{nome-do-fluxo}.md
|
||||
- Wiki de Desenvolvimento (Pilar 4 - Fluxos Técnicos/Jobs): <modulo-wiki>/dev/<modulo-id>/fluxos/{nome-do-fluxo}.md
|
||||
-->
|
||||
|
||||
# Fluxo de Usuário: [Nome da Jornada / Processo]
|
||||
|
|
|
|||
|
|
@ -7,12 +7,13 @@ updatedAt: "2026-09-02"
|
|||
|
||||
<!--
|
||||
DESTINO CANÔNICO NO PROJETO:
|
||||
- Wiki do Usuário (Pilar 3): <base_projeto>/../wiki/<modulo-id>/index.md
|
||||
- Wiki de Desenvolvimento (Pilar 4): <base_projeto>/../wiki/dev/<modulo-id>/index.md
|
||||
- Wiki do Usuário (Pilar 3): <modulo-wiki>/<modulo-id>/index.md
|
||||
- Wiki de Desenvolvimento (Pilar 4): <modulo-wiki>/dev/<modulo-id>/index.md
|
||||
|
||||
VARIÁVEIS A PREENCHER:
|
||||
- <modulo-id>: ID obtido em memorias-ia/modulo.yml (ex: e-licencie.sigma)
|
||||
- <NOME DO MÓDULO>: Nome legível do módulo (ex: SIGMA - Monitoramento Ambiental)
|
||||
- <modulo-id>: ID obtido em memorias-ia/modulo.yml
|
||||
- <modulo-wiki>: Caminho da Wiki obtido em memorias-ia/modulo.yml (fallback: ../wiki)
|
||||
- <NOME DO MÓDULO>: Nome legível do módulo
|
||||
-->
|
||||
|
||||
# Módulo: <NOME DO MÓDULO>
|
||||
|
|
|
|||
|
|
@ -24,9 +24,9 @@ status: "pendente" # pendente | executado | cancelado
|
|||
prioridade: "media" # critica | alta | media | baixa
|
||||
tipo: "bug" # bug | melhoria | feature | refatoracao | ux
|
||||
modulos-impactados:
|
||||
- QUIPO-BACK
|
||||
- QUIPO-FRONT
|
||||
- QUIPO-COMUNS
|
||||
- <modulo>-back
|
||||
- <modulo>-front
|
||||
- <modulo>-comuns
|
||||
executor: null
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -7,11 +7,11 @@ updatedAt: "2026-09-02"
|
|||
|
||||
<!--
|
||||
DESTINO CANÔNICO NO PROJETO:
|
||||
- Wiki de Desenvolvimento (Pilar 4): <base_projeto>/../wiki/dev/<modulo-id>/{nome-servico}.regras-negocio.md
|
||||
ou <base_projeto>/../wiki/dev/<modulo-id>/regras-negocio/{nome-regra}.md
|
||||
- Wiki de Desenvolvimento (Pilar 4): <modulo-wiki>/dev/<modulo-id>/{nome-servico}.regras-negocio.md
|
||||
ou <modulo-wiki>/dev/<modulo-id>/regras-negocio/{nome-regra}.md
|
||||
|
||||
REFERÊNCIA NO CÓDIGO TYPESCRIPT (primeira linha útil):
|
||||
// Regras de negócio: ver <base_projeto>/../wiki/dev/<modulo-id>/{nome-servico}.regras-negocio.md
|
||||
// Regras de negócio: ver <modulo-wiki>/dev/<modulo-id>/{nome-servico}.regras-negocio.md
|
||||
-->
|
||||
|
||||
# Regras de Negócio — [Nome do Serviço / Funcionalidade]
|
||||
|
|
|
|||
|
|
@ -43,8 +43,8 @@ tags: [modulo-id, contexto, acao]
|
|||
|
||||
- **Pilar 1 (Código):** JSDoc inserido em `caminho/arquivo1.ts`
|
||||
- **Pilar 2 (Ajuda UI):** `modalX.ajuda.md` (quando aplicável)
|
||||
- **Pilar 3 (Wiki Usuário):** `<base_projeto>/../wiki/<modulo-id>/...`
|
||||
- **Pilar 4 (Wiki Dev):** `<base_projeto>/../wiki/dev/<modulo-id>/...`
|
||||
- **Pilar 3 (Wiki Usuário):** `<modulo-wiki>/<modulo-id>/...`
|
||||
- **Pilar 4 (Wiki Dev):** `<modulo-wiki>/dev/<modulo-id>/...`
|
||||
- **Pilar 5 (Rota IA):** `/llm.md`
|
||||
- **Pilar 6 (Memória IA):** Registrado neste arquivo e indexado em `historico-acoes.md`
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue