152 lines
8.2 KiB
Markdown
Executable File
152 lines
8.2 KiB
Markdown
Executable File
# Índice de Documentação SysCMS
|
|
|
|
Este arquivo organiza toda a documentação do SysCMS em uma hierarquia lógica para facilitar a navegação.
|
|
|
|
## 📋 Hierarquia de Documentos
|
|
|
|
### 1. Documentos Fundamentais (Leitura Obrigatória)
|
|
Estes documentos definem a base do sistema e devem ser lidos em ordem:
|
|
|
|
| Ordem | Arquivo | Descrição | Tipo |
|
|
|-------|---------|-----------|------|
|
|
| 0 | [00_POLITICA_MEMORIAS_CORE.md](00_POLITICA_MEMORIAS_CORE.md) | Política de uso de memórias core da IA | Governança |
|
|
| 1 | [../CONTEXT.md](../CONTEXT.md) | Contexto arquitetural imutável do sistema | Governança |
|
|
| 2 | [../DECISIONS.md](../DECISIONS.md) | Filosofia e decisões técnicas de base | Governança |
|
|
| 3 | [RULES.md](RULES.md) | Regras operacionais e convenções do projeto | Execução |
|
|
|
|
### 2. Regras Detalhadas por Categoria
|
|
|
|
#### 🎯 Fundamentos (01-09)
|
|
Conceitos base e comportamentos essenciais para a IA e desenvolvedores.
|
|
|
|
| Numeração | Arquivo | Descrição |
|
|
|-----------|---------|-----------|
|
|
| 01 | [01_COMPORTAMENTO_IA.md](01_COMPORTAMENTO_IA.md) | Comportamento esperado da IA, autonomia vs preservação |
|
|
| 02 | [02_ARQUITETURA.md](02_ARQUITETURA.md) | Estrutura de diretórios e arquitetura do sistema |
|
|
| 03 | [03_MODULOS.md](03_MODULOS.md) | Sistema de módulos, estrutura e module.json |
|
|
| 04 | [04_TECNOLOGIAS.md](04_TECNOLOGIAS.md) | Stack tecnológica (PHP, Bootstrap, Twig, etc) |
|
|
| 05 | [05_PADROES_CODIGO.md](05_PADROES_CODIGO.md) | Padrões de código, naming conventions e estilo |
|
|
| 06 | [06_DEVELOPER_GUIDE.md](06_DEVELOPER_GUIDE.md) | Guia completo para desenvolvedores |
|
|
| 07 | [07_ENVIRONMENT_USAGE.md](07_ENVIRONMENT_USAGE.md) | Uso do Docker e ambiente de desenvolvimento |
|
|
| 08 | [08_IA_COMMAND_EXECUTION_GUIDE.md](08_IA_COMMAND_EXECUTION_GUIDE.md) | Guia de execução de comandos pela IA |
|
|
| 09 | [09_LANGUAGE_CONFIG_README.md](09_LANGUAGE_CONFIG_README.md) | Configuração de idiomas e internacionalização |
|
|
|
|
#### 🔄 Ciclo de Vida (10-19)
|
|
Fluxo de execução e ciclo de vida da aplicação.
|
|
|
|
| Numeração | Arquivo | Descrição |
|
|
|-----------|---------|-----------|
|
|
| 10 | [10_LIFECYCLE.md](10_LIFECYCLE.md) | Ciclo de vida da aplicação (requisição → resposta) |
|
|
| 11 | [11_USER_GUIDE.md](11_USER_GUIDE.md) | Guia do usuário final |
|
|
| 12 | [12_MANUAL_COMO_CRIAR_MODULOS_PARA_INSTALAR.md](12_MANUAL_COMO_CRIAR_MODULOS_PARA_INSTALAR.md) | Manual detalhado de criação de módulos |
|
|
| 13 | [13_USER_GUIDE.md](13_USER_GUIDE.md) | Guia de uso do sistema (complementar) |
|
|
| 14 | [14_COMO_USAR_HOOK.md](14_COMO_USAR_HOOK.md) | Sistema de Hooks (Actions e Filters) |
|
|
| 15 | [15_MODULE_TEMPLATE.md](15_MODULE_TEMPLATE.md) | Template de estrutura de módulo |
|
|
| 16 | [16_REGRAS_QUILL_IA.md](16_REGRAS_QUILL_IA.md) | Regras específicas para IA usando Quill |
|
|
| 17 | [17_QUILL_IMPLEMENTATION_COMPLETE.md](17_QUILL_IMPLEMENTATION_COMPLETE.md) | Implementação completa do editor Quill |
|
|
| 18 | [18_THEMES_CUSTOMIZER.md](18_THEMES_CUSTOMIZER.md) | Sistema de temas e customização |
|
|
| 19 | [19_INTEGRACAO_GLOBALLISTS.md](19_INTEGRACAO_GLOBALLISTS.md) | Integração com módulo GlobalLists (endereços) |
|
|
|
|
#### 🚀 Implementação (20-29)
|
|
Guias práticos para criação e implementação.
|
|
|
|
| Numeração | Arquivo | Descrição |
|
|
|-----------|---------|-----------|
|
|
| 20 | [20_CRIACAO_DE_NOVOS_MODULOS.md](20_CRIACAO_DE_NOVOS_MODULOS.md) | Guia de criação de novos módulos |
|
|
|
|
#### 📦 Específicos (50-59)
|
|
Regras específicas para funcionalidades pontuais.
|
|
|
|
| Numeração | Arquivo | Descrição |
|
|
|-----------|---------|-----------|
|
|
| 50 | [50_LAYOUTS_CORRETOS.md](50_LAYOUTS_CORRETOS.md) | Layouts Twig corretos (dashboard.twig) |
|
|
| 51 | [51_UPLOADS_STORAGE.md](51_UPLOADS_STORAGE.md) | Regras de armazenamento de arquivos e uploads |
|
|
|
|
#### 📄 Outros Documentos
|
|
Documentos sem numeração específica ou planos de implementação.
|
|
|
|
| Arquivo | Descrição |
|
|
|---------|-----------|
|
|
| [README.md](README.md) | Visão geral e início rápido |
|
|
| [QUILL_IMPLEMENTATION_PLAN.md](QUILL_IMPLEMENTATION_PLAN.md) | Plano de implementação do Quill |
|
|
|
|
## 🎯 Política de Single Source of Truth
|
|
|
|
Cada categoria de regra tem um **único arquivo principal** que deve ser considerado a fonte da verdade:
|
|
|
|
| Categoria | Fonte da Verdade | Referências |
|
|
|-----------|------------------|-------------|
|
|
| Comportamento da IA | RULES.md (seções 1-3) | 01_COMPORTAMENTO_IA.md |
|
|
| Padrões de Código | RULES.md (seção 2) | 05_PADROES_CODIGO.md |
|
|
| Frontend/UX | RULES.md (seção 3) | 04_TECNOLOGIAS.md, 50_LAYOUTS_CORRETOS.md |
|
|
| Banco de Dados | RULES.md (seção 4) | 03_MODULOS.md |
|
|
| Uploads/Storage | RULES.md (seção 6) | 51_UPLOADS_STORAGE.md |
|
|
| Módulos | 03_MODULOS.md | 12_MANUAL_COMO_CRIAR_MODULOS_PARA_INSTALAR.md, 20_CRIACAO_DE_NOVOS_MODULOS.md |
|
|
| Hooks | 14_COMO_USAR_HOOK.md | - |
|
|
| Temas | 18_THEMES_CUSTOMIZER.md | - |
|
|
| GlobalLists | 19_INTEGRACAO_GLOBALLISTS.md | - |
|
|
| Quill | 17_QUILL_IMPLEMENTATION_COMPLETE.md | 16_REGRAS_QUILL_IA.md |
|
|
|
|
### ⚠️ Política de Memórias Core
|
|
|
|
**AS MEMÓRIAS CORE SÃO APENAS SUPLEMENTARES** e **NÃO DEVEM SER USADAS COMO FONTE DE VERDADE**.
|
|
|
|
- **Regra Obrigatória**: Sempre consulte os arquivos de regras (RULES.md, CONTEXT.md, arquivos em /rules/) como **fonte primária** de informação
|
|
- **Uso de Memórias Core**: As memórias servem apenas como **atalhos rápidos** para informações estáticas que não mudam com frequência (ex: credenciais de banco de dados, URLs de API)
|
|
- **Conflito**: Se houver conflito entre uma memória core e um arquivo de regras, **o arquivo de regras sempre prevalece**
|
|
- **Manutenção**: As memórias core são mantidas apenas para acelerar buscas frequentes, não para substituir a documentação formal
|
|
|
|
### 📋 Categorias de Informação (Fonte vs Memória)
|
|
|
|
| Tipo de Informação | Fonte da Verdade | Pode estar em Memória Core? |
|
|
|-------------------|------------------|---------------------------|
|
|
| Regras de desenvolvimento | RULES.md, /rules/ | ❌ NÃO |
|
|
| Padrões de código | 05_PADROES_CODIGO.md | ❌ NÃO |
|
|
| Estrutura de módulos | 03_MODULOS.md | ❌ NÃO |
|
|
| Configurações de ambiente | 07_ENVIRONMENT_USAGE.md | ✅ SIM (credenciais estáticas) |
|
|
| URLs de API | RULES.md, /rules/ | ✅ SIM (endpoints estáticos) |
|
|
| Arquitetura do sistema | 02_ARQUITETURA.md | ❌ NÃO |
|
|
| Compatibilidade ERP Legado | ../CONTEXT.md | ❌ NÃO |
|
|
|
|
## ⚠️ Regras Críticas
|
|
|
|
As seguintes regras são **imutáveis** e devem ser seguidas estritamente:
|
|
|
|
1. **NUNCA alterar arquivos do Core** (kernel/, app/Controllers/, app/Models/)
|
|
2. **NUNCA alterar módulos com `ready: true`** (exceto correção de bugs reportados)
|
|
3. **NUNCA gravar arquivos em `public/`** (usar `storage/uploads/`)
|
|
4. **NUNCA usar FontAwesome** (apenas Bootstrap Icons)
|
|
5. **NUNCA usar layouts inexistentes** (usar apenas `layouts/dashboard.twig`)
|
|
6. **NUNCA usar Alpine.js em selects GlobalLists** (usar Vanilla JS)
|
|
7. **SEMPRE usar DataTables** para tabelas de listagem
|
|
8. **SEMPRE priorizar ERP Legado** em caso de conflito
|
|
|
|
## 📖 Ordem de Leitura Recomendada
|
|
|
|
### Para Novos Desenvolvedores:
|
|
1. [README.md](README.md) - Visão geral
|
|
2. [../CONTEXT.md](../CONTEXT.md) - Contexto arquitetural
|
|
3. [RULES.md](RULES.md) - Regras operacionais
|
|
4. [01_COMPORTAMENTO_IA.md](01_COMPORTAMENTO_IA.md) - Comportamento da IA
|
|
5. [03_MODULOS.md](03_MODULOS.md) - Sistema de módulos
|
|
6. [05_PADROES_CODIGO.md](05_PADROES_CODIGO.md) - Padrões de código
|
|
|
|
### Para IA Coder:
|
|
1. [RULES.md](RULES.md) - Regras operacionais (prioridade)
|
|
2. [01_COMPORTAMENTO_IA.md](01_COMPORTAMENTO_IA.md) - Autonomia vs Preservação
|
|
3. [../CONTEXT.md](../CONTEXT.md) - Compatibilidade com ERP Legado
|
|
4. [50_LAYOUTS_CORRETOS.md](50_LAYOUTS_CORRETOS.md) - Layouts Twig
|
|
5. [51_UPLOADS_STORAGE.md](51_UPLOADS_STORAGE.md) - Uploads e Storage
|
|
|
|
### Para Desenvolvedor de Módulos:
|
|
1. [03_MODULOS.md](03_MODULOS.md) - Sistema de módulos
|
|
2. [12_MANUAL_COMO_CRIAR_MODULOS_PARA_INSTALAR.md](12_MANUAL_COMO_CRIAR_MODULOS_PARA_INSTALAR.md) - Manual detalhado
|
|
3. [15_MODULE_TEMPLATE.md](15_MODULE_TEMPLATE.md) - Template de módulo
|
|
4. [20_CRIACAO_DE_NOVOS_MODULOS.md](20_CRIACAO_DE_NOVOS_MODULOS.md) - Guia de criação
|
|
5. [14_COMO_USAR_HOOK.md](14_COMO_USAR_HOOK.md) - Sistema de Hooks
|
|
|
|
---
|
|
|
|
**Última Atualização**: 2025-01-19
|
|
**Versão**: 1.0.0
|