create-hq 5.0.0
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/deps.d.ts +4 -0
- package/dist/deps.d.ts.map +1 -0
- package/dist/deps.js +65 -0
- package/dist/deps.js.map +1 -0
- package/dist/git.d.ts +3 -0
- package/dist/git.d.ts.map +1 -0
- package/dist/git.js +19 -0
- package/dist/git.js.map +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +23 -0
- package/dist/index.js.map +1 -0
- package/dist/scaffold.d.ts +8 -0
- package/dist/scaffold.d.ts.map +1 -0
- package/dist/scaffold.js +130 -0
- package/dist/scaffold.js.map +1 -0
- package/dist/ui.d.ts +7 -0
- package/dist/ui.d.ts.map +1 -0
- package/dist/ui.js +36 -0
- package/dist/ui.js.map +1 -0
- package/package.json +41 -0
- package/template/.claude/CLAUDE.md +202 -0
- package/template/.claude/commands/checkpoint.md +127 -0
- package/template/.claude/commands/cleanup.md +307 -0
- package/template/.claude/commands/execute-task.md +440 -0
- package/template/.claude/commands/exit-plan.md +41 -0
- package/template/.claude/commands/handoff.md +97 -0
- package/template/.claude/commands/learn.md +218 -0
- package/template/.claude/commands/metrics.md +118 -0
- package/template/.claude/commands/newworker.md +162 -0
- package/template/.claude/commands/nexttask.md +67 -0
- package/template/.claude/commands/prd.md +238 -0
- package/template/.claude/commands/reanchor.md +51 -0
- package/template/.claude/commands/remember.md +126 -0
- package/template/.claude/commands/run-project.md +348 -0
- package/template/.claude/commands/run.md +110 -0
- package/template/.claude/commands/search-reindex.md +62 -0
- package/template/.claude/commands/search.md +100 -0
- package/template/.claude/commands/setup.md +381 -0
- package/template/.claude/scripts/pure-ralph-loop.ps1 +312 -0
- package/template/.claude/scripts/pure-ralph-loop.sh +859 -0
- package/template/CHANGELOG.md +220 -0
- package/template/LICENSE +21 -0
- package/template/MIGRATION.md +259 -0
- package/template/README.md +368 -0
- package/template/data/journal/.gitkeep +0 -0
- package/template/docs/images/ascii-banner-options.md +122 -0
- package/template/docs/images/hq-banner.svg +105 -0
- package/template/knowledge/Ralph/01-overview.md +71 -0
- package/template/knowledge/Ralph/02-core-concepts.md +114 -0
- package/template/knowledge/Ralph/03-how-ralph-works.md +184 -0
- package/template/knowledge/Ralph/04-back-pressure.md +222 -0
- package/template/knowledge/Ralph/05-specifications.md +210 -0
- package/template/knowledge/Ralph/06-agents-md.md +222 -0
- package/template/knowledge/Ralph/07-implementation.md +316 -0
- package/template/knowledge/Ralph/08-economics.md +182 -0
- package/template/knowledge/Ralph/09-resources.md +145 -0
- package/template/knowledge/Ralph/10-claude-code-workflow.md +212 -0
- package/template/knowledge/Ralph/11-team-training-guide.md +383 -0
- package/template/knowledge/Ralph/README.md +40 -0
- package/template/knowledge/ai-security-framework/CONTRIBUTING.md +139 -0
- package/template/knowledge/ai-security-framework/GLOSSARY.md +176 -0
- package/template/knowledge/ai-security-framework/LICENSE +21 -0
- package/template/knowledge/ai-security-framework/QUICK-START.md +172 -0
- package/template/knowledge/ai-security-framework/README.md +232 -0
- package/template/knowledge/ai-security-framework/checklists/browser-security.md +301 -0
- package/template/knowledge/ai-security-framework/checklists/credential-isolation.md +322 -0
- package/template/knowledge/ai-security-framework/checklists/incident-response.md +288 -0
- package/template/knowledge/ai-security-framework/checklists/pre-flight.md +249 -0
- package/template/knowledge/ai-security-framework/checklists/weekly-audit.md +159 -0
- package/template/knowledge/ai-security-framework/configs/audit-logging.md +372 -0
- package/template/knowledge/ai-security-framework/configs/kill-switches.md +354 -0
- package/template/knowledge/ai-security-framework/docs/01-core-principles.md +256 -0
- package/template/knowledge/ai-security-framework/docs/02-threat-landscape.md +326 -0
- package/template/knowledge/ai-security-framework/docs/03-security-posture.md +250 -0
- package/template/knowledge/ai-security-framework/templates/agents-security.md +233 -0
- package/template/knowledge/design-styles/README.md +42 -0
- package/template/knowledge/design-styles/american-industrial.md +136 -0
- package/template/knowledge/design-styles/ethereal-abstract.md +133 -0
- package/template/knowledge/design-styles/liminal-portal.md +111 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G-3m4YPW0AADdu2.jpeg +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G-JJlt5WwAABK3K.png +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G-JJmj5W0AEbJ-7.png +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G59fgNuXkAAKLJQ (1).jpeg +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G59fgNuXkAAKLJQ.jpeg +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G7fVkn3WEAAM-ST.jpeg +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G8ECO5JWEAIksyn.png +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G9-3GQSWoAA8eqZ.png +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G9xEOqrXkAEZRcs.png +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G_MVeJrXQAA8sx4.jpeg +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/G_RSkmGXkAAgAVZ.png +0 -0
- package/template/knowledge/design-styles/swipes/american-industrial/README.md +31 -0
- package/template/knowledge/design-styles/swipes/american-industrial/qyqtg7Dq.png +0 -0
- package/template/knowledge/dev-team/README.md +35 -0
- package/template/knowledge/dev-team/patterns/README.md +34 -0
- package/template/knowledge/dev-team/patterns/frontend/react-best-practices.md +178 -0
- package/template/knowledge/dev-team/troubleshooting/README.md +31 -0
- package/template/knowledge/dev-team/workflows/README.md +49 -0
- package/template/knowledge/hq/checkpoint-schema.json +51 -0
- package/template/knowledge/hq/index-md-spec.md +74 -0
- package/template/knowledge/hq/thread-schema.md +153 -0
- package/template/knowledge/hq-core/checkpoint-schema.json +51 -0
- package/template/knowledge/hq-core/index-md-spec.md +74 -0
- package/template/knowledge/hq-core/thread-schema.md +153 -0
- package/template/knowledge/loom/README.md +51 -0
- package/template/knowledge/loom/architecture.md +125 -0
- package/template/knowledge/loom/code-style.md +169 -0
- package/template/knowledge/loom/llm-proxy.md +132 -0
- package/template/knowledge/loom/state-machine.md +131 -0
- package/template/knowledge/loom/thread-system.md +117 -0
- package/template/knowledge/loom/tools.md +94 -0
- package/template/knowledge/loom/weaver.md +96 -0
- package/template/knowledge/loom/web-frontend.md +131 -0
- package/template/knowledge/projects/README.md +72 -0
- package/template/knowledge/projects/templates/README.template.md +28 -0
- package/template/knowledge/workers/README.md +195 -0
- package/template/knowledge/workers/ralph-loop-pattern.md +157 -0
- package/template/knowledge/workers/skill-schema.md +182 -0
- package/template/knowledge/workers/state-machine.md +102 -0
- package/template/knowledge/workers/templates/base-worker.yaml +73 -0
- package/template/knowledge/workers/templates/code-worker.yaml +85 -0
- package/template/knowledge/workers/templates/skill.yaml +49 -0
- package/template/knowledge/workers/templates/social-worker.yaml +70 -0
- package/template/modules/examples/full-manifest.yaml +92 -0
- package/template/modules/examples/minimal.yaml +14 -0
- package/template/modules/modules.yaml +59 -0
- package/template/projects/.gitkeep +0 -0
- package/template/projects/incorporate-workers-into-pure-ralph/prd.json +88 -0
- package/template/projects/pure-ralph-branch-isolation/README.md +114 -0
- package/template/projects/pure-ralph-branch-isolation/prd.json +123 -0
- package/template/projects/purist-ralph-loop/README.md +148 -0
- package/template/projects/purist-ralph-loop/prd.json +135 -0
- package/template/projects/ralph-test/prd.json +50 -0
- package/template/prompts/pure-ralph-base.md +551 -0
- package/template/settings/.gitkeep +0 -0
- package/template/settings/pure-ralph.json +42 -0
- package/template/social-content/drafts/INDEX.md +21 -0
- package/template/social-content/drafts/linkedin/.gitkeep +1 -0
- package/template/social-content/drafts/x/.gitkeep +1 -0
- package/template/social-content/images/.gitkeep +1 -0
- package/template/starter-projects/code-worker/README.md +97 -0
- package/template/starter-projects/code-worker/prd.json +45 -0
- package/template/starter-projects/personal-assistant/README.md +42 -0
- package/template/starter-projects/personal-assistant/prd.json +43 -0
- package/template/starter-projects/social-media/README.md +60 -0
- package/template/starter-projects/social-media/prd.json +43 -0
- package/template/workers/content-brand/README.md +59 -0
- package/template/workers/content-brand/skills/messaging-alignment.md +91 -0
- package/template/workers/content-brand/skills/tone-check.md +76 -0
- package/template/workers/content-brand/skills/voice-analysis.md +68 -0
- package/template/workers/content-brand/worker.yaml +81 -0
- package/template/workers/content-legal/README.md +80 -0
- package/template/workers/content-legal/skills/claim-substantiation.md +150 -0
- package/template/workers/content-legal/skills/compliance-scan.md +123 -0
- package/template/workers/content-legal/skills/disclaimer-check.md +146 -0
- package/template/workers/content-legal/worker.yaml +118 -0
- package/template/workers/content-product/README.md +77 -0
- package/template/workers/content-product/skills/claim-verification.md +96 -0
- package/template/workers/content-product/skills/feature-accuracy.md +117 -0
- package/template/workers/content-product/skills/stats-check.md +128 -0
- package/template/workers/content-product/worker.yaml +97 -0
- package/template/workers/content-sales/README.md +70 -0
- package/template/workers/content-sales/skills/conversion-analysis.md +96 -0
- package/template/workers/content-sales/skills/cta-audit.md +107 -0
- package/template/workers/content-sales/skills/value-prop-check.md +114 -0
- package/template/workers/content-sales/worker.yaml +93 -0
- package/template/workers/content-shared/cli.ts +242 -0
- package/template/workers/content-shared/index.ts +234 -0
- package/template/workers/content-shared/lib/accuracy-analyzer.ts +661 -0
- package/template/workers/content-shared/lib/analyze.ts +370 -0
- package/template/workers/content-shared/lib/brand-analyzer.ts +526 -0
- package/template/workers/content-shared/lib/cms-integration.ts +446 -0
- package/template/workers/content-shared/lib/compliance-analyzer.ts +655 -0
- package/template/workers/content-shared/lib/conversion-analyzer.ts +555 -0
- package/template/workers/content-shared/lib/github-integration.ts +582 -0
- package/template/workers/content-shared/lib/output.ts +373 -0
- package/template/workers/content-shared/lib/parser.ts +771 -0
- package/template/workers/content-shared/lib/priority.ts +439 -0
- package/template/workers/content-shared/lib/recommendations.ts +512 -0
- package/template/workers/content-shared/lib/reporter.ts +749 -0
- package/template/workers/content-shared/lib/restructure.ts +664 -0
- package/template/workers/content-shared/lib/scorer.ts +140 -0
- package/template/workers/content-shared/lib/types.ts +227 -0
- package/template/workers/content-shared/lib/variants.ts +595 -0
- package/template/workers/content-shared/package.json +51 -0
- package/template/workers/content-shared/pnpm-lock.yaml +39 -0
- package/template/workers/content-shared/test/sample-page.json +115 -0
- package/template/workers/content-shared/tsconfig.json +20 -0
- package/template/workers/dev-team/README.md +166 -0
- package/template/workers/dev-team/_template.yaml +70 -0
- package/template/workers/dev-team/architect/package.json +27 -0
- package/template/workers/dev-team/architect/skills/api-design.md +89 -0
- package/template/workers/dev-team/architect/skills/refactor-plan.md +96 -0
- package/template/workers/dev-team/architect/skills/system-design.md +100 -0
- package/template/workers/dev-team/architect/src/index.ts +49 -0
- package/template/workers/dev-team/architect/src/mcp-server.ts +122 -0
- package/template/workers/dev-team/architect/src/skills/api-design.ts +316 -0
- package/template/workers/dev-team/architect/src/skills/refactor-plan.ts +264 -0
- package/template/workers/dev-team/architect/src/skills/system-design.ts +212 -0
- package/template/workers/dev-team/architect/tsconfig.json +19 -0
- package/template/workers/dev-team/architect/worker.yaml +128 -0
- package/template/workers/dev-team/backend-dev/package-lock.json +1252 -0
- package/template/workers/dev-team/backend-dev/package.json +27 -0
- package/template/workers/dev-team/backend-dev/skills/implement-endpoint.md +70 -0
- package/template/workers/dev-team/backend-dev/skills/implement-service.md +62 -0
- package/template/workers/dev-team/backend-dev/src/index.ts +51 -0
- package/template/workers/dev-team/backend-dev/src/mcp-server.ts +109 -0
- package/template/workers/dev-team/backend-dev/src/skills/implement-endpoint.ts +122 -0
- package/template/workers/dev-team/backend-dev/src/skills/implement-service.ts +126 -0
- package/template/workers/dev-team/backend-dev/tsconfig.json +19 -0
- package/template/workers/dev-team/backend-dev/worker.yaml +128 -0
- package/template/workers/dev-team/code-reviewer/package-lock.json +1080 -0
- package/template/workers/dev-team/code-reviewer/package.json +24 -0
- package/template/workers/dev-team/code-reviewer/skills/merge-to-production.md +61 -0
- package/template/workers/dev-team/code-reviewer/skills/merge-to-staging.md +54 -0
- package/template/workers/dev-team/code-reviewer/skills/request-changes.md +63 -0
- package/template/workers/dev-team/code-reviewer/skills/review-pr.md +77 -0
- package/template/workers/dev-team/code-reviewer/src/index.ts +56 -0
- package/template/workers/dev-team/code-reviewer/src/mcp-server.ts +101 -0
- package/template/workers/dev-team/code-reviewer/tsconfig.json +19 -0
- package/template/workers/dev-team/code-reviewer/worker.yaml +90 -0
- package/template/workers/dev-team/database-dev/package.json +22 -0
- package/template/workers/dev-team/database-dev/skills/create-schema.md +48 -0
- package/template/workers/dev-team/database-dev/src/index.ts +50 -0
- package/template/workers/dev-team/database-dev/src/mcp-server.ts +76 -0
- package/template/workers/dev-team/database-dev/tsconfig.json +18 -0
- package/template/workers/dev-team/database-dev/worker.yaml +90 -0
- package/template/workers/dev-team/frontend-dev/package.json +22 -0
- package/template/workers/dev-team/frontend-dev/skills/create-component.md +26 -0
- package/template/workers/dev-team/frontend-dev/src/index.ts +50 -0
- package/template/workers/dev-team/frontend-dev/src/mcp-server.ts +77 -0
- package/template/workers/dev-team/frontend-dev/tsconfig.json +18 -0
- package/template/workers/dev-team/frontend-dev/worker.yaml +132 -0
- package/template/workers/dev-team/infra-dev/package.json +24 -0
- package/template/workers/dev-team/infra-dev/skills/add-monitoring.md +73 -0
- package/template/workers/dev-team/infra-dev/skills/configure-deployment.md +80 -0
- package/template/workers/dev-team/infra-dev/skills/create-dockerfile.md +62 -0
- package/template/workers/dev-team/infra-dev/skills/setup-cicd.md +63 -0
- package/template/workers/dev-team/infra-dev/src/index.ts +55 -0
- package/template/workers/dev-team/infra-dev/src/mcp-server.ts +82 -0
- package/template/workers/dev-team/infra-dev/tsconfig.json +19 -0
- package/template/workers/dev-team/infra-dev/worker.yaml +92 -0
- package/template/workers/dev-team/knowledge-curator/package.json +24 -0
- package/template/workers/dev-team/knowledge-curator/skills/curate-troubleshooting.md +63 -0
- package/template/workers/dev-team/knowledge-curator/skills/process-learnings.md +61 -0
- package/template/workers/dev-team/knowledge-curator/skills/sync-documentation.md +76 -0
- package/template/workers/dev-team/knowledge-curator/skills/update-patterns.md +63 -0
- package/template/workers/dev-team/knowledge-curator/src/index.ts +53 -0
- package/template/workers/dev-team/knowledge-curator/src/mcp-server.ts +92 -0
- package/template/workers/dev-team/knowledge-curator/tsconfig.json +19 -0
- package/template/workers/dev-team/knowledge-curator/worker.yaml +80 -0
- package/template/workers/dev-team/motion-designer/package.json +22 -0
- package/template/workers/dev-team/motion-designer/skills/add-animation.md +25 -0
- package/template/workers/dev-team/motion-designer/skills/generate-image.md +36 -0
- package/template/workers/dev-team/motion-designer/src/index.ts +63 -0
- package/template/workers/dev-team/motion-designer/src/mcp-server.ts +79 -0
- package/template/workers/dev-team/motion-designer/tsconfig.json +18 -0
- package/template/workers/dev-team/motion-designer/worker.yaml +84 -0
- package/template/workers/dev-team/product-planner/queue.json +4 -0
- package/template/workers/dev-team/product-planner/worker.yaml +220 -0
- package/template/workers/dev-team/project-manager/package-lock.json +1252 -0
- package/template/workers/dev-team/project-manager/package.json +27 -0
- package/template/workers/dev-team/project-manager/skills/create-prd.md +66 -0
- package/template/workers/dev-team/project-manager/skills/next-issue.md +51 -0
- package/template/workers/dev-team/project-manager/skills/project-status.md +59 -0
- package/template/workers/dev-team/project-manager/skills/update-learnings.md +65 -0
- package/template/workers/dev-team/project-manager/src/index.ts +54 -0
- package/template/workers/dev-team/project-manager/src/mcp-server.ts +207 -0
- package/template/workers/dev-team/project-manager/src/skills/create-prd.ts +86 -0
- package/template/workers/dev-team/project-manager/src/skills/next-issue.ts +137 -0
- package/template/workers/dev-team/project-manager/src/skills/project-status.ts +131 -0
- package/template/workers/dev-team/project-manager/src/skills/update-learnings.ts +94 -0
- package/template/workers/dev-team/project-manager/tsconfig.json +19 -0
- package/template/workers/dev-team/project-manager/worker.yaml +96 -0
- package/template/workers/dev-team/qa-tester/package.json +24 -0
- package/template/workers/dev-team/qa-tester/skills/create-demo-account.md +36 -0
- package/template/workers/dev-team/qa-tester/skills/run-tests.md +36 -0
- package/template/workers/dev-team/qa-tester/skills/write-test.md +27 -0
- package/template/workers/dev-team/qa-tester/src/index.ts +61 -0
- package/template/workers/dev-team/qa-tester/src/mcp-server.ts +88 -0
- package/template/workers/dev-team/qa-tester/tsconfig.json +18 -0
- package/template/workers/dev-team/qa-tester/worker.yaml +116 -0
- package/template/workers/dev-team/task-executor/package-lock.json +1252 -0
- package/template/workers/dev-team/task-executor/package.json +27 -0
- package/template/workers/dev-team/task-executor/skills/analyze-issue.md +101 -0
- package/template/workers/dev-team/task-executor/skills/execute.md +133 -0
- package/template/workers/dev-team/task-executor/skills/report-learnings.md +106 -0
- package/template/workers/dev-team/task-executor/skills/validate-completion.md +121 -0
- package/template/workers/dev-team/task-executor/src/index.ts +54 -0
- package/template/workers/dev-team/task-executor/src/mcp-server.ts +139 -0
- package/template/workers/dev-team/task-executor/src/skills/analyze-issue.ts +219 -0
- package/template/workers/dev-team/task-executor/src/skills/execute.ts +132 -0
- package/template/workers/dev-team/task-executor/src/skills/report-learnings.ts +119 -0
- package/template/workers/dev-team/task-executor/src/skills/validate-completion.ts +142 -0
- package/template/workers/dev-team/task-executor/tsconfig.json +19 -0
- package/template/workers/dev-team/task-executor/worker.yaml +110 -0
- package/template/workers/registry.yaml +171 -0
- package/template/workers/security-scanner/README.md +73 -0
- package/template/workers/security-scanner/skills/pre-deploy-check.md +205 -0
- package/template/workers/security-scanner/worker.yaml +26 -0
- package/template/workspace/checkpoints/.gitkeep +0 -0
- package/template/workspace/content-ideas/inbox.jsonl +0 -0
- package/template/workspace/drafts/.gitkeep +0 -0
- package/template/workspace/learnings/.gitkeep +3 -0
- package/template/workspace/orchestrator/.gitkeep +0 -0
- package/template/workspace/ralph-test/COMPLETE.md +18 -0
- package/template/workspace/ralph-test/hello.txt +2 -0
- package/template/workspace/reports/.gitkeep +0 -0
- package/template/workspace/scratch/.gitkeep +0 -0
- package/template/workspace/threads/.gitkeep +3 -0
|
@@ -0,0 +1,220 @@
|
|
|
1
|
+
worker:
|
|
2
|
+
id: product-planner
|
|
3
|
+
name: "Product Planner"
|
|
4
|
+
type: CodeWorker
|
|
5
|
+
version: "1.0"
|
|
6
|
+
created: "2026-01-24"
|
|
7
|
+
|
|
8
|
+
identity:
|
|
9
|
+
voice_guide: agents.md
|
|
10
|
+
purpose: |
|
|
11
|
+
PRD creation, project planning, requirements analysis, and technical
|
|
12
|
+
specification writing. Translates business needs into actionable
|
|
13
|
+
technical documents.
|
|
14
|
+
|
|
15
|
+
execution:
|
|
16
|
+
mode: on-demand
|
|
17
|
+
max_runtime: 20m
|
|
18
|
+
retry_attempts: 2
|
|
19
|
+
|
|
20
|
+
context:
|
|
21
|
+
base:
|
|
22
|
+
- agents.md
|
|
23
|
+
- companies/*/settings/*.md
|
|
24
|
+
- knowledge/*/architecture.md
|
|
25
|
+
dynamic:
|
|
26
|
+
- projects/*/brief.md
|
|
27
|
+
- projects/*/user-feedback.md
|
|
28
|
+
- workspace/scratch/planning-notes.md
|
|
29
|
+
exclude:
|
|
30
|
+
- "**/*.test.*"
|
|
31
|
+
- "**/*.spec.*"
|
|
32
|
+
- "**/node_modules/**"
|
|
33
|
+
- "**/.git/**"
|
|
34
|
+
- "**/dist/**"
|
|
35
|
+
- "**/build/**"
|
|
36
|
+
|
|
37
|
+
skills:
|
|
38
|
+
installed:
|
|
39
|
+
- api-design-principles
|
|
40
|
+
- typescript-advanced-types
|
|
41
|
+
|
|
42
|
+
capabilities:
|
|
43
|
+
- Product requirements documentation
|
|
44
|
+
- Technical specification writing
|
|
45
|
+
- User story creation with acceptance criteria
|
|
46
|
+
- API design and documentation
|
|
47
|
+
- System architecture planning
|
|
48
|
+
- Data model design
|
|
49
|
+
- Risk assessment and mitigation planning
|
|
50
|
+
|
|
51
|
+
verification:
|
|
52
|
+
pre_execute:
|
|
53
|
+
- Ensure project brief exists or user has provided context
|
|
54
|
+
- Confirm target company/project scope
|
|
55
|
+
|
|
56
|
+
post_execute:
|
|
57
|
+
- PRD includes problem statement
|
|
58
|
+
- PRD includes success metrics
|
|
59
|
+
- Technical specs are implementation-ready
|
|
60
|
+
- API contracts are well-defined
|
|
61
|
+
- Data models are normalized
|
|
62
|
+
- Dependencies are identified
|
|
63
|
+
|
|
64
|
+
approval_required: true
|
|
65
|
+
|
|
66
|
+
tasks:
|
|
67
|
+
source: workers/public/dev-team/product-planner/queue.json
|
|
68
|
+
one_at_a_time: true
|
|
69
|
+
|
|
70
|
+
# State Machine (Loom pattern)
|
|
71
|
+
state_machine:
|
|
72
|
+
enabled: true
|
|
73
|
+
max_retries: 1
|
|
74
|
+
hooks:
|
|
75
|
+
post_execute:
|
|
76
|
+
- auto_checkpoint
|
|
77
|
+
- log_metrics
|
|
78
|
+
on_error:
|
|
79
|
+
- log_error
|
|
80
|
+
- checkpoint_error_state
|
|
81
|
+
|
|
82
|
+
output:
|
|
83
|
+
destination: projects/{project-name}/
|
|
84
|
+
format: markdown
|
|
85
|
+
files:
|
|
86
|
+
- prd.md
|
|
87
|
+
- technical-spec.md
|
|
88
|
+
- api-contracts.md
|
|
89
|
+
- data-model.md
|
|
90
|
+
|
|
91
|
+
instructions: |
|
|
92
|
+
You are the Product Planner worker. Your role is to transform business
|
|
93
|
+
ideas and requirements into comprehensive, actionable technical documentation.
|
|
94
|
+
|
|
95
|
+
## Your Process
|
|
96
|
+
|
|
97
|
+
1. **Understand the Problem**
|
|
98
|
+
- Read any project briefs or user feedback
|
|
99
|
+
- Identify the core problem being solved
|
|
100
|
+
- Clarify ambiguities with questions
|
|
101
|
+
|
|
102
|
+
2. **Define Success**
|
|
103
|
+
- Set measurable success metrics
|
|
104
|
+
- Define acceptance criteria
|
|
105
|
+
- Identify key user outcomes
|
|
106
|
+
|
|
107
|
+
3. **Design the Solution**
|
|
108
|
+
- Break down into components
|
|
109
|
+
- Design API contracts (use api-design-principles skill)
|
|
110
|
+
- Model data structures (normalize, identify relationships)
|
|
111
|
+
- Consider edge cases and error handling
|
|
112
|
+
|
|
113
|
+
4. **Plan Implementation**
|
|
114
|
+
- Identify technical dependencies
|
|
115
|
+
- Suggest implementation phases
|
|
116
|
+
- Call out risk areas
|
|
117
|
+
- Estimate complexity (avoid time estimates)
|
|
118
|
+
|
|
119
|
+
5. **Document Everything**
|
|
120
|
+
- Write clear, concise PRDs
|
|
121
|
+
- Create implementation-ready technical specs
|
|
122
|
+
- Document API contracts with examples
|
|
123
|
+
- Provide data model diagrams (ERD as markdown)
|
|
124
|
+
|
|
125
|
+
## Output Format
|
|
126
|
+
|
|
127
|
+
### prd.md Structure
|
|
128
|
+
```markdown
|
|
129
|
+
# [Project Name] - Product Requirements Document
|
|
130
|
+
|
|
131
|
+
## Problem Statement
|
|
132
|
+
[Clear description of the problem]
|
|
133
|
+
|
|
134
|
+
## Goals
|
|
135
|
+
- [Measurable goal 1]
|
|
136
|
+
- [Measurable goal 2]
|
|
137
|
+
|
|
138
|
+
## Success Metrics
|
|
139
|
+
- [Metric 1]: [Target]
|
|
140
|
+
- [Metric 2]: [Target]
|
|
141
|
+
|
|
142
|
+
## User Stories
|
|
143
|
+
### Story 1: [Title]
|
|
144
|
+
**As a** [user type]
|
|
145
|
+
**I want** [goal]
|
|
146
|
+
**So that** [benefit]
|
|
147
|
+
|
|
148
|
+
**Acceptance Criteria:**
|
|
149
|
+
- [ ] [Criterion 1]
|
|
150
|
+
- [ ] [Criterion 2]
|
|
151
|
+
|
|
152
|
+
## Non-Goals
|
|
153
|
+
- [What's explicitly out of scope]
|
|
154
|
+
|
|
155
|
+
## Open Questions
|
|
156
|
+
- [ ] [Question 1]
|
|
157
|
+
- [ ] [Question 2]
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### technical-spec.md Structure
|
|
161
|
+
```markdown
|
|
162
|
+
# [Project Name] - Technical Specification
|
|
163
|
+
|
|
164
|
+
## Architecture Overview
|
|
165
|
+
[High-level architecture diagram as markdown]
|
|
166
|
+
|
|
167
|
+
## Components
|
|
168
|
+
### Component 1: [Name]
|
|
169
|
+
**Purpose:** [Description]
|
|
170
|
+
**Dependencies:** [List]
|
|
171
|
+
**Interface:** [Public API]
|
|
172
|
+
|
|
173
|
+
## Technology Stack
|
|
174
|
+
- Frontend: [Framework, libraries]
|
|
175
|
+
- Backend: [Runtime, framework]
|
|
176
|
+
- Database: [Type, specific DB]
|
|
177
|
+
- Infrastructure: [Hosting, CI/CD]
|
|
178
|
+
|
|
179
|
+
## Data Flow
|
|
180
|
+
[Sequence of operations]
|
|
181
|
+
|
|
182
|
+
## Security Considerations
|
|
183
|
+
- [Consideration 1]
|
|
184
|
+
- [Consideration 2]
|
|
185
|
+
|
|
186
|
+
## Performance Considerations
|
|
187
|
+
- [Consideration 1]
|
|
188
|
+
- [Consideration 2]
|
|
189
|
+
|
|
190
|
+
## Implementation Phases
|
|
191
|
+
### Phase 1: [Name]
|
|
192
|
+
- [Task 1]
|
|
193
|
+
- [Task 2]
|
|
194
|
+
|
|
195
|
+
## Risk Assessment
|
|
196
|
+
| Risk | Impact | Mitigation |
|
|
197
|
+
|------|--------|------------|
|
|
198
|
+
| [Risk] | [H/M/L] | [Strategy] |
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
### api-contracts.md Structure
|
|
202
|
+
Use the api-design-principles skill to ensure contracts follow best practices.
|
|
203
|
+
Include request/response examples, error codes, rate limits.
|
|
204
|
+
|
|
205
|
+
### data-model.md Structure
|
|
206
|
+
Show entities, relationships, indexes, and migration considerations.
|
|
207
|
+
|
|
208
|
+
## Important Notes
|
|
209
|
+
- Always re-anchor on the problem being solved
|
|
210
|
+
- Ask clarifying questions before making assumptions
|
|
211
|
+
- Consider maintainability and scalability
|
|
212
|
+
- Document the "why" behind decisions
|
|
213
|
+
- Keep specs implementation-ready (devs should not need to guess)
|
|
214
|
+
|
|
215
|
+
## Before You Finalize
|
|
216
|
+
- [ ] Reviewed with api-design-principles skill
|
|
217
|
+
- [ ] Checked data model normalization
|
|
218
|
+
- [ ] Confirmed all dependencies identified
|
|
219
|
+
- [ ] Verified success metrics are measurable
|
|
220
|
+
- [ ] Asked user for approval on approach
|