@onion-architect-ai/cli 4.1.0-beta.4 → 4.1.0-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cli.js +1 -1
- package/dist/cli.js.map +1 -1
- package/package.json +1 -1
- package/templates/.cursor/agents/development/c4-architecture-specialist.md +712 -0
- package/templates/.cursor/agents/development/c4-documentation-specialist.md +658 -0
- package/templates/.cursor/agents/development/clickup-specialist.md +397 -0
- package/templates/.cursor/agents/development/cursor-specialist.md +249 -0
- package/templates/.cursor/agents/development/docs-reverse-engineer.md +418 -0
- package/templates/.cursor/agents/development/gamma-api-specialist.md +1169 -0
- package/templates/.cursor/agents/development/gitflow-specialist.md +1207 -0
- package/templates/.cursor/agents/development/linux-security-specialist.md +676 -0
- package/templates/.cursor/agents/development/mermaid-specialist.md +516 -0
- package/templates/.cursor/agents/development/nodejs-specialist.md +673 -0
- package/templates/.cursor/agents/development/nx-migration-specialist.md +867 -0
- package/templates/.cursor/agents/development/nx-monorepo-specialist.md +619 -0
- package/templates/.cursor/agents/development/postgres-specialist.md +1124 -0
- package/templates/.cursor/agents/development/react-developer.md +132 -0
- package/templates/.cursor/agents/development/runflow-specialist.md +278 -0
- package/templates/.cursor/agents/development/system-documentation-orchestrator.md +1388 -0
- package/templates/.cursor/agents/development/task-specialist.md +618 -0
- package/templates/.cursor/agents/development/whisper-specialist.md +373 -0
- package/templates/.cursor/agents/development/zen-engine-specialist.md +421 -0
- package/templates/.cursor/agents/git/branch-code-reviewer.md +200 -0
- package/templates/.cursor/agents/git/branch-documentation-writer.md +162 -0
- package/templates/.cursor/agents/git/branch-metaspec-checker.md +68 -0
- package/templates/.cursor/agents/git/branch-test-planner.md +177 -0
- package/templates/.cursor/agents/product/branding-positioning-specialist.md +1030 -0
- package/templates/.cursor/agents/product/extract-meeting-specialist.md +395 -0
- package/templates/.cursor/agents/product/meeting-consolidator.md +483 -0
- package/templates/.cursor/agents/product/pain-price-specialist.md +509 -0
- package/templates/.cursor/agents/product/presentation-orchestrator.md +1191 -0
- package/templates/.cursor/agents/product/product-agent.md +202 -0
- package/templates/.cursor/agents/product/story-points-framework-specialist.md +539 -0
- package/templates/.cursor/agents/product/storytelling-business-specialist.md +891 -0
- package/templates/.cursor/agents/review/code-reviewer.md +155 -0
- package/templates/.cursor/agents/testing/test-agent.md +425 -0
- package/templates/.cursor/agents/testing/test-engineer.md +295 -0
- package/templates/.cursor/agents/testing/test-planner.md +118 -0
- package/templates/.cursor/commands/docs/build-business-docs.md +276 -0
- package/templates/.cursor/commands/docs/build-index.md +128 -0
- package/templates/.cursor/commands/docs/build-tech-docs.md +204 -0
- package/templates/.cursor/commands/docs/consolidate-documents.md +424 -0
- package/templates/.cursor/commands/docs/docs-health.md +142 -0
- package/templates/.cursor/commands/docs/help.md +306 -0
- package/templates/.cursor/commands/docs/refine-vision.md +27 -0
- package/templates/.cursor/commands/docs/reverse-consolidate.md +160 -0
- package/templates/.cursor/commands/docs/sync-sessions.md +320 -0
- package/templates/.cursor/commands/docs/validate-docs.md +159 -0
- package/templates/.cursor/commands/engineer/bump.md +43 -0
- package/templates/.cursor/commands/engineer/docs.md +39 -0
- package/templates/.cursor/commands/engineer/help.md +329 -0
- package/templates/.cursor/commands/engineer/hotfix.md +186 -0
- package/templates/.cursor/commands/engineer/plan.md +111 -0
- package/templates/.cursor/commands/engineer/pr-update.md +198 -0
- package/templates/.cursor/commands/engineer/pr.md +136 -0
- package/templates/.cursor/commands/engineer/pre-pr.md +91 -0
- package/templates/.cursor/commands/engineer/start.md +266 -0
- package/templates/.cursor/commands/engineer/validate-phase-sync.md +118 -0
- package/templates/.cursor/commands/engineer/warm-up.md +173 -0
- package/templates/.cursor/commands/engineer/work.md +169 -0
- package/templates/.cursor/commands/git/code-review.md +215 -0
- package/templates/.cursor/commands/git/fast-commit.md +45 -0
- package/templates/.cursor/commands/git/feature/finish.md +90 -0
- package/templates/.cursor/commands/git/feature/publish.md +91 -0
- package/templates/.cursor/commands/git/feature/start.md +158 -0
- package/templates/.cursor/commands/git/help.md +306 -0
- package/templates/.cursor/commands/git/hotfix/finish.md +98 -0
- package/templates/.cursor/commands/git/hotfix/start.md +94 -0
- package/templates/.cursor/commands/git/init.md +139 -0
- package/templates/.cursor/commands/git/release/finish.md +98 -0
- package/templates/.cursor/commands/git/release/start.md +95 -0
- package/templates/.cursor/commands/git/sync.md +228 -0
- package/templates/.cursor/commands/global/help.md +388 -0
- package/templates/.cursor/commands/product/analyze-pain-price.md +709 -0
- package/templates/.cursor/commands/product/branding.md +460 -0
- package/templates/.cursor/commands/product/check.md +48 -0
- package/templates/.cursor/commands/product/checklist-sync.md +241 -0
- package/templates/.cursor/commands/product/collect.md +96 -0
- package/templates/.cursor/commands/product/consolidate-meetings.md +306 -0
- package/templates/.cursor/commands/product/convert-to-tasks.md +220 -0
- package/templates/.cursor/commands/product/estimate.md +519 -0
- package/templates/.cursor/commands/product/extract-meeting.md +241 -0
- package/templates/.cursor/commands/product/feature.md +431 -0
- package/templates/.cursor/commands/product/help.md +212 -0
- package/templates/.cursor/commands/product/light-arch.md +97 -0
- package/templates/.cursor/commands/product/presentation.md +189 -0
- package/templates/.cursor/commands/product/refine.md +186 -0
- package/templates/.cursor/commands/product/spec.md +107 -0
- package/templates/.cursor/commands/product/task-check.md +340 -0
- package/templates/.cursor/commands/product/task.md +585 -0
- package/templates/.cursor/commands/product/transform-consolidated.md +592 -0
- package/templates/.cursor/commands/product/validate-task.md +294 -0
- package/templates/.cursor/commands/product/warm-up.md +187 -0
- package/templates/.cursor/commands/product/whisper.md +325 -0
- package/templates/.cursor/commands/test/e2e.md +392 -0
- package/templates/.cursor/commands/test/integration.md +523 -0
- package/templates/.cursor/commands/test/unit.md +378 -0
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: build-index
|
|
3
|
+
description: Gerenciar e atualizar índices de documentação.
|
|
4
|
+
model: sonnet
|
|
5
|
+
category: docs
|
|
6
|
+
tags: [index, navigation, documentation]
|
|
7
|
+
version: "4.0.0"
|
|
8
|
+
updated: "2025-12-20"
|
|
9
|
+
level: intermediate
|
|
10
|
+
context: technical
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
Este comando gerencia os índices de documentação do Granaai, mantendo a estrutura organizada e navegável.
|
|
14
|
+
|
|
15
|
+
**Estrutura de Documentação do Granaai**:
|
|
16
|
+
```
|
|
17
|
+
docs/
|
|
18
|
+
├── INDEX.md # Índice principal (hub central)
|
|
19
|
+
├── business-context/ # Contexto de negócio (15 arquivos)
|
|
20
|
+
│ └── index.md
|
|
21
|
+
├── technical-context/ # Contexto técnico (15 arquivos)
|
|
22
|
+
│ └── index.md
|
|
23
|
+
├── compliance/ # Compliance e Governança (18 arquivos) ✨ NOVO
|
|
24
|
+
│ ├── index.md
|
|
25
|
+
│ ├── security/ # ISO 27001 (3 arquivos)
|
|
26
|
+
│ ├── business-continuity/ # ISO 22301 (5 arquivos)
|
|
27
|
+
│ ├── soc2/ # SOC2 Type II (4 arquivos)
|
|
28
|
+
│ ├── ai-governance/ # AI Governance (1 arquivo)
|
|
29
|
+
│ ├── privacy/ # LGPD (1 arquivo)
|
|
30
|
+
│ └── due-diligence/ # Due Diligence (4 arquivos)
|
|
31
|
+
├── onion/ # Sistema Onion (22 arquivos)
|
|
32
|
+
├── guidelines/ # Guidelines de desenvolvimento (4 arquivos)
|
|
33
|
+
└── files/ # Recursos diversos
|
|
34
|
+
|
|
35
|
+
.cursor/
|
|
36
|
+
├── commands/ # 59 comandos organizados por categoria
|
|
37
|
+
│ ├── docs/ # Comandos de documentação
|
|
38
|
+
│ ├── engineer/ # Workflows de desenvolvimento
|
|
39
|
+
│ ├── collect/ # Coleta de informações
|
|
40
|
+
│ └── check/ # Validações e compliance
|
|
41
|
+
└── agents/ # 27 agentes especializados de IA
|
|
42
|
+
├── *.md # 12 agentes gerais
|
|
43
|
+
├── development/ # 10 agentes especializados dev
|
|
44
|
+
└── compliance/ # 5 agentes compliance ✨ NOVO
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Usage
|
|
48
|
+
|
|
49
|
+
### /docs/build-index
|
|
50
|
+
|
|
51
|
+
**Sem argumentos**: Reconstrói o arquivo `INDEX.md` principal na pasta `@/docs/`.
|
|
52
|
+
|
|
53
|
+
Este índice central fornece:
|
|
54
|
+
- Visão geral do projeto Granaai
|
|
55
|
+
- Links para todas as seções de documentação
|
|
56
|
+
- Descrição de cada seção
|
|
57
|
+
- Estatísticas da documentação (80 arquivos, 59 comandos, 27 agentes)
|
|
58
|
+
- Guias de navegação por perfil (dev, PM, vendas, arquitetos, CISO/Compliance)
|
|
59
|
+
- Mapa de navegação rápida
|
|
60
|
+
- Referência completa aos 27 agentes especializados em `.cursor/agents/`
|
|
61
|
+
- Métricas de maturidade de compliance (ISO 27001, ISO 22301, SOC2, LGPD)
|
|
62
|
+
|
|
63
|
+
**Comportamento**:
|
|
64
|
+
1. Escaneia todas as pastas em `@/docs/`
|
|
65
|
+
2. Lê os arquivos `index.md` de cada seção
|
|
66
|
+
3. Escaneia `.cursor/commands/` e `.cursor/agents/` para contar recursos
|
|
67
|
+
4. Extrai informações relevantes (título, descrição, arquivos principais)
|
|
68
|
+
5. Gera/atualiza `docs/INDEX.md` com estrutura completa
|
|
69
|
+
6. Mantém estatísticas atualizadas:
|
|
70
|
+
- 80 arquivos markdown (+2 README.md landing pages)
|
|
71
|
+
- 59 comandos Cursor
|
|
72
|
+
- 27 agentes IA (12 gerais + 10 development + 5 compliance)
|
|
73
|
+
- 15 arquivos business-context
|
|
74
|
+
- 16 arquivos technical-context
|
|
75
|
+
- 19 arquivos compliance ✨ NOVO
|
|
76
|
+
- 22 arquivos onion
|
|
77
|
+
- 4 arquivos guidelines
|
|
78
|
+
7. Gera métricas de maturidade de compliance:
|
|
79
|
+
- ISO 27001:2022 (84% implementado)
|
|
80
|
+
- ISO 22301:2019 (100% implementado)
|
|
81
|
+
- SOC2 Type II (93% readiness)
|
|
82
|
+
- LGPD (95% compliant)
|
|
83
|
+
- AI Governance (100% documentado)
|
|
84
|
+
|
|
85
|
+
### /docs/build-index <section-name>
|
|
86
|
+
|
|
87
|
+
**Com argumento**: Reconstrói o índice de uma seção específica da documentação.
|
|
88
|
+
|
|
89
|
+
**Seções disponíveis**:
|
|
90
|
+
- `business-context` - Documentação de negócio
|
|
91
|
+
- `technical-context` - Documentação técnica
|
|
92
|
+
- `compliance` - Compliance e Governança (ISO 27001, ISO 22301, SOC2, LGPD) ✨ NOVO
|
|
93
|
+
- `onion` - Sistema Onion (comandos e agentes)
|
|
94
|
+
- `guidelines` - Guidelines de desenvolvimento
|
|
95
|
+
|
|
96
|
+
**Comportamento**:
|
|
97
|
+
1. Percorre a estrutura de arquivos da seção especificada
|
|
98
|
+
2. Identifica arquivos principais e subpastas
|
|
99
|
+
3. Gera/atualiza o `index.md` da seção
|
|
100
|
+
4. Mantém links relativos corretos
|
|
101
|
+
5. Preserva estrutura e organização
|
|
102
|
+
|
|
103
|
+
**Exemplo**:
|
|
104
|
+
```bash
|
|
105
|
+
/docs/build-index business-context
|
|
106
|
+
# Reconstrói docs/business-context/index.md
|
|
107
|
+
|
|
108
|
+
/docs/build-index technical-context
|
|
109
|
+
# Reconstrói docs/technical-context/index.md
|
|
110
|
+
|
|
111
|
+
/docs/build-index compliance
|
|
112
|
+
# Reconstrói docs/compliance/index.md
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
Argumentos fornecidos: #$ARGUMENTS
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## 📚 Pré-requisitos
|
|
121
|
+
|
|
122
|
+
Domine comandos starter antes de usar este comando intermediate/advanced.
|
|
123
|
+
|
|
124
|
+
Consulte os comandos help para ver hierarquia completa e comandos relacionados:
|
|
125
|
+
- /business/help --level=starter
|
|
126
|
+
- /technical/help --level=starter
|
|
127
|
+
|
|
128
|
+
💡 Comandos intermediate/advanced assumem familiaridade com workflows básicos do contexto.
|
|
@@ -0,0 +1,204 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: build-tech-docs
|
|
3
|
+
description: Gerar documentação técnica completa do codebase.
|
|
4
|
+
model: sonnet
|
|
5
|
+
category: docs
|
|
6
|
+
tags: [technical, architecture, documentation]
|
|
7
|
+
version: "4.0.0"
|
|
8
|
+
updated: "2025-12-20"
|
|
9
|
+
level: intermediate
|
|
10
|
+
context: technical
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Gerador de Documentação Técnica
|
|
14
|
+
|
|
15
|
+
Você é um arquiteto de documentação técnica especializado em criar contexto de projeto abrangente e otimizado para IA. Sua missão é analisar o codebase do projeto, repositório e outras fontes de materiais para gerar uma estrutura completa de documentação técnica usando a abordagem de arquitetura multi-arquivo.
|
|
16
|
+
|
|
17
|
+
## Objetivo Principal
|
|
18
|
+
|
|
19
|
+
Gerar uma arquitetura completa de contexto técnico seguindo o template em `.cursor/commands/common/templates/technical_context_template.md`. Criar uma estrutura de documentação modular e multi-arquivo que permita tanto desenvolvedores humanos quanto sistemas de IA entender e trabalhar efetivamente com o codebase.
|
|
20
|
+
|
|
21
|
+
## Input Parameters
|
|
22
|
+
|
|
23
|
+
**Argumentos Obrigatórios:**
|
|
24
|
+
Você deve receber links para arquivos, repositórios e outras fontes de materiais para gerar a documentação técnica. Estes serão colocados em seus argumentos. Se não tiver recebido argumentos, deve solicitá-los antes de prosseguir.
|
|
25
|
+
|
|
26
|
+
<arguments>
|
|
27
|
+
#$ARGUMENTS
|
|
28
|
+
</arguments>
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
## Framework de Análise
|
|
32
|
+
|
|
33
|
+
### Fase 1: Descoberta do Codebase
|
|
34
|
+
1. **Análise da Estrutura do Projeto**
|
|
35
|
+
- Escanear estrutura de diretórios e identificar padrões arquiteturais chave
|
|
36
|
+
- Analisar package.json, requirements.txt, Cargo.toml ou arquivos de dependência equivalentes
|
|
37
|
+
- Identificar sistemas de build, frameworks de teste e configurações de deploy
|
|
38
|
+
- Detectar stack tecnológico, frameworks e dependências chave
|
|
39
|
+
|
|
40
|
+
2. **Reconhecimento de Padrões Arquiteturais**
|
|
41
|
+
- Identificar padrões de design (MVC, microserviços, orientado a eventos, etc.)
|
|
42
|
+
- Analisar fluxo de dados e pontos de integração
|
|
43
|
+
- Entender arquitetura de deploy e scaling
|
|
44
|
+
- Documentar abstrações e interfaces chave
|
|
45
|
+
|
|
46
|
+
3. **Descoberta do Workflow de Desenvolvimento**
|
|
47
|
+
- Analisar configurações de CI/CD (.github/workflows, .gitlab-ci.yml, etc.)
|
|
48
|
+
- Identificar estratégias de teste e requisitos de cobertura
|
|
49
|
+
- Revisar diretrizes de contribuição e setup de desenvolvimento
|
|
50
|
+
- Documentar processos de build, lint e deployment
|
|
51
|
+
|
|
52
|
+
### Fase 2: Discussão com o Usuário
|
|
53
|
+
|
|
54
|
+
Após construir um bom entendimento do projeto, você fará uma série de perguntas ao humano para esclarecer dúvidas ou informações faltantes. Planeje fazer pelo menos 10 perguntas que cubram a maioria das áreas estratégicas na documentação. Seja seletivo sobre as perguntas que faz, e tente evitar perguntas que não sejam relevantes para o projeto.
|
|
55
|
+
|
|
56
|
+
- Se o stack é claro do codebase, não precisa perguntar sobre ele.
|
|
57
|
+
- Identifique as principais decisões arquiteturais e pergunte sobre por que foram feitas -- isso deve ajudar a guiar seu desenvolvimento de ADR
|
|
58
|
+
- Pergunte sobre o processo e workflow de desenvolvimento do produto, se não estiver claro
|
|
59
|
+
- Pergunte sobre o processo e workflow de teste do produto, se não estiver claro
|
|
60
|
+
- Pergunte sobre o processo e workflow de deploy do produto, se não estiver claro
|
|
61
|
+
- Pergunte sobre o processo e workflow de manutenção do produto, se não estiver claro
|
|
62
|
+
- Pergunte sobre desafios arquiteturais atuais e coisas que o time gostaria de melhorar
|
|
63
|
+
- Make sure you understand what is in scope and out of scope
|
|
64
|
+
|
|
65
|
+
Do multiple rounds of Q&A if you feel you still need to get more information.
|
|
66
|
+
When you are ready, give the human a summary of the most important points you detected and ask for approval to proceed to phase 3.
|
|
67
|
+
|
|
68
|
+
### Phase 3: Context Generation
|
|
69
|
+
|
|
70
|
+
This repository root contains on folder for each project. You will identify the right folder and add your files to the $project_name/specs/technical folder.
|
|
71
|
+
|
|
72
|
+
Follow the multi-file structure from the technical template:
|
|
73
|
+
|
|
74
|
+
#### Create Index File (`index.md`)
|
|
75
|
+
```markdown
|
|
76
|
+
## Project Context Profile
|
|
77
|
+
[Basic project information, technology stack, team structure, development constraints]
|
|
78
|
+
|
|
79
|
+
## Layer 1: Core Project Context
|
|
80
|
+
- [Project Charter](project_charter.md)
|
|
81
|
+
- [Architecture Decision Records](adr/)
|
|
82
|
+
|
|
83
|
+
## Layer 2: AI-Optimized Context Files
|
|
84
|
+
- [AI Development Guide](CURSOR.meta.md)
|
|
85
|
+
- [Codebase Navigation Guide](CODEBASE_GUIDE.md)
|
|
86
|
+
|
|
87
|
+
## Layer 3: Domain-Specific Context
|
|
88
|
+
- [Business Logic Documentation](BUSINESS_LOGIC.md)
|
|
89
|
+
- [API Specifications](API_SPECIFICATION.md)
|
|
90
|
+
|
|
91
|
+
## Layer 4: Development Workflow Context
|
|
92
|
+
- [Development Workflow Guide](CONTRIBUTING.md)
|
|
93
|
+
- [Troubleshooting Guide](TROUBLESHOOTING.md)
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
#### Gerar Arquivos Individuais
|
|
97
|
+
|
|
98
|
+
**1. `project_charter.md`**
|
|
99
|
+
- Sintetizar visão do projeto a partir de README, documentação e análise de código
|
|
100
|
+
- Define success criteria based on project goals and metrics
|
|
101
|
+
- Establish scope boundaries from codebase analysis
|
|
102
|
+
- Identify key stakeholders from contributor data
|
|
103
|
+
- Document technical constraints from architecture analysis
|
|
104
|
+
|
|
105
|
+
**2. `adr/` Directory**
|
|
106
|
+
- Create ADRs for major architectural decisions discovered in codebase
|
|
107
|
+
- Document technology choices, patterns, and trade-offs
|
|
108
|
+
- Include database choices, framework selections, deployment strategies
|
|
109
|
+
- Reference commit history and comments for decision context
|
|
110
|
+
|
|
111
|
+
**3. `CURSOR.meta.md` (AI Development Guide)**
|
|
112
|
+
- Extract code style patterns from existing codebase
|
|
113
|
+
- Document testing approaches from test files and configurations
|
|
114
|
+
- Identify common patterns from code analysis
|
|
115
|
+
- List gotchas from comments, issues, and documentation
|
|
116
|
+
- Include performance considerations and security patterns
|
|
117
|
+
|
|
118
|
+
**4. `CODEBASE_GUIDE.md`**
|
|
119
|
+
- Generate directory structure with purpose annotations
|
|
120
|
+
- List key files and their roles in the system
|
|
121
|
+
- Document data flow patterns from code analysis
|
|
122
|
+
- Identify integration points and external dependencies
|
|
123
|
+
- Describe deployment architecture from configurations
|
|
124
|
+
|
|
125
|
+
**5. `BUSINESS_LOGIC.md`** (if complex domain logic exists)
|
|
126
|
+
- Extract domain concepts from models, schemas, and business logic
|
|
127
|
+
- Document business rules from validation logic and workflows
|
|
128
|
+
- Identify edge cases from tests and error handling
|
|
129
|
+
- Map workflow processes from state machines and business logic
|
|
130
|
+
|
|
131
|
+
**6. `API_SPECIFICATION.md`** (if APIs exist)
|
|
132
|
+
- Generate API documentation from routes, controllers, and schemas
|
|
133
|
+
- Document authentication from middleware and security implementations
|
|
134
|
+
- Extract data models from schemas and type definitions
|
|
135
|
+
- Document error handling from exception handling code
|
|
136
|
+
- Include rate limiting and performance characteristics
|
|
137
|
+
|
|
138
|
+
**7. `CONTRIBUTING.md`**
|
|
139
|
+
- Extract branch strategy from git history and configurations
|
|
140
|
+
- Document code review process from PR templates and workflows
|
|
141
|
+
- List testing requirements from test configurations
|
|
142
|
+
- Document deployment process from CI/CD configurations
|
|
143
|
+
- Include environment setup from README and development configurations
|
|
144
|
+
|
|
145
|
+
**8. `TROUBLESHOOTING.md`**
|
|
146
|
+
- Extract common issues from GitHub issues, comments, and documentation
|
|
147
|
+
- Document debugging approaches from logging and monitoring setup
|
|
148
|
+
- Include performance troubleshooting from profiling and optimization code
|
|
149
|
+
- List integration issues from error handling and documentation
|
|
150
|
+
|
|
151
|
+
**9. `ARCHITECTURE_CHALLENGES.md`**
|
|
152
|
+
- Document architecture challenges and things the team would like to improve
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
## Quality Assurance
|
|
156
|
+
|
|
157
|
+
### Content Quality Checks
|
|
158
|
+
- [ ] All generated content is accurate to the actual codebase
|
|
159
|
+
- [ ] Examples are working and tested against the actual project
|
|
160
|
+
- [ ] Architecture documentation matches implementation
|
|
161
|
+
- [ ] Performance claims are backed by actual benchmarks or code analysis
|
|
162
|
+
- [ ] All links between files work correctly
|
|
163
|
+
|
|
164
|
+
### Completeness Validation
|
|
165
|
+
- [ ] All layers of technical context are addressed
|
|
166
|
+
- [ ] Files follow the established template structure
|
|
167
|
+
- [ ] Content is specific to the project, not generic
|
|
168
|
+
- [ ] AI optimization guidelines are practical and actionable
|
|
169
|
+
- [ ] Development workflow matches actual project practices
|
|
170
|
+
|
|
171
|
+
### AI Optimization
|
|
172
|
+
- [ ] Content enables AI to understand project architecture
|
|
173
|
+
- [ ] Code examples are copy-pasteable and functional
|
|
174
|
+
- [ ] Technical constraints and trade-offs are clearly documented
|
|
175
|
+
- [ ] Cross-references between files create comprehensive context
|
|
176
|
+
- [ ] File naming follows established conventions
|
|
177
|
+
|
|
178
|
+
## Execution Strategy
|
|
179
|
+
|
|
180
|
+
1. **Deep Analysis First**: Spend significant time understanding the codebase before writing
|
|
181
|
+
2. **Evidence-Based Documentation**: Every claim should be backed by code, configurations, or project artifacts
|
|
182
|
+
3. **Multi-File Structure**: Always create separate files linked through the index
|
|
183
|
+
4. **AI-Optimized Content**: Write for both human and AI consumption
|
|
184
|
+
5. **Project-Specific Details**: Avoid generic advice; focus on actual project specifics
|
|
185
|
+
6. **Cross-Reference Integration**: Ensure files reference each other appropriately
|
|
186
|
+
|
|
187
|
+
## Critérios de Sucesso da Saída
|
|
188
|
+
|
|
189
|
+
A documentação técnica gerada deve permitir:
|
|
190
|
+
- **Novos desenvolvedores** entender e contribuir com o projeto em horas
|
|
191
|
+
- **AI systems** to provide accurate, contextual assistance with development tasks
|
|
192
|
+
- **Technical decisions** to be made with full context of existing architecture
|
|
193
|
+
- **Code reviews** to focus on logic rather than style or architectural questions
|
|
194
|
+
- **Debugging and troubleshooting** to be systematic and efficient
|
|
195
|
+
|
|
196
|
+
## Error Handling
|
|
197
|
+
|
|
198
|
+
If certain information cannot be determined from the codebase:
|
|
199
|
+
- Clearly mark sections as "TO BE COMPLETED" with specific instructions
|
|
200
|
+
- Provide templates for missing information
|
|
201
|
+
- Reference where the information should come from
|
|
202
|
+
- Create issues or TODOs for follow-up documentation work
|
|
203
|
+
|
|
204
|
+
Remember: The goal is to create living documentation that grows with the project and serves as the definitive technical context for both humans and AI systems.
|