@onion-architect-ai/cli 4.1.0-beta.1 → 4.1.0-beta.2
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 +8 -7
- package/dist/cli.js.map +1 -1
- package/package.json +4 -3
- package/templates/.cursor/agents/compliance/iso-22301-specialist.md +917 -0
- package/templates/.cursor/agents/compliance/iso-27001-specialist.md +641 -0
- package/templates/.cursor/agents/compliance/pmbok-specialist.md +669 -0
- package/templates/.cursor/agents/compliance/security-information-master.md +824 -0
- package/templates/.cursor/agents/compliance/soc2-specialist.md +818 -0
- package/templates/.cursor/agents/deployment/docker-specialist.md +1192 -0
- package/templates/.cursor/agents/meta/agent-creator-specialist.md +1135 -0
- package/templates/.cursor/agents/meta/command-creator-specialist.md +1519 -0
- package/templates/.cursor/agents/meta/metaspec-gate-keeper.md +240 -0
- package/templates/.cursor/agents/meta/onion.md +753 -0
- package/templates/.cursor/agents/research/research-agent.md +292 -0
- package/templates/.cursor/agents/review/corporate-compliance-specialist.md +370 -0
- package/templates/.cursor/commands/common/prompts/README.md +187 -0
- package/templates/.cursor/commands/common/prompts/clickup-patterns.md +144 -0
- package/templates/.cursor/commands/common/prompts/code-review-checklist.md +168 -0
- package/templates/.cursor/commands/common/prompts/git-workflow-patterns.md +235 -0
- package/templates/.cursor/commands/common/prompts/output-formats.md +240 -0
- package/templates/.cursor/commands/common/prompts/technical.md +172 -0
- package/templates/.cursor/commands/common/prompts/validation-rules.md +173 -0
- package/templates/.cursor/commands/common/templates/abstraction-template.md +400 -0
- package/templates/.cursor/commands/common/templates/agent-template.md +353 -0
- package/templates/.cursor/commands/common/templates/business_context_template.md +748 -0
- package/templates/.cursor/commands/common/templates/command-template.md +273 -0
- package/templates/.cursor/commands/common/templates/technical_context_template.md +526 -0
- package/templates/.cursor/commands/development/runflow-dev.md +465 -0
- package/templates/.cursor/commands/docs/build-compliance-docs.md +143 -0
- package/templates/.cursor/commands/git/README.md +606 -0
- package/templates/.cursor/commands/meta/all-tools.md +50 -0
- package/templates/.cursor/commands/meta/analyze-complex-problem.md +186 -0
- package/templates/.cursor/commands/meta/create-abstraction.md +859 -0
- package/templates/.cursor/commands/meta/create-agent-express.md +83 -0
- package/templates/.cursor/commands/meta/create-agent.md +210 -0
- package/templates/.cursor/commands/meta/create-command.md +203 -0
- package/templates/.cursor/commands/meta/create-knowledge-base.md +143 -0
- package/templates/.cursor/commands/meta/create-task-structure.md +150 -0
- package/templates/.cursor/commands/meta/setup-integration.md +257 -0
- package/templates/.cursor/commands/onion/setup.md +843 -0
- package/templates/.cursor/commands/onion.md +168 -0
- package/templates/.cursor/commands/product/README.md +230 -0
- package/templates/.cursor/commands/quick/analisys.md +17 -0
- package/templates/.cursor/commands/validate/collab/pair-testing.md +633 -0
- package/templates/.cursor/commands/validate/collab/three-amigos.md +505 -0
- package/templates/.cursor/commands/validate/qa-points/estimate.md +660 -0
- package/templates/.cursor/commands/validate/test-strategy/analyze.md +1134 -0
- package/templates/.cursor/commands/validate/test-strategy/create.md +392 -0
- package/templates/.cursor/commands/validate/workflow.md +360 -0
- package/templates/.cursor/commands/warm-up.md +91 -0
- package/templates/.cursor/docs/architecture/acoplamento-clickup-problema-analise.md +446 -0
- package/templates/.cursor/docs/architecture/desacoplamento-roadmap.md +360 -0
- package/templates/.cursor/docs/architecture/validacao-fase-1.md +219 -0
- package/templates/.cursor/docs/c4/c4-detection-rules.md +395 -0
- package/templates/.cursor/docs/c4/c4-documentation-templates.md +579 -0
- package/templates/.cursor/docs/c4/c4-mermaid-patterns.md +331 -0
- package/templates/.cursor/docs/c4/c4-templates.md +256 -0
- package/templates/.cursor/docs/clickup/clickup-acceptance-criteria-strategy.md +329 -0
- package/templates/.cursor/docs/clickup/clickup-auto-update-strategy.md +318 -0
- package/templates/.cursor/docs/clickup/clickup-comment-formatter.md +239 -0
- package/templates/.cursor/docs/clickup/clickup-description-fix.md +355 -0
- package/templates/.cursor/docs/clickup/clickup-dual-comment-strategy.md +505 -0
- package/templates/.cursor/docs/clickup/clickup-formatting.md +302 -0
- package/templates/.cursor/docs/clickup/separador-tamanho-otimizado.md +256 -0
- package/templates/.cursor/docs/engineer/pre-pr-acceptance-validation.md +256 -0
- package/templates/.cursor/docs/onion/ESPERANTO.md +278 -0
- package/templates/.cursor/docs/onion/agents-reference.md +832 -0
- package/templates/.cursor/docs/onion/clickup-integration.md +738 -0
- package/templates/.cursor/docs/onion/commands-guide.md +807 -0
- package/templates/.cursor/docs/onion/engineering-flows.md +865 -0
- package/templates/.cursor/docs/onion/getting-started.md +741 -0
- package/templates/.cursor/docs/onion/maintenance-checklist.md +388 -0
- package/templates/.cursor/docs/onion/naming-conventions.md +268 -0
- package/templates/.cursor/docs/onion/practical-examples.md +782 -0
- package/templates/.cursor/docs/product/story-points-integration.md +254 -0
- package/templates/.cursor/docs/product/story-points-validation.md +224 -0
- package/templates/.cursor/docs/reviews/task-manager-docs-review-2025-11-24.md +167 -0
- package/templates/.cursor/docs/strategies/clickup-comment-patterns.md +766 -0
- package/templates/.cursor/docs/strategies/clickup-integration-tests.md +599 -0
- package/templates/.cursor/docs/strategies/clickup-mcp-wrappers-tests.md +854 -0
- package/templates/.cursor/docs/strategies/clickup-regression-tests.md +589 -0
- package/templates/.cursor/docs/strategies/visual-patterns.md +308 -0
- package/templates/.cursor/docs/templates/README.md +624 -0
- package/templates/.cursor/docs/templates/adr-template.md +226 -0
- package/templates/.cursor/docs/templates/analysis-template.md +280 -0
- package/templates/.cursor/docs/templates/execution-plan-template.md +430 -0
- package/templates/.cursor/docs/templates/guide-template.md +367 -0
- package/templates/.cursor/docs/templates/phase-execution-prompt-template.md +504 -0
- package/templates/.cursor/docs/templates/reference-template.md +522 -0
- package/templates/.cursor/docs/templates/solution-template.md +390 -0
- package/templates/.cursor/docs/tools/README.md +325 -0
- package/templates/.cursor/docs/tools/agents.md +330 -0
- package/templates/.cursor/docs/tools/commands.md +606 -0
- package/templates/.cursor/docs/tools/cursor.md +498 -0
- package/templates/.cursor/docs/tools/mcps.md +858 -0
- package/templates/.cursor/docs/tools/rules.md +423 -0
- package/templates/.cursor/rules/language-and-documentation.mdc +371 -0
- package/templates/.cursor/rules/onion-patterns.mdc +197 -0
- package/templates/.cursor/rules/validation-rules.mdc +194 -0
- package/templates/.cursor/utils/clickup-mcp-wrappers.md +671 -0
- package/templates/.cursor/utils/date-time-standards.md +182 -0
- package/templates/.cursor/utils/task-manager/README.md +94 -0
- package/templates/.cursor/utils/task-manager/adapters/asana.md +377 -0
- package/templates/.cursor/utils/task-manager/adapters/clickup.md +467 -0
- package/templates/.cursor/utils/task-manager/adapters/linear.md +421 -0
- package/templates/.cursor/utils/task-manager/detector.md +290 -0
- package/templates/.cursor/utils/task-manager/factory.md +363 -0
- package/templates/.cursor/utils/task-manager/interface.md +248 -0
- package/templates/.cursor/utils/task-manager/types.md +409 -0
- package/templates/.cursor/validation/product-task-validation.md +344 -0
- package/templates/.onion/contexts/business/.context-config.yml +52 -0
- package/templates/.onion/contexts/business/README.md +222 -0
- package/templates/.onion/contexts/business/agents/branding-specialist.md +1030 -0
- package/templates/.onion/contexts/business/agents/clickup-specialist.md +397 -0
- package/templates/.onion/contexts/business/agents/extract-meeting-specialist.md +395 -0
- package/templates/.onion/contexts/business/agents/gamma-specialist.md +1169 -0
- package/templates/.onion/contexts/business/agents/meeting-consolidator.md +483 -0
- package/templates/.onion/contexts/business/agents/pain-price-specialist.md +509 -0
- package/templates/.onion/contexts/business/agents/presentation-orchestrator.md +1191 -0
- package/templates/.onion/contexts/business/agents/product-agent.md +202 -0
- package/templates/.onion/contexts/business/agents/story-points-specialist.md +539 -0
- package/templates/.onion/contexts/business/agents/storytelling-specialist.md +891 -0
- package/templates/.onion/contexts/business/agents/task-specialist.md +618 -0
- package/templates/.onion/contexts/business/agents/whisper-specialist.md +373 -0
- package/templates/.onion/contexts/business/commands/advanced/analyze-pain-price.md +709 -0
- package/templates/.onion/contexts/business/commands/advanced/branding.md +460 -0
- package/templates/.onion/contexts/business/commands/advanced/checklist-sync.md +241 -0
- package/templates/.onion/contexts/business/commands/advanced/presentation.md +189 -0
- package/templates/.onion/contexts/business/commands/advanced/transform-consolidated.md +592 -0
- package/templates/.onion/contexts/business/commands/help.md +212 -0
- package/templates/.onion/contexts/business/commands/intermediate/check.md +48 -0
- package/templates/.onion/contexts/business/commands/intermediate/collect.md +96 -0
- package/templates/.onion/contexts/business/commands/intermediate/consolidate-meetings.md +306 -0
- package/templates/.onion/contexts/business/commands/intermediate/convert-to-tasks.md +220 -0
- package/templates/.onion/contexts/business/commands/intermediate/extract-meeting.md +241 -0
- package/templates/.onion/contexts/business/commands/intermediate/feature.md +431 -0
- package/templates/.onion/contexts/business/commands/intermediate/light-arch.md +97 -0
- package/templates/.onion/contexts/business/commands/intermediate/task-check.md +340 -0
- package/templates/.onion/contexts/business/commands/intermediate/validate-task.md +294 -0
- package/templates/.onion/contexts/business/commands/intermediate/whisper.md +325 -0
- package/templates/.onion/contexts/business/commands/starter/estimate.md +519 -0
- package/templates/.onion/contexts/business/commands/starter/refine.md +186 -0
- package/templates/.onion/contexts/business/commands/starter/spec.md +107 -0
- package/templates/.onion/contexts/business/commands/starter/task.md +585 -0
- package/templates/.onion/contexts/business/commands/starter/warm-up.md +187 -0
- package/templates/.onion/contexts/technical/.context-config.yml +64 -0
- package/templates/.onion/contexts/technical/README.md +238 -0
- package/templates/.onion/contexts/technical/agents/branch-code-reviewer.md +200 -0
- package/templates/.onion/contexts/technical/agents/branch-doc-writer.md +162 -0
- package/templates/.onion/contexts/technical/agents/branch-metaspec-checker.md +68 -0
- package/templates/.onion/contexts/technical/agents/branch-test-planner.md +177 -0
- package/templates/.onion/contexts/technical/agents/c4-architecture-specialist.md +712 -0
- package/templates/.onion/contexts/technical/agents/c4-documentation-specialist.md +658 -0
- package/templates/.onion/contexts/technical/agents/code-reviewer.md +155 -0
- package/templates/.onion/contexts/technical/agents/cursor-specialist.md +249 -0
- package/templates/.onion/contexts/technical/agents/docs-reverse-engineer.md +418 -0
- package/templates/.onion/contexts/technical/agents/gitflow-specialist.md +1207 -0
- package/templates/.onion/contexts/technical/agents/linux-security-specialist.md +676 -0
- package/templates/.onion/contexts/technical/agents/mermaid-specialist.md +516 -0
- package/templates/.onion/contexts/technical/agents/nodejs-specialist.md +673 -0
- package/templates/.onion/contexts/technical/agents/nx-migration-specialist.md +867 -0
- package/templates/.onion/contexts/technical/agents/nx-monorepo-specialist.md +619 -0
- package/templates/.onion/contexts/technical/agents/postgres-specialist.md +1124 -0
- package/templates/.onion/contexts/technical/agents/react-developer.md +132 -0
- package/templates/.onion/contexts/technical/agents/runflow-specialist.md +278 -0
- package/templates/.onion/contexts/technical/agents/system-doc-orchestrator.md +1388 -0
- package/templates/.onion/contexts/technical/agents/test-agent.md +425 -0
- package/templates/.onion/contexts/technical/agents/test-engineer.md +295 -0
- package/templates/.onion/contexts/technical/agents/test-planner.md +118 -0
- package/templates/.onion/contexts/technical/agents/zen-engine-specialist.md +421 -0
- package/templates/.onion/contexts/technical/commands/advanced/bump.md +43 -0
- package/templates/.onion/contexts/technical/commands/advanced/consolidate-documents.md +424 -0
- package/templates/.onion/contexts/technical/commands/advanced/e2e.md +392 -0
- package/templates/.onion/contexts/technical/commands/advanced/feature-finish.md +90 -0
- package/templates/.onion/contexts/technical/commands/advanced/feature-publish.md +91 -0
- package/templates/.onion/contexts/technical/commands/advanced/feature-start.md +158 -0
- package/templates/.onion/contexts/technical/commands/advanced/hotfix-finish.md +98 -0
- package/templates/.onion/contexts/technical/commands/advanced/hotfix-start.md +94 -0
- package/templates/.onion/contexts/technical/commands/advanced/hotfix.md +186 -0
- package/templates/.onion/contexts/technical/commands/advanced/refine-vision.md +27 -0
- package/templates/.onion/contexts/technical/commands/advanced/release-finish.md +98 -0
- package/templates/.onion/contexts/technical/commands/advanced/release-start.md +95 -0
- package/templates/.onion/contexts/technical/commands/advanced/reverse-consolidate.md +160 -0
- package/templates/.onion/contexts/technical/commands/advanced/validate-phase-sync.md +118 -0
- package/templates/.onion/contexts/technical/commands/help.md +329 -0
- package/templates/.onion/contexts/technical/commands/intermediate/build-business-docs.md +276 -0
- package/templates/.onion/contexts/technical/commands/intermediate/build-index.md +128 -0
- package/templates/.onion/contexts/technical/commands/intermediate/build-tech-docs.md +204 -0
- package/templates/.onion/contexts/technical/commands/intermediate/code-review.md +215 -0
- package/templates/.onion/contexts/technical/commands/intermediate/docs-health.md +142 -0
- package/templates/.onion/contexts/technical/commands/intermediate/fast-commit.md +45 -0
- package/templates/.onion/contexts/technical/commands/intermediate/integration.md +523 -0
- package/templates/.onion/contexts/technical/commands/intermediate/pr-update.md +198 -0
- package/templates/.onion/contexts/technical/commands/intermediate/pre-pr.md +91 -0
- package/templates/.onion/contexts/technical/commands/intermediate/start.md +266 -0
- package/templates/.onion/contexts/technical/commands/intermediate/sync-sessions.md +320 -0
- package/templates/.onion/contexts/technical/commands/intermediate/unit.md +378 -0
- package/templates/.onion/contexts/technical/commands/intermediate/validate-docs.md +159 -0
- package/templates/.onion/contexts/technical/commands/starter/docs.md +39 -0
- package/templates/.onion/contexts/technical/commands/starter/help.md +306 -0
- package/templates/.onion/contexts/technical/commands/starter/init.md +139 -0
- package/templates/.onion/contexts/technical/commands/starter/plan.md +111 -0
- package/templates/.onion/contexts/technical/commands/starter/pr.md +136 -0
- package/templates/.onion/contexts/technical/commands/starter/sync.md +228 -0
- package/templates/.onion/contexts/technical/commands/starter/warm-up.md +173 -0
- package/templates/.onion/contexts/technical/commands/starter/work.md +169 -0
- package/templates/.onion/core/commands/help.md +388 -0
|
@@ -0,0 +1,276 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: build-business-docs
|
|
3
|
+
description: Gerar documentação de contexto de negócio e estratégia.
|
|
4
|
+
model: sonnet
|
|
5
|
+
category: docs
|
|
6
|
+
tags: [business, strategy, documentation]
|
|
7
|
+
version: "4.0.0"
|
|
8
|
+
updated: "2025-12-20"
|
|
9
|
+
level: intermediate
|
|
10
|
+
context: technical
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Gerador de Contexto de Negócio
|
|
14
|
+
|
|
15
|
+
Você é um analista de negócios e estrategista de produto especializado em criar inteligência de negócios abrangente e otimizada para IA. Sua missão é analisar um projeto/produto e gerar uma arquitetura completa de contexto de negócio usando a abordagem multi-arquivo que permite sistemas de IA entenderem clientes, dinâmicas de mercado e estratégia de negócio.
|
|
16
|
+
|
|
17
|
+
## Objetivo Principal
|
|
18
|
+
|
|
19
|
+
Gerar uma arquitetura completa de contexto de negócio seguindo o template em `.cursor/commands/common/templates/business_context_template.md`. Criar uma estrutura de documentação modular e multi-arquivo que permita sistemas de IA fornecer suporte ao cliente contextualmente apropriado, assistência em vendas e insights estratégicos de negócio.
|
|
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 de negócio. 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
|
+
## Framework de Análise
|
|
31
|
+
|
|
32
|
+
### Fase 1: Descoberta do Produto
|
|
33
|
+
1. **Entendimento do Produto**
|
|
34
|
+
- Analisar README, descrições de produto e materiais de marketing
|
|
35
|
+
- Extrair proposta de valor de landing pages, documentação e posicionamento
|
|
36
|
+
- Identificar mercado-alvo a partir de conjunto de funcionalidades e mensagens
|
|
37
|
+
- Entender modelo de negócio a partir de páginas de preço, estratégia de monetização e fluxos de receita
|
|
38
|
+
|
|
39
|
+
2. **Pesquisa de Mercado**
|
|
40
|
+
- Pesquisar panorama competitivo através de buscas na web e análise (use Perplexity ou outras ferramentas de busca web)
|
|
41
|
+
- Identificar tendências do setor e dinâmicas de mercado
|
|
42
|
+
- Analisar segmentos de clientes e casos de uso
|
|
43
|
+
- Estudar ambiente regulatório e requisitos de conformidade
|
|
44
|
+
|
|
45
|
+
3. **Coleta de Inteligência do Cliente**
|
|
46
|
+
- Analisar feedback do cliente de issues do GitHub, tickets de suporte, avaliações
|
|
47
|
+
- Extrair personas de cliente do comportamento do usuário e uso de funcionalidades
|
|
48
|
+
- Mapear jornada do cliente a partir de fluxos de onboarding e experiência do usuário
|
|
49
|
+
- Identificar padrões de comunicação e preferências de interações de suporte
|
|
50
|
+
|
|
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
|
+
- Identificar a visão do produto
|
|
57
|
+
- Identificar principais personas de usuário
|
|
58
|
+
- Identificar principais concorrentes e por que isto é diferente
|
|
59
|
+
- Quem são os principais stakeholders
|
|
60
|
+
- Quais são as principais funcionalidades
|
|
61
|
+
- Quais são os principais workflows
|
|
62
|
+
- Quais são as principais métricas
|
|
63
|
+
- Quais são os principais desafios
|
|
64
|
+
- Quais são as principais oportunidades
|
|
65
|
+
- Quais são os principais riscos
|
|
66
|
+
- Quais são as principais dependências
|
|
67
|
+
- Quais são as principais restrições
|
|
68
|
+
|
|
69
|
+
Faça múltiplas rodadas de perguntas e respostas se sentir que ainda precisa obter mais informações.
|
|
70
|
+
Quando estiver pronto, dê ao humano um resumo dos pontos mais importantes detectados e peça aprovação para prosseguir para a fase 3.
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
### Fase 3: Geração do Contexto de Negócio
|
|
74
|
+
|
|
75
|
+
Siga a estrutura multi-arquivo do template de negócio:
|
|
76
|
+
|
|
77
|
+
#### Criar Arquivo de Índice (`index.md`)
|
|
78
|
+
```markdown
|
|
79
|
+
## Business Context Profile
|
|
80
|
+
[Company foundation, product information, scale and metrics]
|
|
81
|
+
|
|
82
|
+
## Layer 1: Customer Context Architecture
|
|
83
|
+
- [Customer Personas](CUSTOMER_PERSONAS.md)
|
|
84
|
+
- [Customer Journey](CUSTOMER_JOURNEY.md)
|
|
85
|
+
- [Voice of Customer](VOICE_OF_CUSTOMER.md)
|
|
86
|
+
|
|
87
|
+
## Layer 2: Product Context Architecture
|
|
88
|
+
- [Product Strategy](PRODUCT_STRATEGY.md)
|
|
89
|
+
- [Feature Catalog](features/)
|
|
90
|
+
- [Product Metrics](PRODUCT_METRICS.md)
|
|
91
|
+
|
|
92
|
+
## Layer 3: Market and Competitive Context
|
|
93
|
+
- [Competitive Landscape](COMPETITIVE_LANDSCAPE.md)
|
|
94
|
+
- [Industry Trends](INDUSTRY_TRENDS.md)
|
|
95
|
+
|
|
96
|
+
## Layer 4: Operational Business Context
|
|
97
|
+
- [Sales Process](SALES_PROCESS.md)
|
|
98
|
+
- [Messaging Framework](MESSAGING_FRAMEWORK.md)
|
|
99
|
+
- [Customer Communication Guidelines](CUSTOMER_COMMUNICATION.md)
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
#### Gerar Arquivos Individuais
|
|
103
|
+
|
|
104
|
+
**1. `CUSTOMER_PERSONAS.md`**
|
|
105
|
+
- Pesquisar e definir personas primárias de cliente baseadas em:
|
|
106
|
+
- Análise de feedback de usuário de issues do GitHub, avaliações, depoimentos
|
|
107
|
+
- Padrões de uso de funcionalidades e requisitos técnicos
|
|
108
|
+
- Contexto do setor e perfis típicos de usuário
|
|
109
|
+
- Padrões de comunicação em canais de suporte
|
|
110
|
+
- Incluir demografia, objetivos, pontos de dor, contexto tecnológico e notas de interação com IA
|
|
111
|
+
- Criar tanto personas de usuários primários quanto tomadores de decisão quando aplicável
|
|
112
|
+
|
|
113
|
+
**2. `CUSTOMER_JOURNEY.md`**
|
|
114
|
+
- Mapear ciclo de vida completo do cliente a partir de:
|
|
115
|
+
- Fluxos de onboarding e guias de primeiros passos
|
|
116
|
+
- Padrões de adoção de funcionalidades e progressão do usuário
|
|
117
|
+
- Padrões de tickets de suporte e pontos de confusão comuns
|
|
118
|
+
- Feedback da comunidade e indicadores de advocacy
|
|
119
|
+
- Incluir padrões de consciência, avaliação, adoção, crescimento e advocacy/churn
|
|
120
|
+
- Documentar eventos gatilho, critérios de decisão e marcos de sucesso
|
|
121
|
+
|
|
122
|
+
**3. `VOICE_OF_CUSTOMER.md`**
|
|
123
|
+
- Extrair padrões de feedback do cliente de:
|
|
124
|
+
- Issues do GitHub, discussões e fóruns da comunidade
|
|
125
|
+
- Avaliações de produto e depoimentos
|
|
126
|
+
- Análise de tickets de suporte e solicitações comuns
|
|
127
|
+
- Menções em mídias sociais e discussões da comunidade
|
|
128
|
+
- Documentar temas de elogio, solicitações frequentes, comparações competitivas
|
|
129
|
+
- Identificar linguagem do cliente, preferências de terminologia e padrões de comunicação
|
|
130
|
+
|
|
131
|
+
**4. `PRODUCT_STRATEGY.md`**
|
|
132
|
+
- Sintetizar estratégia de produto a partir de:
|
|
133
|
+
- Declarações de missão, documentos de visão e materiais estratégicos
|
|
134
|
+
- Análise de roadmap e prioridades de desenvolvimento
|
|
135
|
+
- Posicionamento competitivo e diferenciação
|
|
136
|
+
- Oportunidade de mercado e áreas de foco estratégico
|
|
137
|
+
- Incluir visão/missão, posição no mercado, prioridades estratégicas e princípios do produto
|
|
138
|
+
- Documentar frameworks de trade-off e padrões de qualidade
|
|
139
|
+
|
|
140
|
+
**5. Diretório `features/`**
|
|
141
|
+
- Criar arquivos individuais de funcionalidade para cada funcionalidade do produto com:
|
|
142
|
+
- Análise de propósito e benefício ao usuário
|
|
143
|
+
- Identificação de padrões de uso da documentação e feedback do usuário
|
|
144
|
+
- Métricas de sucesso e indicadores de performance
|
|
145
|
+
- Issues comuns e limitações dos dados de suporte
|
|
146
|
+
- Orientação de interação com IA para cada funcionalidade
|
|
147
|
+
- Organizar por funcionalidades principais, funcionalidades avançadas e capacidades de integração
|
|
148
|
+
- Nomear arquivos descritivamente (ex: `user-authentication.md`, `data-export.md`, `api-integration.md`)
|
|
149
|
+
|
|
150
|
+
**6. `PRODUCT_METRICS.md`**
|
|
151
|
+
- Document key performance indicators:
|
|
152
|
+
- Adoption metrics (downloads, stars, usage statistics)
|
|
153
|
+
- Quality metrics (test coverage, performance benchmarks, issue resolution)
|
|
154
|
+
- Feature performance (high-performing vs underperforming features)
|
|
155
|
+
- Usage correlation patterns and success indicators
|
|
156
|
+
- Focus on metrics that indicate product health and market success
|
|
157
|
+
|
|
158
|
+
**7. `COMPETITIVE_LANDSCAPE.md`**
|
|
159
|
+
- Research and analyze direct competitors:
|
|
160
|
+
- Competitive strengths, weaknesses, and positioning
|
|
161
|
+
- Pricing strategies and business models
|
|
162
|
+
- Customer overlap and differentiation strategies
|
|
163
|
+
- Win/loss scenarios and competitive messaging
|
|
164
|
+
- Include competitive positioning framework and objection handling
|
|
165
|
+
|
|
166
|
+
**8. `INDUSTRY_TRENDS.md`**
|
|
167
|
+
- Analyze market evolution and trends:
|
|
168
|
+
- Industry landscape and evolution patterns
|
|
169
|
+
- Technology trends affecting the market
|
|
170
|
+
- Regulatory environment and compliance requirements
|
|
171
|
+
- Future predictions and strategic implications
|
|
172
|
+
- Focus on trends that affect product strategy and customer needs
|
|
173
|
+
|
|
174
|
+
**9. `SALES_PROCESS.md`**
|
|
175
|
+
(if relevant)
|
|
176
|
+
- Document customer acquisition strategy:
|
|
177
|
+
- For B2B products: Sales methodology, qualification criteria, common objections
|
|
178
|
+
- For Open Source: Community building, contribution workflows, monetization strategy
|
|
179
|
+
- For B2C: User acquisition, conversion funnels, retention strategies
|
|
180
|
+
- Include customer success patterns and expansion opportunities
|
|
181
|
+
|
|
182
|
+
**10. `MESSAGING_FRAMEWORK.md`**
|
|
183
|
+
- Define brand voice and messaging:
|
|
184
|
+
- Brand personality and tone guidelines
|
|
185
|
+
- Core messaging and value propositions
|
|
186
|
+
- Audience-specific messaging strategies
|
|
187
|
+
- Content guidelines and communication style
|
|
188
|
+
- Ensure messaging aligns with customer preferences and market positioning
|
|
189
|
+
|
|
190
|
+
**11. `CUSTOMER_COMMUNICATION.md`**
|
|
191
|
+
- Create AI interaction guidelines:
|
|
192
|
+
- Communication principles and objectives
|
|
193
|
+
- Response guidelines for different scenarios
|
|
194
|
+
- Escalation triggers and privacy considerations
|
|
195
|
+
- Personalization strategies and relationship building approaches
|
|
196
|
+
- Tailor guidelines to the specific customer base and communication channels
|
|
197
|
+
|
|
198
|
+
## Fontes e Métodos de Pesquisa
|
|
199
|
+
|
|
200
|
+
### Fontes Primárias
|
|
201
|
+
- **Documentação do Produto**: Arquivos README, documentação oficial, docs de API
|
|
202
|
+
- **Feedback do Cliente**: Issues do GitHub, avaliações, depoimentos, tickets de suporte
|
|
203
|
+
- **Materiais de Marketing**: Texto do website, landing pages, posts de blog, estudos de caso
|
|
204
|
+
- **Canais da Comunidade**: Fóruns, Discord, comunidades Slack, mídias sociais
|
|
205
|
+
- **Inteligência Competitiva**: Websites de concorrentes, documentação, feedback de usuários
|
|
206
|
+
|
|
207
|
+
### Técnicas de Pesquisa
|
|
208
|
+
- **Análise de Busca Web**: Pesquisar concorrentes, tendências de mercado e insights do setor
|
|
209
|
+
- **Análise de Conteúdo**: Extrair insights de documentação e comunicações existentes
|
|
210
|
+
- **Reconhecimento de Padrões**: Identificar tendências no feedback e comportamento do cliente
|
|
211
|
+
- **Pesquisa Competitiva**: Analisar posicionamento de concorrentes e recepção do cliente
|
|
212
|
+
- **Inteligência de Mercado**: Coletar tendências do setor e informações regulatórias
|
|
213
|
+
|
|
214
|
+
## Quality Assurance
|
|
215
|
+
|
|
216
|
+
### Content Accuracy
|
|
217
|
+
- [ ] All customer insights are based on actual feedback and data
|
|
218
|
+
- [ ] Competitive analysis includes current, verifiable information
|
|
219
|
+
- [ ] Product features and capabilities are accurately represented
|
|
220
|
+
- [ ] Market trends are supported by research and evidence
|
|
221
|
+
- [ ] Business model and strategy align with actual company direction
|
|
222
|
+
|
|
223
|
+
### AI Optimization
|
|
224
|
+
- [ ] Content enables AI to provide contextually appropriate customer support
|
|
225
|
+
- [ ] Customer personas include specific AI interaction guidelines
|
|
226
|
+
- [ ] Communication guidelines are actionable for AI systems
|
|
227
|
+
- [ ] Business context is structured for AI decision-making support
|
|
228
|
+
- [ ] Cross-references create comprehensive business intelligence
|
|
229
|
+
|
|
230
|
+
### Completeness Validation
|
|
231
|
+
- [ ] All business context layers are thoroughly addressed
|
|
232
|
+
- [ ] Customer journey covers full lifecycle from awareness to advocacy
|
|
233
|
+
- [ ] Competitive landscape includes direct and indirect competitors
|
|
234
|
+
- [ ] Product strategy aligns with actual market positioning
|
|
235
|
+
- [ ] Communication guidelines match customer preferences
|
|
236
|
+
|
|
237
|
+
## Execution Strategy
|
|
238
|
+
|
|
239
|
+
1. **Customer-First Research**: Start with deep customer understanding before strategy
|
|
240
|
+
2. **Evidence-Based Insights**: Ground all business intelligence in real data and feedback
|
|
241
|
+
3. **Multi-File Architecture**: Always create linked, focused files for each business area
|
|
242
|
+
4. **AI-Optimized Structure**: Organize information for AI consumption and decision-support
|
|
243
|
+
5. **Market-Informed Strategy**: Ensure all business context reflects current market realities
|
|
244
|
+
6. **Cross-Functional Integration**: Connect business context with technical implementation
|
|
245
|
+
|
|
246
|
+
## Critérios de Sucesso da Saída
|
|
247
|
+
|
|
248
|
+
A documentação de negócio gerada deve permitir:
|
|
249
|
+
- **Suporte ao cliente com IA** fornecer assistência contextualmente apropriada
|
|
250
|
+
- **Times de vendas e marketing** alinhar mensagens com necessidades do cliente e posição no mercado
|
|
251
|
+
- **Decisões de produto** serem tomadas com contexto completo de cliente e mercado
|
|
252
|
+
- **Planejamento estratégico** aproveitar inteligência competitiva e de mercado abrangente
|
|
253
|
+
- **Comunicação com cliente** ser consistente com voz da marca e preferências do cliente
|
|
254
|
+
|
|
255
|
+
## Adaptation Guidelines
|
|
256
|
+
|
|
257
|
+
### For Different Business Models
|
|
258
|
+
- **B2B SaaS**: Emphasize enterprise sales, customer success, and competitive differentiation
|
|
259
|
+
- **Open Source**: Focus on community building, contributor engagement, and monetization strategy
|
|
260
|
+
- **B2C Products**: Highlight user experience, conversion optimization, and retention strategies
|
|
261
|
+
- **Developer Tools**: Prioritize technical accuracy, developer experience, and ecosystem integration
|
|
262
|
+
|
|
263
|
+
### For Different Company Stages
|
|
264
|
+
- **Early Stage**: Focus on customer discovery, market validation, and product-market fit
|
|
265
|
+
- **Growth Stage**: Emphasize scaling strategies, competitive positioning, and market expansion
|
|
266
|
+
- **Enterprise Stage**: Include comprehensive competitive analysis, compliance, and strategic partnerships
|
|
267
|
+
|
|
268
|
+
## Error Handling and Gaps
|
|
269
|
+
|
|
270
|
+
When information cannot be determined:
|
|
271
|
+
- Mark sections as "RESEARCH NEEDED" with specific data requirements
|
|
272
|
+
- Provide frameworks for gathering missing information
|
|
273
|
+
- Create hypotheses based on available data with clear validation steps
|
|
274
|
+
- Reference industry standards and best practices as interim guidance
|
|
275
|
+
|
|
276
|
+
Lembre-se: O objetivo é criar inteligência de negócio acionável que permite sistemas de IA entenderem clientes, dinâmicas de mercado e contexto estratégico para fornecer suporte de negócio superior e assistência na tomada de decisões.
|
|
@@ -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.
|