@onion-ai/cli 1.0.0-beta.1

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.
Files changed (220) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +529 -0
  3. package/bin/onion.js +6 -0
  4. package/framework/CLAUDE.md +45 -0
  5. package/framework/VERSION +1 -0
  6. package/framework/agents/compliance/iso-22301-specialist.md +985 -0
  7. package/framework/agents/compliance/iso-27001-specialist.md +713 -0
  8. package/framework/agents/compliance/pmbok-specialist.md +739 -0
  9. package/framework/agents/compliance/security-information-master.md +907 -0
  10. package/framework/agents/compliance/soc2-specialist.md +889 -0
  11. package/framework/agents/deployment/docker-specialist.md +1192 -0
  12. package/framework/agents/development/c4-architecture-specialist.md +745 -0
  13. package/framework/agents/development/c4-documentation-specialist.md +695 -0
  14. package/framework/agents/development/clickup-specialist.md +396 -0
  15. package/framework/agents/development/cursor-specialist.md +277 -0
  16. package/framework/agents/development/docs-reverse-engineer.md +417 -0
  17. package/framework/agents/development/gamma-api-specialist.md +1168 -0
  18. package/framework/agents/development/gitflow-specialist.md +1206 -0
  19. package/framework/agents/development/linux-security-specialist.md +675 -0
  20. package/framework/agents/development/mermaid-specialist.md +515 -0
  21. package/framework/agents/development/nodejs-specialist.md +672 -0
  22. package/framework/agents/development/nx-migration-specialist.md +866 -0
  23. package/framework/agents/development/nx-monorepo-specialist.md +618 -0
  24. package/framework/agents/development/postgres-specialist.md +1123 -0
  25. package/framework/agents/development/react-developer.md +131 -0
  26. package/framework/agents/development/runflow-specialist.md +277 -0
  27. package/framework/agents/development/system-documentation-orchestrator.md +1387 -0
  28. package/framework/agents/development/task-specialist.md +677 -0
  29. package/framework/agents/git/branch-code-reviewer.md +225 -0
  30. package/framework/agents/git/branch-documentation-writer.md +161 -0
  31. package/framework/agents/git/branch-metaspec-checker.md +67 -0
  32. package/framework/agents/git/branch-test-planner.md +176 -0
  33. package/framework/agents/meta/agent-creator-specialist.md +1266 -0
  34. package/framework/agents/meta/command-creator-specialist.md +1676 -0
  35. package/framework/agents/meta/metaspec-gate-keeper.md +240 -0
  36. package/framework/agents/meta/onion.md +824 -0
  37. package/framework/agents/product/branding-positioning-specialist.md +1029 -0
  38. package/framework/agents/product/extract-meeting-specialist.md +394 -0
  39. package/framework/agents/product/meeting-consolidator.md +482 -0
  40. package/framework/agents/product/pain-price-specialist.md +508 -0
  41. package/framework/agents/product/presentation-orchestrator.md +1190 -0
  42. package/framework/agents/product/product-agent.md +201 -0
  43. package/framework/agents/product/story-points-framework-specialist.md +538 -0
  44. package/framework/agents/product/storytelling-business-specialist.md +890 -0
  45. package/framework/agents/research/research-agent.md +292 -0
  46. package/framework/agents/review/code-reviewer.md +154 -0
  47. package/framework/agents/review/corporate-compliance-specialist.md +370 -0
  48. package/framework/agents/testing/test-agent.md +424 -0
  49. package/framework/agents/testing/test-engineer.md +294 -0
  50. package/framework/agents/testing/test-planner.md +117 -0
  51. package/framework/commands/common/prompts/README.md +208 -0
  52. package/framework/commands/common/prompts/clickup-patterns.md +144 -0
  53. package/framework/commands/common/prompts/code-review-checklist.md +168 -0
  54. package/framework/commands/common/prompts/git-workflow-patterns.md +235 -0
  55. package/framework/commands/common/prompts/output-formats.md +240 -0
  56. package/framework/commands/common/prompts/technical.md +194 -0
  57. package/framework/commands/common/templates/abstraction-template.md +399 -0
  58. package/framework/commands/common/templates/agent-template.md +353 -0
  59. package/framework/commands/common/templates/business_context_template.md +748 -0
  60. package/framework/commands/common/templates/command-template.md +273 -0
  61. package/framework/commands/common/templates/technical_context_template.md +526 -0
  62. package/framework/commands/design/screen-spec.md +505 -0
  63. package/framework/commands/development/runflow-dev.md +465 -0
  64. package/framework/commands/docs/build-business-docs.md +299 -0
  65. package/framework/commands/docs/build-compliance-docs.md +143 -0
  66. package/framework/commands/docs/build-index.md +119 -0
  67. package/framework/commands/docs/build-tech-docs.md +221 -0
  68. package/framework/commands/docs/docs-health.md +141 -0
  69. package/framework/commands/docs/help.md +278 -0
  70. package/framework/commands/docs/refine-vision.md +25 -0
  71. package/framework/commands/docs/reverse-consolidate.md +158 -0
  72. package/framework/commands/docs/sync-sessions.md +354 -0
  73. package/framework/commands/docs/validate-docs.md +157 -0
  74. package/framework/commands/engineer/bump.md +29 -0
  75. package/framework/commands/engineer/docs.md +11 -0
  76. package/framework/commands/engineer/hotfix.md +183 -0
  77. package/framework/commands/engineer/plan.md +85 -0
  78. package/framework/commands/engineer/pr-update.md +219 -0
  79. package/framework/commands/engineer/pr.md +117 -0
  80. package/framework/commands/engineer/pre-pr.md +81 -0
  81. package/framework/commands/engineer/start.md +254 -0
  82. package/framework/commands/engineer/validate-phase-sync.md +134 -0
  83. package/framework/commands/engineer/warm-up.md +20 -0
  84. package/framework/commands/engineer/work.md +155 -0
  85. package/framework/commands/f/company-context-extractor.md +93 -0
  86. package/framework/commands/f/process-meetings.md +103 -0
  87. package/framework/commands/git/README.md +682 -0
  88. package/framework/commands/git/code-review.md +213 -0
  89. package/framework/commands/git/fast-commit.md +43 -0
  90. package/framework/commands/git/feature/finish.md +88 -0
  91. package/framework/commands/git/feature/publish.md +89 -0
  92. package/framework/commands/git/feature/start.md +172 -0
  93. package/framework/commands/git/help.md +100 -0
  94. package/framework/commands/git/hotfix/finish.md +96 -0
  95. package/framework/commands/git/hotfix/start.md +92 -0
  96. package/framework/commands/git/init.md +111 -0
  97. package/framework/commands/git/release/finish.md +96 -0
  98. package/framework/commands/git/release/start.md +93 -0
  99. package/framework/commands/git/sync.md +199 -0
  100. package/framework/commands/meta/all-tools.md +58 -0
  101. package/framework/commands/meta/analyze-complex-problem.md +186 -0
  102. package/framework/commands/meta/create-abstraction.md +882 -0
  103. package/framework/commands/meta/create-agent-express.md +98 -0
  104. package/framework/commands/meta/create-agent.md +210 -0
  105. package/framework/commands/meta/create-command.md +203 -0
  106. package/framework/commands/meta/create-knowledge-base.md +143 -0
  107. package/framework/commands/meta/create-task-structure.md +150 -0
  108. package/framework/commands/meta/setup-integration.md +274 -0
  109. package/framework/commands/onion.md +169 -0
  110. package/framework/commands/product/README.md +249 -0
  111. package/framework/commands/product/analyze-pain-price.md +694 -0
  112. package/framework/commands/product/branding.md +458 -0
  113. package/framework/commands/product/check.md +46 -0
  114. package/framework/commands/product/checklist-sync.md +239 -0
  115. package/framework/commands/product/collect.md +95 -0
  116. package/framework/commands/product/consolidate-meetings.md +291 -0
  117. package/framework/commands/product/estimate.md +511 -0
  118. package/framework/commands/product/extract-meeting.md +226 -0
  119. package/framework/commands/product/feature.md +416 -0
  120. package/framework/commands/product/light-arch.md +82 -0
  121. package/framework/commands/product/presentation.md +174 -0
  122. package/framework/commands/product/refine.md +161 -0
  123. package/framework/commands/product/spec.md +79 -0
  124. package/framework/commands/product/task-check.md +378 -0
  125. package/framework/commands/product/task.md +603 -0
  126. package/framework/commands/product/validate-task.md +325 -0
  127. package/framework/commands/product/warm-up.md +24 -0
  128. package/framework/commands/quick/analisys.md +17 -0
  129. package/framework/commands/test/e2e.md +377 -0
  130. package/framework/commands/test/integration.md +508 -0
  131. package/framework/commands/test/unit.md +381 -0
  132. package/framework/commands/validate/collab/pair-testing.md +657 -0
  133. package/framework/commands/validate/collab/three-amigos.md +534 -0
  134. package/framework/commands/validate/qa-points/estimate.md +660 -0
  135. package/framework/commands/validate/test-strategy/analyze.md +1201 -0
  136. package/framework/commands/validate/test-strategy/create.md +411 -0
  137. package/framework/commands/validate/workflow.md +370 -0
  138. package/framework/commands/warm-up.md +20 -0
  139. package/framework/docs/architecture/acoplamento-clickup-problema-analise.md +468 -0
  140. package/framework/docs/architecture/desacoplamento-roadmap.md +364 -0
  141. package/framework/docs/architecture/validacao-fase-1.md +235 -0
  142. package/framework/docs/c4/c4-detection-rules.md +395 -0
  143. package/framework/docs/c4/c4-documentation-templates.md +579 -0
  144. package/framework/docs/c4/c4-mermaid-patterns.md +331 -0
  145. package/framework/docs/c4/c4-templates.md +256 -0
  146. package/framework/docs/clickup/clickup-acceptance-criteria-strategy.md +329 -0
  147. package/framework/docs/clickup/clickup-auto-update-strategy.md +340 -0
  148. package/framework/docs/clickup/clickup-comment-formatter.md +239 -0
  149. package/framework/docs/clickup/clickup-description-fix.md +384 -0
  150. package/framework/docs/clickup/clickup-dual-comment-strategy.md +528 -0
  151. package/framework/docs/clickup/clickup-formatting.md +302 -0
  152. package/framework/docs/clickup/separador-tamanho-otimizado.md +258 -0
  153. package/framework/docs/engineer/pre-pr-acceptance-validation.md +256 -0
  154. package/framework/docs/onion/ESPERANTO.md +293 -0
  155. package/framework/docs/onion/agents-reference.md +832 -0
  156. package/framework/docs/onion/clickup-integration.md +780 -0
  157. package/framework/docs/onion/commands-guide.md +924 -0
  158. package/framework/docs/onion/engineering-flows.md +900 -0
  159. package/framework/docs/onion/getting-started.md +803 -0
  160. package/framework/docs/onion/maintenance-checklist.md +421 -0
  161. package/framework/docs/onion/naming-conventions.md +286 -0
  162. package/framework/docs/onion/practical-examples.md +854 -0
  163. package/framework/docs/product/story-points-integration.md +269 -0
  164. package/framework/docs/product/story-points-validation.md +237 -0
  165. package/framework/docs/reviews/task-manager-docs-review-2025-11-24.md +184 -0
  166. package/framework/docs/strategies/clickup-comment-patterns.md +766 -0
  167. package/framework/docs/strategies/clickup-integration-tests.md +602 -0
  168. package/framework/docs/strategies/clickup-mcp-wrappers-tests.md +888 -0
  169. package/framework/docs/strategies/clickup-regression-tests.md +587 -0
  170. package/framework/docs/strategies/visual-patterns.md +315 -0
  171. package/framework/docs/templates/README.md +649 -0
  172. package/framework/docs/templates/adr-template.md +226 -0
  173. package/framework/docs/templates/analysis-template.md +280 -0
  174. package/framework/docs/templates/execution-plan-template.md +430 -0
  175. package/framework/docs/templates/guide-template.md +367 -0
  176. package/framework/docs/templates/phase-execution-prompt-template.md +504 -0
  177. package/framework/docs/templates/reference-template.md +522 -0
  178. package/framework/docs/templates/solution-template.md +390 -0
  179. package/framework/docs/tools/README.md +356 -0
  180. package/framework/docs/tools/agents.md +365 -0
  181. package/framework/docs/tools/commands.md +669 -0
  182. package/framework/docs/tools/cursor.md +539 -0
  183. package/framework/docs/tools/mcps.md +937 -0
  184. package/framework/docs/tools/rules.md +461 -0
  185. package/framework/rules/language-and-documentation.mdc +371 -0
  186. package/framework/rules/nestjs-controllers.md +83 -0
  187. package/framework/rules/nestjs-dtos.md +255 -0
  188. package/framework/rules/nestjs-modules.md +141 -0
  189. package/framework/rules/nestjs-services.md +230 -0
  190. package/framework/rules/nx-rules.mdc +41 -0
  191. package/framework/rules/onion-patterns.mdc +197 -0
  192. package/framework/skills/codebase-visualizer/SKILL.md +26 -0
  193. package/framework/skills/codebase-visualizer/scripts/visualize.py +131 -0
  194. package/framework/skills/collect/SKILL.md +84 -0
  195. package/framework/skills/create-rule/SKILL.md +152 -0
  196. package/framework/skills/db-schema-visualizer/SKILL.md +49 -0
  197. package/framework/skills/db-schema-visualizer/scripts/visualize.py +1191 -0
  198. package/framework/skills/sync-meetings/SKILL.md +239 -0
  199. package/framework/utils/clickup-mcp-wrappers.md +744 -0
  200. package/framework/utils/date-time-standards.md +200 -0
  201. package/framework/utils/task-manager/README.md +94 -0
  202. package/framework/utils/task-manager/adapters/asana.md +377 -0
  203. package/framework/utils/task-manager/adapters/clickup.md +467 -0
  204. package/framework/utils/task-manager/adapters/linear.md +421 -0
  205. package/framework/utils/task-manager/detector.md +299 -0
  206. package/framework/utils/task-manager/factory.md +363 -0
  207. package/framework/utils/task-manager/interface.md +248 -0
  208. package/framework/utils/task-manager/types.md +409 -0
  209. package/package.json +41 -0
  210. package/src/cli.js +73 -0
  211. package/src/commands/doctor.js +191 -0
  212. package/src/commands/init.js +287 -0
  213. package/src/commands/install.js +261 -0
  214. package/src/commands/list.js +152 -0
  215. package/src/commands/uninstall.js +90 -0
  216. package/src/commands/update.js +26 -0
  217. package/src/utils/fs.js +89 -0
  218. package/src/utils/log.js +35 -0
  219. package/src/utils/paths.js +32 -0
  220. package/src/utils/prompt.js +76 -0
@@ -0,0 +1,221 @@
1
+ ---
2
+ name: build-tech-docs
3
+ description: Generate comprehensive technical documentation from the codebase.
4
+ model: sonnet
5
+ category: docs
6
+ tags: [technical, architecture, documentation]
7
+ version: '3.0.0'
8
+ updated: '2025-11-24'
9
+ ---
10
+
11
+ # Technical Documentation Generator
12
+
13
+ You are a technical documentation architect specialized in creating comprehensive, AI-optimized project context. Your mission is to analyze the project codebase, repository, and other source materials to generate a complete technical documentation structure using the multi-file architecture approach.
14
+
15
+ ## Primary Objective
16
+
17
+ Generate a complete technical context architecture following the template in `.claude/commands/common/templates/technical_context_template.md`. Create a modular, multi-file documentation structure that enables both human developers and AI systems to understand and work effectively with the codebase.
18
+
19
+ ## Input Parameters
20
+
21
+ **Required Arguments:**
22
+ You must receive links to files, repositories, and other source materials to generate the technical documentation. These will be placed in your arguments. If you have not received arguments, you must request them before proceeding.
23
+
24
+ <arguments>
25
+ #$ARGUMENTS
26
+ </arguments>
27
+
28
+ ## Analysis Framework
29
+
30
+ ### Phase 1: Codebase Discovery
31
+
32
+ 1. **Project Structure Analysis**
33
+ - Scan directory structure and identify key architectural patterns
34
+ - Analyze package.json, requirements.txt, Cargo.toml, or equivalent dependency files
35
+ - Identify build systems, test frameworks, and deployment configurations
36
+ - Detect technology stack, frameworks, and key dependencies
37
+
38
+ 2. **Architectural Pattern Recognition**
39
+ - Identify design patterns (MVC, microservices, event-driven, etc.)
40
+ - Analyze data flow and integration points
41
+ - Understand deployment and scaling architecture
42
+ - Document key abstractions and interfaces
43
+
44
+ 3. **Development Workflow Discovery**
45
+ - Analyze CI/CD configurations (.github/workflows, .gitlab-ci.yml, etc.)
46
+ - Identify testing strategies and coverage requirements
47
+ - Review contribution guidelines and development setup
48
+ - Document build, lint, and deployment processes
49
+
50
+ ### Phase 2: User Discussion
51
+
52
+ After building a good understanding of the project, you will ask the human a series of questions to clarify doubts or missing information. Plan to ask at least 10 questions that cover most strategic areas in the documentation. Be selective about the questions you ask, and try to avoid questions that are not relevant to the project.
53
+
54
+ - If the stack is clear from the codebase, no need to ask about it.
55
+ - Identify the main architectural decisions and ask about why they were made -- this should help guide your ADR development
56
+ - Ask about the product development process and workflow, if not clear
57
+ - Ask about the product testing process and workflow, if not clear
58
+ - Ask about the product deployment process and workflow, if not clear
59
+ - Ask about the product maintenance process and workflow, if not clear
60
+ - Ask about current architectural challenges and things the team would like to improve
61
+ - Make sure you understand what is in scope and out of scope
62
+
63
+ Do multiple rounds of Q&A if you feel you still need to get more information.
64
+ 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.
65
+
66
+ ### Phase 3: Context Generation
67
+
68
+ 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.
69
+
70
+ Follow the multi-file structure from the technical template:
71
+
72
+ #### Create Index File (`index.md`)
73
+
74
+ ```markdown
75
+ ## Project Context Profile
76
+
77
+ [Basic project information, technology stack, team structure, development constraints]
78
+
79
+ ## Layer 1: Core Project Context
80
+
81
+ - [Project Charter](project_charter.md)
82
+ - [Architecture Decision Records](adr/)
83
+
84
+ ## Layer 2: AI-Optimized Context Files
85
+
86
+ - [AI Development Guide](CURSOR.meta.md)
87
+ - [Codebase Navigation Guide](CODEBASE_GUIDE.md)
88
+
89
+ ## Layer 3: Domain-Specific Context
90
+
91
+ - [Business Logic Documentation](BUSINESS_LOGIC.md)
92
+ - [API Specifications](API_SPECIFICATION.md)
93
+
94
+ ## Layer 4: Development Workflow Context
95
+
96
+ - [Development Workflow Guide](CONTRIBUTING.md)
97
+ - [Troubleshooting Guide](TROUBLESHOOTING.md)
98
+ ```
99
+
100
+ #### Generate Individual Files
101
+
102
+ **1. `project_charter.md`**
103
+
104
+ - Synthesize project vision from README, documentation, and code analysis
105
+ - Define success criteria based on project goals and metrics
106
+ - Establish scope boundaries from codebase analysis
107
+ - Identify key stakeholders from contributor data
108
+ - Document technical constraints from architecture analysis
109
+
110
+ **2. `adr/` Directory**
111
+
112
+ - Create ADRs for major architectural decisions discovered in codebase
113
+ - Document technology choices, patterns, and trade-offs
114
+ - Include database choices, framework selections, deployment strategies
115
+ - Reference commit history and comments for decision context
116
+
117
+ **3. `CURSOR.meta.md` (AI Development Guide)**
118
+
119
+ - Extract code style patterns from existing codebase
120
+ - Document testing approaches from test files and configurations
121
+ - Identify common patterns from code analysis
122
+ - List gotchas from comments, issues, and documentation
123
+ - Include performance considerations and security patterns
124
+
125
+ **4. `CODEBASE_GUIDE.md`**
126
+
127
+ - Generate directory structure with purpose annotations
128
+ - List key files and their roles in the system
129
+ - Document data flow patterns from code analysis
130
+ - Identify integration points and external dependencies
131
+ - Describe deployment architecture from configurations
132
+
133
+ **5. `BUSINESS_LOGIC.md`** (if complex domain logic exists)
134
+
135
+ - Extract domain concepts from models, schemas, and business logic
136
+ - Document business rules from validation logic and workflows
137
+ - Identify edge cases from tests and error handling
138
+ - Map workflow processes from state machines and business logic
139
+
140
+ **6. `API_SPECIFICATION.md`** (if APIs exist)
141
+
142
+ - Generate API documentation from routes, controllers, and schemas
143
+ - Document authentication from middleware and security implementations
144
+ - Extract data models from schemas and type definitions
145
+ - Document error handling from exception handling code
146
+ - Include rate limiting and performance characteristics
147
+
148
+ **7. `CONTRIBUTING.md`**
149
+
150
+ - Extract branch strategy from git history and configurations
151
+ - Document code review process from PR templates and workflows
152
+ - List testing requirements from test configurations
153
+ - Document deployment process from CI/CD configurations
154
+ - Include environment setup from README and development configurations
155
+
156
+ **8. `TROUBLESHOOTING.md`**
157
+
158
+ - Extract common issues from GitHub issues, comments, and documentation
159
+ - Document debugging approaches from logging and monitoring setup
160
+ - Include performance troubleshooting from profiling and optimization code
161
+ - List integration issues from error handling and documentation
162
+
163
+ **9. `ARCHITECTURE_CHALLENGES.md`**
164
+
165
+ - Document architecture challenges and things the team would like to improve
166
+
167
+ ## Quality Assurance
168
+
169
+ ### Content Quality Checks
170
+
171
+ - [ ] All generated content is accurate to the actual codebase
172
+ - [ ] Examples are working and tested against the actual project
173
+ - [ ] Architecture documentation matches implementation
174
+ - [ ] Performance claims are backed by actual benchmarks or code analysis
175
+ - [ ] All links between files work correctly
176
+
177
+ ### Completeness Validation
178
+
179
+ - [ ] All layers of technical context are addressed
180
+ - [ ] Files follow the established template structure
181
+ - [ ] Content is specific to the project, not generic
182
+ - [ ] AI optimization guidelines are practical and actionable
183
+ - [ ] Development workflow matches actual project practices
184
+
185
+ ### AI Optimization
186
+
187
+ - [ ] Content enables AI to understand project architecture
188
+ - [ ] Code examples are copy-pasteable and functional
189
+ - [ ] Technical constraints and trade-offs are clearly documented
190
+ - [ ] Cross-references between files create comprehensive context
191
+ - [ ] File naming follows established conventions
192
+
193
+ ## Execution Strategy
194
+
195
+ 1. **Deep Analysis First**: Spend significant time understanding the codebase before writing
196
+ 2. **Evidence-Based Documentation**: Every claim should be backed by code, configurations, or project artifacts
197
+ 3. **Multi-File Structure**: Always create separate files linked through the index
198
+ 4. **AI-Optimized Content**: Write for both human and AI consumption
199
+ 5. **Project-Specific Details**: Avoid generic advice; focus on actual project specifics
200
+ 6. **Cross-Reference Integration**: Ensure files reference each other appropriately
201
+
202
+ ## Output Success Criteria
203
+
204
+ The generated technical documentation should enable:
205
+
206
+ - **New developers** to understand and contribute to the project within hours
207
+ - **AI systems** to provide accurate, contextual assistance with development tasks
208
+ - **Technical decisions** to be made with full context of existing architecture
209
+ - **Code reviews** to focus on logic rather than style or architectural questions
210
+ - **Debugging and troubleshooting** to be systematic and efficient
211
+
212
+ ## Error Handling
213
+
214
+ If certain information cannot be determined from the codebase:
215
+
216
+ - Clearly mark sections as "TO BE COMPLETED" with specific instructions
217
+ - Provide templates for missing information
218
+ - Reference where the information should come from
219
+ - Create issues or TODOs for follow-up documentation work
220
+
221
+ 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.
@@ -0,0 +1,141 @@
1
+ ---
2
+ name: docs-health
3
+ description: |
4
+ Health check completo da documentação do projeto.
5
+ Use para diagnóstico de qualidade, gaps e recomendações.
6
+ model: sonnet
7
+
8
+ parameters:
9
+ - name: path
10
+ description: Caminho para analisar (default: docs/)
11
+ required: false
12
+ default: docs/
13
+
14
+ category: docs
15
+ tags:
16
+ - health-check
17
+ - documentation
18
+ - quality
19
+
20
+ version: "3.0.0"
21
+ updated: "2025-11-24"
22
+
23
+ related_commands:
24
+ - /docs/validate-docs
25
+ - /docs/build-tech-docs
26
+
27
+ related_agents:
28
+ - system-documentation-orchestrator
29
+ ---
30
+
31
+ # 🏥 Docs Health Check
32
+
33
+ Verificação abrangente de saúde da documentação.
34
+
35
+ ## 🎯 Objetivo
36
+
37
+ Fornecer diagnóstico completo com score, gaps e recomendações.
38
+
39
+ ## ⚡ Fluxo de Execução
40
+
41
+ ### Passo 1: Coletar Métricas
42
+
43
+ ```bash
44
+ # Contar arquivos de docs
45
+ TOTAL=$(find {{path}} -name "*.md" | wc -l)
46
+
47
+ # Verificar estrutura
48
+ ls -la {{path}}/
49
+
50
+ # Arquivos grandes (>500 linhas)
51
+ find {{path}} -name "*.md" -exec wc -l {} \; | sort -rn | head -10
52
+ ```
53
+
54
+ ### Passo 2: Analisar Estrutura
55
+
56
+ #### Checklist de Estrutura
57
+
58
+ - [ ] README.md existe
59
+ - [ ] Índice/navegação presente
60
+ - [ ] Pastas organizadas por categoria
61
+ - [ ] Naming consistente (kebab-case)
62
+
63
+ ### Passo 3: Avaliar Qualidade
64
+
65
+ #### Critérios de Qualidade
66
+
67
+ | Critério | Peso | Verificação |
68
+ | ------------ | ---- | ------------------- |
69
+ | Completude | 25% | Seções obrigatórias |
70
+ | Consistência | 20% | Formatação uniforme |
71
+ | Atualidade | 20% | Datas de update |
72
+ | Links | 15% | Links funcionais |
73
+ | Exemplos | 10% | Código de exemplo |
74
+ | TOC | 10% | Table of contents |
75
+
76
+ ### Passo 4: Identificar Gaps
77
+
78
+ ```bash
79
+ # Arquivos sem update recente (>90 dias)
80
+ find {{path}} -name "*.md" -mtime +90
81
+
82
+ # Arquivos pequenos (<50 linhas)
83
+ find {{path}} -name "*.md" -exec wc -l {} \; | awk '$1<50'
84
+ ```
85
+
86
+ ### Passo 5: Calcular Score
87
+
88
+ ```
89
+ Score = (Estrutura × 0.25) + (Qualidade × 0.25) +
90
+ (Cobertura × 0.25) + (Atualidade × 0.25)
91
+ ```
92
+
93
+ | Score | Status |
94
+ | ------ | ------------ |
95
+ | 90-100 | 🟢 Excelente |
96
+ | 70-89 | 🟡 Bom |
97
+ | 50-69 | 🟠 Regular |
98
+ | <50 | 🔴 Crítico |
99
+
100
+ ## 📤 Output Esperado
101
+
102
+ ```
103
+ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
104
+ 🏥 DOCS HEALTH REPORT
105
+ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
106
+
107
+ 📊 Score Geral: 78/100 🟡
108
+
109
+ 📈 Métricas:
110
+ ∟ Arquivos: 45
111
+ ∟ Linhas: 12,450
112
+ ∟ Cobertura: 72%
113
+
114
+ ✅ Pontos Fortes:
115
+ ∟ Estrutura organizada
116
+ ∟ README completo
117
+ ∟ Exemplos presentes
118
+
119
+ ⚠️ Gaps Identificados:
120
+ ∟ 5 arquivos sem atualização >90d
121
+ ∟ API docs incompleta
122
+ ∟ Falta troubleshooting
123
+
124
+ 💡 Recomendações:
125
+ 1. Atualizar docs de API
126
+ 2. Adicionar seção troubleshooting
127
+ 3. Revisar arquivos antigos
128
+
129
+ 🎯 Meta: 85/100 (próximo quarter)
130
+ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
131
+ ```
132
+
133
+ ## 🔗 Referências
134
+
135
+ - Validação: /docs/validate-docs
136
+ - Agente: @system-documentation-orchestrator
137
+
138
+ ## ⚠️ Notas
139
+
140
+ - Executar mensalmente para tracking
141
+ - Score histórico salvo em `.claude/metrics/`
@@ -0,0 +1,278 @@
1
+ ---
2
+ name: help
3
+ description: Ajuda interativa para comandos de documentação Onion.
4
+ model: sonnet
5
+ category: docs
6
+ tags: [help, documentation, guide]
7
+ version: "3.0.0"
8
+ updated: "2025-11-24"
9
+ ---
10
+
11
+ # 📚 Sistema de Ajuda - Comandos de Documentação
12
+
13
+ Você é um assistente de IA especializado em **fornecer ajuda interativa para comandos de documentação** do Sistema Onion. Seu papel é educar usuários sobre os comandos disponíveis através de uma interface clara e educativa.
14
+
15
+ ## 🎯 **Funcionalidades**
16
+
17
+ ### **📚 Sistema de Ajuda Educativo:**
18
+ - **Help geral** - Visão geral de todos os comandos de documentação
19
+ - **Help específico** - Detalhes profundos sobre cada comando individual
20
+ - **Orientação contextual** sobre quando usar cada ferramenta
21
+ - **Exemplos práticos** para acelerar a adoção
22
+ - **Workflows educativos** para dominar os comandos
23
+
24
+ ### **🔍 Inteligência Contextual:**
25
+ - Detectar comando específico solicitado
26
+ - Fornecer orientação baseada no contexto
27
+ - Sugerir próximos passos lógicos
28
+ - Explicar diferenças entre comandos similares
29
+
30
+ ---
31
+
32
+ ## 📋 **Comandos Disponíveis**
33
+
34
+ O Sistema Onion oferece **4 comandos especializados** para documentação:
35
+
36
+ ### **🔧 `/docs/build-tech-docs`** - Documentação Técnica Completa
37
+ **Objetivo**: Gerar documentação técnica abrangente para projetos
38
+ **Quando usar**: Projetos que precisam de contexto técnico para desenvolvedores
39
+ **Workflow**: Análise codebase → Q&A interativo → Múltiplos arquivos técnicos
40
+ **Output**: project_charter.md, CURSOR.meta.md, CODEBASE_GUIDE.md, etc.
41
+
42
+ ### **📊 `/docs/build-business-docs`** - Contexto de Negócio
43
+ **Objetivo**: Criar inteligência de negócios otimizada para IA
44
+ **Quando usar**: Compreender clientes, mercado e estratégia de produto
45
+ **Workflow**: Análise produto → Q&A estratégico → Múltiplos arquivos de negócio
46
+ **Output**: CUSTOMER_PERSONAS.md, COMPETITIVE_LANDSCAPE.md, etc.
47
+
48
+ ### **🗂️ `/docs/build-index`** - Construção de Índices
49
+ **Objetivo**: Organizar documentação através de índices estruturados
50
+ **Quando usar**: Múltiplos projetos precisam de organização centralizada
51
+ **Workflow**: Análise estrutura → Geração/atualização de índices
52
+ **Sintaxe**:
53
+ - `/docs/build-index` (índice geral de projetos)
54
+ - `/docs/build-index <project-name>` (índice específico)
55
+
56
+ ### **🚧 `/docs/refine-vision`** - Refinamento de Visão *(Implementação Futura)*
57
+ **Status**: Em desenvolvimento
58
+ **Objetivo**: Refinar e otimizar visão estratégica de projetos
59
+ **Disponibilidade**: Próxima versão do Sistema Onion
60
+
61
+ ---
62
+
63
+ ## 🚀 **Uso do Comando**
64
+
65
+ ### **Sintaxe:**
66
+ ```bash
67
+ /docs/help # Help geral - todos os comandos
68
+ /docs/help [comando] # Help específico detalhado
69
+ ```
70
+
71
+ ### **Exemplos:**
72
+ ```bash
73
+ /docs/help # Visão geral completa
74
+ /docs/help build-tech-docs # Documentação técnica detalhada
75
+ /docs/help build-business-docs # Contexto de negócio detalhado
76
+ /docs/help build-index # Construção de índices detalhada
77
+ /docs/help refine-vision # Status de implementação futura
78
+ ```
79
+
80
+ ---
81
+
82
+ ## ⚙️ **Sistema de Detecção de Argumentos**
83
+
84
+ <arguments>
85
+ #$ARGUMENTS
86
+ </arguments>
87
+
88
+ # Detectar comando específico ou help geral
89
+ COMANDO_ESPECIFICO="${1:-}"
90
+
91
+ echo ""
92
+ echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
93
+ echo "📚 SISTEMA DE AJUDA - COMANDOS DE DOCUMENTAÇÃO"
94
+ echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
95
+ echo ""
96
+
97
+ if [ "$COMANDO_ESPECIFICO" = "build-tech-docs" ]; then
98
+ echo "🔧 **HELP ESPECÍFICO: /docs/build-tech-docs**"
99
+ echo ""
100
+ echo "**📋 Objetivo Detalhado:**"
101
+ echo "Gerador de documentação técnica especializado em criar contexto"
102
+ echo "de projeto abrangente e otimizado para IA. Analisa codebase completo"
103
+ echo "e gera estrutura multi-arquivo para desenvolvedores e sistemas IA."
104
+ echo ""
105
+ echo "**🏗️ Workflow Completo:**"
106
+ echo " ▶ **Fase 1**: Descoberta do Codebase"
107
+ echo " ∟ Análise da estrutura do projeto"
108
+ echo " ∟ Reconhecimento de padrões arquiteturais"
109
+ echo " ∟ Descoberta do workflow de desenvolvimento"
110
+ echo ""
111
+ echo " ▶ **Fase 2**: Q&A Interativo com Usuário"
112
+ echo " ∟ Perguntas estratégicas sobre arquitetura"
113
+ echo " ∟ Validação de decisões técnicas importantes"
114
+ echo " ∟ Esclarecimento de contexto específico"
115
+ echo ""
116
+ echo " ▶ **Fase 3**: Geração de Contexto Multi-Arquivo"
117
+ echo " ∟ project_charter.md (visão e objetivos)"
118
+ echo " ∟ CURSOR.meta.md (guia de desenvolvimento IA)"
119
+ echo " ∟ CODEBASE_GUIDE.md (navegação do código)"
120
+ echo " ∟ BUSINESS_LOGIC.md (regras de negócio)"
121
+ echo " ∟ API_SPECIFICATION.md (APIs e interfaces)"
122
+ echo ""
123
+ echo "**📚 Argumentos Obrigatórios:**"
124
+ echo "Você deve fornecer links para arquivos, repositórios ou outras"
125
+ echo "fontes de materiais para análise técnica."
126
+ echo ""
127
+ echo "**✅ Quando Usar:**"
128
+ echo " ▶ Novos desenvolvedores precisam entender o projeto rapidamente"
129
+ echo " ▶ Sistemas de IA precisam de contexto técnico abrangente"
130
+ echo " ▶ Decisões técnicas precisam de documentação arquitetural"
131
+ echo " ▶ Code reviews precisam focar em lógica vs arquitetura"
132
+ echo ""
133
+ echo "**🎯 Exemplo de Uso:**"
134
+ echo ' /docs/build-tech-docs "https://github.com/user/projeto"'
135
+ echo ""
136
+
137
+ elif [ "$COMANDO_ESPECIFICO" = "build-business-docs" ]; then
138
+ echo "📊 **HELP ESPECÍFICO: /docs/build-business-docs**"
139
+ echo ""
140
+ echo "**📋 Objetivo Detalhado:**"
141
+ echo "Analista de negócios especializado em criar inteligência de negócios"
142
+ echo "abrangente e otimizada para IA. Analisa produto/projeto e gera"
143
+ echo "contexto completo de negócio usando abordagem multi-arquivo."
144
+ echo ""
145
+ echo "**🏗️ Workflow Completo:**"
146
+ echo " ▶ **Fase 1**: Descoberta do Produto"
147
+ echo " ∟ Entendimento do produto e proposta de valor"
148
+ echo " ∟ Pesquisa de mercado e panorama competitivo"
149
+ echo " ∟ Coleta de inteligência do cliente"
150
+ echo ""
151
+ echo " ▶ **Fase 2**: Q&A Estratégico com Usuário"
152
+ echo " ∟ Perguntas sobre visão do produto"
153
+ echo " ∟ Identificação de personas e concorrentes"
154
+ echo " ∟ Validação de estratégia de negócio"
155
+ echo ""
156
+ echo " ▶ **Fase 3**: Geração de Contexto Multi-Arquivo"
157
+ echo " ∟ CUSTOMER_PERSONAS.md (perfis de cliente)"
158
+ echo " ∟ CUSTOMER_JOURNEY.md (jornada completa)"
159
+ echo " ∟ VOICE_OF_CUSTOMER.md (feedback e padrões)"
160
+ echo " ∟ COMPETITIVE_LANDSCAPE.md (análise competitiva)"
161
+ echo " ∟ PRODUCT_STRATEGY.md (estratégia e posicionamento)"
162
+ echo ""
163
+ echo "**📚 Argumentos Obrigatórios:**"
164
+ echo "Você deve fornecer links para materiais de produto, landing pages,"
165
+ echo "documentação de marketing ou outras fontes de contexto de negócio."
166
+ echo ""
167
+ echo "**✅ Quando Usar:**"
168
+ echo " ▶ Times de vendas precisam alinhar mensagens com mercado"
169
+ echo " ▶ Sistemas de IA precisam fornecer suporte contextual ao cliente"
170
+ echo " ▶ Decisões de produto precisam de contexto completo de mercado"
171
+ echo " ▶ Planejamento estratégico requer inteligência competitiva"
172
+ echo ""
173
+ echo "**🎯 Exemplo de Uso:**"
174
+ echo ' /docs/build-business-docs "https://empresa.com" "docs/produto/"'
175
+ echo ""
176
+
177
+ elif [ "$COMANDO_ESPECIFICO" = "build-index" ]; then
178
+ echo "🗂️ **HELP ESPECÍFICO: /docs/build-index**"
179
+ echo ""
180
+ echo "**📋 Objetivo Detalhado:**"
181
+ echo "Construtor especializado de índices para organização de documentação"
182
+ echo "de múltiplos projetos. Cria estrutura canônica de navegação que"
183
+ echo "funciona como fonte única da verdade para todos os projetos."
184
+ echo ""
185
+ echo "**🏗️ Workflow Simplificado:**"
186
+ echo " ▶ **Análise**: Examina estrutura de pastas e arquivos existentes"
187
+ echo " ▶ **Organização**: Identifica projetos e recursos principais"
188
+ echo " ▶ **Geração**: Cria/atualiza arquivos index.md estruturados"
189
+ echo ""
190
+ echo "**📚 Sintaxe e Argumentos:**"
191
+ echo " ▶ **Índice Geral**: /docs/build-index"
192
+ echo " ∟ Constrói index.md raiz com todos os projetos"
193
+ echo " ∟ Informações: nome, descrição, ClickUp IDs, repositório"
194
+ echo ""
195
+ echo " ▶ **Índice Específico**: /docs/build-index <project-name>"
196
+ echo " ∟ Reconstrói índice após mudanças estruturais"
197
+ echo " ∟ Mapeia recursos úteis dentro do projeto específico"
198
+ echo ""
199
+ echo "**✅ Quando Usar:**"
200
+ echo " ▶ Múltiplos projetos precisam de organização centralizada"
201
+ echo " ▶ Estrutura de diretórios foi modificada significativamente"
202
+ echo " ▶ Novos projetos foram adicionados à organização"
203
+ echo " ▶ Navegação de documentação precisa ser atualizada"
204
+ echo ""
205
+ echo "**🎯 Exemplos de Uso:**"
206
+ echo " /docs/build-index # Índice geral"
207
+ echo " /docs/build-index projeto-mobile # Índice específico"
208
+ echo ""
209
+
210
+ elif [ "$COMANDO_ESPECIFICO" = "refine-vision" ]; then
211
+ echo "🚧 **HELP ESPECÍFICO: /docs/refine-vision**"
212
+ echo ""
213
+ echo "**📋 Status Atual:**"
214
+ echo "Este comando está em **desenvolvimento ativo** e será incluído"
215
+ echo "em uma próxima versão do Sistema Onion."
216
+ echo ""
217
+ echo "**🔮 Objetivo Planejado:**"
218
+ echo "Especialista em refinamento de visão estratégica de projetos."
219
+ echo "Analisará documentação existente e facilitará processo colaborativo"
220
+ echo "para refinar e otimizar visão de produto/projeto."
221
+ echo ""
222
+ echo "**🛠️ Funcionalidades Futuras:**"
223
+ echo " ▶ **Análise de Visão Atual**: Auditoria de documentação estratégica"
224
+ echo " ▶ **Workshop Guiado**: Facilitação de sessões de refinamento"
225
+ echo " ▶ **Alinhamento de Stakeholders**: Validação com partes interessadas"
226
+ echo " ▶ **Documentação Atualizada**: Geração de artefatos refinados"
227
+ echo ""
228
+ echo "**📅 Timeline Estimado:**"
229
+ echo "Implementação planejada para próximo release do Sistema Onion."
230
+ echo ""
231
+ echo "**💡 Alternativas Atuais:**"
232
+ echo " ▶ Use /docs/build-business-docs para contexto estratégico"
233
+ echo " ▶ Use /docs/build-tech-docs para visão técnica de produto"
234
+ echo " ▶ Combine ambos para contexto abrangente de projeto"
235
+ echo ""
236
+
237
+ else
238
+ echo "🎯 **HELP GERAL - VISÃO COMPLETA DOS COMANDOS**"
239
+ echo ""
240
+ echo "O Sistema Onion oferece **4 comandos especializados** para"
241
+ echo "documentação inteligente otimizada para IA:"
242
+ echo ""
243
+ echo "**🔧 Documentação Técnica:**"
244
+ echo " ▶ **/docs/build-tech-docs** - Contexto técnico completo"
245
+ echo " ∟ Para: Desenvolvedores, sistemas IA, decisões técnicas"
246
+ echo " ∟ Output: project_charter.md, CURSOR.meta.md, CODEBASE_GUIDE.md"
247
+ echo " ∟ Uso: /docs/help build-tech-docs (detalhes)"
248
+ echo ""
249
+ echo "**📊 Contexto de Negócio:**"
250
+ echo " ▶ **/docs/build-business-docs** - Inteligência de mercado"
251
+ echo " ∟ Para: Produto, vendas, suporte contextual ao cliente"
252
+ echo " ∟ Output: CUSTOMER_PERSONAS.md, COMPETITIVE_LANDSCAPE.md"
253
+ echo " ∟ Uso: /docs/help build-business-docs (detalhes)"
254
+ echo ""
255
+ echo "**🗂️ Organização:**"
256
+ echo " ▶ **/docs/build-index** - Índices de documentação"
257
+ echo " ∟ Para: Múltiplos projetos, navegação centralizada"
258
+ echo " ∟ Output: index.md estruturados e organizados"
259
+ echo " ∟ Uso: /docs/help build-index (detalhes)"
260
+ echo ""
261
+ echo "**🚧 Em Desenvolvimento:**"
262
+ echo " ▶ **/docs/refine-vision** - Refinamento estratégico"
263
+ echo " ∟ Status: Implementação futura (próximo release)"
264
+ echo " ∟ Uso: /docs/help refine-vision (roadmap)"
265
+ echo ""
266
+ echo "**🚀 Para Help Específico:**"
267
+ echo " ▶ /docs/help [comando] # Detalhes profundos"
268
+ echo " ▶ /docs/help build-tech-docs"
269
+ echo " ▶ /docs/help build-business-docs"
270
+ echo " ▶ /docs/help build-index"
271
+ echo ""
272
+ fi
273
+
274
+ echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
275
+ echo ""
276
+ echo "📚 **Sistema Onion** - Comandos inteligentes para desenvolvimento ágil"
277
+ echo "🆘 **Precisa de mais ajuda?** Use /docs/help [comando] para detalhes específicos"
278
+ echo ""
@@ -0,0 +1,25 @@
1
+ ---
2
+ name: refine-vision
3
+ description: Refinar visão e estratégia do produto/projeto.
4
+ model: sonnet
5
+ category: docs
6
+ tags: [vision, strategy, refinement]
7
+ version: "3.0.0"
8
+ updated: "2025-11-24"
9
+ ---
10
+
11
+ # Refinar Visão do Projeto
12
+
13
+ Ajudar a refinar e documentar a visão estratégica do projeto.
14
+
15
+ ## 🎯 Objetivo
16
+
17
+ Clarificar e documentar a visão, missão e objetivos estratégicos.
18
+
19
+ ## ⚡ Processo
20
+
21
+ 1. Revisar documentação existente de visão
22
+ 2. Fazer perguntas de esclarecimento
23
+ 3. Documentar insights e decisões
24
+ 4. Gerar documento de visão atualizado
25
+