@c0x12c/ai-toolkit 1.15.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/.claude-plugin/marketplace.json +16 -0
- package/.claude-plugin/plugin.json +12 -0
- package/README.md +439 -0
- package/VERSION +1 -0
- package/agents/design-critic.md +127 -0
- package/agents/idea-killer.md +72 -0
- package/agents/infrastructure-expert.md +49 -0
- package/agents/micronaut-backend-expert.md +45 -0
- package/agents/phase-reviewer.md +150 -0
- package/agents/research-planner.md +70 -0
- package/agents/solution-architect-cto.md +49 -0
- package/agents/sre-architect.md +49 -0
- package/agents/team-coordinator.md +111 -0
- package/bin/cli.js +780 -0
- package/claude-md/00-header.md +39 -0
- package/claude-md/01-core.md +105 -0
- package/claude-md/05-database.md +20 -0
- package/claude-md/11-backend-micronaut.md +19 -0
- package/claude-md/20-frontend-react.md +44 -0
- package/claude-md/25-ux-design.md +56 -0
- package/claude-md/30-infrastructure.md +24 -0
- package/claude-md/30-project-mgmt.md +119 -0
- package/claude-md/40-product.md +39 -0
- package/claude-md/50-ops.md +34 -0
- package/claude-md/60-research.md +27 -0
- package/claude-md/90-footer.md +21 -0
- package/commands/spartan/brainstorm.md +134 -0
- package/commands/spartan/brownfield.md +157 -0
- package/commands/spartan/build.md +435 -0
- package/commands/spartan/careful.md +94 -0
- package/commands/spartan/commit-message.md +112 -0
- package/commands/spartan/content.md +17 -0
- package/commands/spartan/context-save.md +161 -0
- package/commands/spartan/contribute.md +140 -0
- package/commands/spartan/daily.md +42 -0
- package/commands/spartan/debug.md +308 -0
- package/commands/spartan/deep-dive.md +55 -0
- package/commands/spartan/deploy.md +207 -0
- package/commands/spartan/e2e.md +264 -0
- package/commands/spartan/env-setup.md +166 -0
- package/commands/spartan/epic.md +199 -0
- package/commands/spartan/fe-review.md +181 -0
- package/commands/spartan/figma-to-code.md +260 -0
- package/commands/spartan/forensics.md +46 -0
- package/commands/spartan/freeze.md +84 -0
- package/commands/spartan/fundraise.md +53 -0
- package/commands/spartan/gate-review.md +229 -0
- package/commands/spartan/gsd-upgrade.md +376 -0
- package/commands/spartan/guard.md +42 -0
- package/commands/spartan/init-project.md +178 -0
- package/commands/spartan/init-rules.md +298 -0
- package/commands/spartan/interview.md +154 -0
- package/commands/spartan/kickoff.md +73 -0
- package/commands/spartan/kotlin-service.md +109 -0
- package/commands/spartan/lean-canvas.md +222 -0
- package/commands/spartan/lint-rules.md +122 -0
- package/commands/spartan/map-codebase.md +124 -0
- package/commands/spartan/migration.md +82 -0
- package/commands/spartan/next-app.md +317 -0
- package/commands/spartan/next-feature.md +212 -0
- package/commands/spartan/onboard.md +326 -0
- package/commands/spartan/outreach.md +16 -0
- package/commands/spartan/phase.md +142 -0
- package/commands/spartan/pitch.md +18 -0
- package/commands/spartan/plan.md +210 -0
- package/commands/spartan/pr-ready.md +202 -0
- package/commands/spartan/project.md +106 -0
- package/commands/spartan/qa.md +222 -0
- package/commands/spartan/research.md +254 -0
- package/commands/spartan/review.md +132 -0
- package/commands/spartan/scan-rules.md +173 -0
- package/commands/spartan/sessions.md +143 -0
- package/commands/spartan/spec.md +131 -0
- package/commands/spartan/startup.md +257 -0
- package/commands/spartan/team.md +570 -0
- package/commands/spartan/teardown.md +161 -0
- package/commands/spartan/testcontainer.md +97 -0
- package/commands/spartan/tf-cost.md +123 -0
- package/commands/spartan/tf-deploy.md +116 -0
- package/commands/spartan/tf-drift.md +100 -0
- package/commands/spartan/tf-import.md +107 -0
- package/commands/spartan/tf-module.md +121 -0
- package/commands/spartan/tf-plan.md +100 -0
- package/commands/spartan/tf-review.md +106 -0
- package/commands/spartan/tf-scaffold.md +109 -0
- package/commands/spartan/tf-security.md +147 -0
- package/commands/spartan/think.md +221 -0
- package/commands/spartan/unfreeze.md +13 -0
- package/commands/spartan/update.md +134 -0
- package/commands/spartan/ux.md +1233 -0
- package/commands/spartan/validate.md +193 -0
- package/commands/spartan/web-to-prd.md +706 -0
- package/commands/spartan/workstreams.md +109 -0
- package/commands/spartan/write.md +16 -0
- package/commands/spartan.md +386 -0
- package/frameworks/00-framework-comparison-guide.md +317 -0
- package/frameworks/01-lean-canvas.md +196 -0
- package/frameworks/02-design-sprint.md +304 -0
- package/frameworks/03-foundation-sprint.md +337 -0
- package/frameworks/04-business-model-canvas.md +391 -0
- package/frameworks/05-customer-development.md +426 -0
- package/frameworks/06-jobs-to-be-done.md +358 -0
- package/frameworks/07-mom-test.md +392 -0
- package/frameworks/08-value-proposition-canvas.md +488 -0
- package/frameworks/09-javelin-board.md +428 -0
- package/frameworks/10-build-measure-learn.md +467 -0
- package/frameworks/11-mvp-approaches.md +533 -0
- package/frameworks/think-before-build.md +593 -0
- package/lib/assembler.js +197 -0
- package/lib/assembler.test.js +159 -0
- package/lib/detector.js +166 -0
- package/lib/detector.test.js +221 -0
- package/lib/packs.js +16 -0
- package/lib/resolver.js +272 -0
- package/lib/resolver.test.js +298 -0
- package/lib/worktree.sh +104 -0
- package/package.json +50 -0
- package/packs/backend-micronaut.yaml +35 -0
- package/packs/backend-nodejs.yaml +15 -0
- package/packs/backend-python.yaml +15 -0
- package/packs/core.yaml +37 -0
- package/packs/database.yaml +21 -0
- package/packs/frontend-react.yaml +24 -0
- package/packs/infrastructure.yaml +40 -0
- package/packs/ops.yaml +16 -0
- package/packs/packs.compiled.json +371 -0
- package/packs/product.yaml +22 -0
- package/packs/project-mgmt.yaml +24 -0
- package/packs/research.yaml +39 -0
- package/packs/shared-backend.yaml +14 -0
- package/packs/ux-design.yaml +21 -0
- package/rules/backend-micronaut/API_DESIGN.md +313 -0
- package/rules/backend-micronaut/BATCH_PROCESSING.md +92 -0
- package/rules/backend-micronaut/CONTROLLERS.md +388 -0
- package/rules/backend-micronaut/KOTLIN.md +414 -0
- package/rules/backend-micronaut/RETROFIT_PLACEMENT.md +290 -0
- package/rules/backend-micronaut/SERVICES_AND_BEANS.md +325 -0
- package/rules/core/NAMING_CONVENTIONS.md +208 -0
- package/rules/core/SKILL_AUTHORING.md +174 -0
- package/rules/core/TIMEZONE.md +316 -0
- package/rules/database/ORM_AND_REPO.md +289 -0
- package/rules/database/SCHEMA.md +146 -0
- package/rules/database/TRANSACTIONS.md +311 -0
- package/rules/frontend-react/FRONTEND.md +344 -0
- package/rules/infrastructure/MODULES.md +260 -0
- package/rules/infrastructure/NAMING.md +196 -0
- package/rules/infrastructure/PROVIDERS.md +309 -0
- package/rules/infrastructure/SECURITY.md +310 -0
- package/rules/infrastructure/STATE_AND_BACKEND.md +237 -0
- package/rules/infrastructure/STRUCTURE.md +234 -0
- package/rules/infrastructure/VARIABLES.md +285 -0
- package/rules/shared-backend/ARCHITECTURE.md +46 -0
- package/rules/ux-design/DESIGN_PROCESS.md +176 -0
- package/skills/api-endpoint-creator/SKILL.md +455 -0
- package/skills/api-endpoint-creator/error-handling-guide.md +244 -0
- package/skills/api-endpoint-creator/examples.md +522 -0
- package/skills/api-endpoint-creator/testing-patterns.md +302 -0
- package/skills/article-writing/SKILL.md +109 -0
- package/skills/article-writing/examples.md +59 -0
- package/skills/backend-api-design/SKILL.md +84 -0
- package/skills/backend-api-design/code-patterns.md +138 -0
- package/skills/brainstorm/SKILL.md +95 -0
- package/skills/browser-qa/SKILL.md +87 -0
- package/skills/browser-qa/playwright-snippets.md +110 -0
- package/skills/ci-cd-patterns/SKILL.md +108 -0
- package/skills/ci-cd-patterns/workflows.md +149 -0
- package/skills/competitive-teardown/SKILL.md +93 -0
- package/skills/competitive-teardown/example-analysis.md +50 -0
- package/skills/content-engine/SKILL.md +131 -0
- package/skills/content-engine/examples.md +72 -0
- package/skills/database-patterns/SKILL.md +72 -0
- package/skills/database-patterns/code-templates.md +114 -0
- package/skills/database-table-creator/SKILL.md +141 -0
- package/skills/database-table-creator/examples.md +552 -0
- package/skills/database-table-creator/kotlin-templates.md +400 -0
- package/skills/database-table-creator/migration-template.sql +68 -0
- package/skills/database-table-creator/validation-checklist.md +337 -0
- package/skills/deep-research/SKILL.md +80 -0
- package/skills/design-intelligence/SKILL.md +268 -0
- package/skills/design-workflow/SKILL.md +127 -0
- package/skills/design-workflow/checklists.md +45 -0
- package/skills/idea-validation/SKILL.md +129 -0
- package/skills/idea-validation/example-report.md +50 -0
- package/skills/investor-materials/SKILL.md +122 -0
- package/skills/investor-materials/example-outline.md +70 -0
- package/skills/investor-outreach/SKILL.md +112 -0
- package/skills/investor-outreach/examples.md +76 -0
- package/skills/kotlin-best-practices/SKILL.md +58 -0
- package/skills/kotlin-best-practices/code-patterns.md +132 -0
- package/skills/market-research/SKILL.md +99 -0
- package/skills/security-checklist/SKILL.md +65 -0
- package/skills/security-checklist/audit-reference.md +95 -0
- package/skills/service-debugging/SKILL.md +116 -0
- package/skills/service-debugging/common-issues.md +65 -0
- package/skills/startup-pipeline/SKILL.md +152 -0
- package/skills/terraform-best-practices/SKILL.md +244 -0
- package/skills/terraform-module-creator/SKILL.md +284 -0
- package/skills/terraform-review/SKILL.md +222 -0
- package/skills/terraform-security-audit/SKILL.md +280 -0
- package/skills/terraform-service-scaffold/SKILL.md +574 -0
- package/skills/testing-strategies/SKILL.md +116 -0
- package/skills/testing-strategies/examples.md +103 -0
- package/skills/testing-strategies/integration-test-setup.md +71 -0
- package/skills/ui-ux-pro-max/SKILL.md +238 -0
- package/skills/ui-ux-pro-max/data/charts.csv +26 -0
- package/skills/ui-ux-pro-max/data/colors.csv +97 -0
- package/skills/ui-ux-pro-max/data/icons.csv +101 -0
- package/skills/ui-ux-pro-max/data/landing.csv +31 -0
- package/skills/ui-ux-pro-max/data/products.csv +97 -0
- package/skills/ui-ux-pro-max/data/react-performance.csv +45 -0
- package/skills/ui-ux-pro-max/data/stacks/astro.csv +54 -0
- package/skills/ui-ux-pro-max/data/stacks/flutter.csv +53 -0
- package/skills/ui-ux-pro-max/data/stacks/html-tailwind.csv +56 -0
- package/skills/ui-ux-pro-max/data/stacks/jetpack-compose.csv +53 -0
- package/skills/ui-ux-pro-max/data/stacks/nextjs.csv +53 -0
- package/skills/ui-ux-pro-max/data/stacks/nuxt-ui.csv +51 -0
- package/skills/ui-ux-pro-max/data/stacks/nuxtjs.csv +59 -0
- package/skills/ui-ux-pro-max/data/stacks/react-native.csv +52 -0
- package/skills/ui-ux-pro-max/data/stacks/react.csv +54 -0
- package/skills/ui-ux-pro-max/data/stacks/shadcn.csv +61 -0
- package/skills/ui-ux-pro-max/data/stacks/svelte.csv +54 -0
- package/skills/ui-ux-pro-max/data/stacks/swiftui.csv +51 -0
- package/skills/ui-ux-pro-max/data/stacks/vue.csv +50 -0
- package/skills/ui-ux-pro-max/data/styles.csv +68 -0
- package/skills/ui-ux-pro-max/data/typography.csv +58 -0
- package/skills/ui-ux-pro-max/data/ui-reasoning.csv +101 -0
- package/skills/ui-ux-pro-max/data/ux-guidelines.csv +100 -0
- package/skills/ui-ux-pro-max/data/web-interface.csv +31 -0
- package/skills/ui-ux-pro-max/python-setup.md +146 -0
- package/skills/ui-ux-pro-max/scripts/core.py +253 -0
- package/skills/ui-ux-pro-max/scripts/design_system.py +1067 -0
- package/skills/ui-ux-pro-max/scripts/search.py +114 -0
- package/skills/web-to-prd/SKILL.md +478 -0
- package/templates/build-config.yaml +44 -0
- package/templates/commands-config.yaml +55 -0
- package/templates/competitor-analysis.md +60 -0
- package/templates/content/AGENT_TEMPLATE.md +47 -0
- package/templates/content/COMMAND_TEMPLATE.md +27 -0
- package/templates/content/RULE_TEMPLATE.md +40 -0
- package/templates/content/SKILL_TEMPLATE.md +41 -0
- package/templates/design-config.md +105 -0
- package/templates/design-doc.md +207 -0
- package/templates/epic.md +100 -0
- package/templates/feature-spec.md +181 -0
- package/templates/idea-canvas.md +47 -0
- package/templates/implementation-plan.md +159 -0
- package/templates/prd-template.md +86 -0
- package/templates/preamble.md +89 -0
- package/templates/project-readme.md +35 -0
- package/templates/quality-gates.md +230 -0
- package/templates/spartan-config.yaml +164 -0
- package/templates/user-interview.md +69 -0
- package/templates/validation-checklist.md +108 -0
- package/templates/workflow-backend-micronaut.md +409 -0
- package/templates/workflow-frontend-react.md +233 -0
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# Competitor Analysis: [Competitor Name]
|
|
2
|
+
|
|
3
|
+
**URL:**
|
|
4
|
+
**Analyzed:** YYYY-MM-DD
|
|
5
|
+
|
|
6
|
+
## Overview
|
|
7
|
+
What do they do? Who are they for?
|
|
8
|
+
|
|
9
|
+
## Pricing
|
|
10
|
+
| Plan | Price | What You Get |
|
|
11
|
+
|------|-------|--------------|
|
|
12
|
+
| Free | $0 | |
|
|
13
|
+
| Pro | $X/mo | |
|
|
14
|
+
| Enterprise | $X/mo | |
|
|
15
|
+
|
|
16
|
+
## Features
|
|
17
|
+
| Feature | Have it? | Notes |
|
|
18
|
+
|---------|----------|-------|
|
|
19
|
+
| | Yes/No | |
|
|
20
|
+
| | Yes/No | |
|
|
21
|
+
| | Yes/No | |
|
|
22
|
+
|
|
23
|
+
## What They Do Well
|
|
24
|
+
1.
|
|
25
|
+
2.
|
|
26
|
+
3.
|
|
27
|
+
|
|
28
|
+
## What They Do Poorly
|
|
29
|
+
1.
|
|
30
|
+
2.
|
|
31
|
+
3.
|
|
32
|
+
|
|
33
|
+
## User Reviews (G2, Capterra, Reddit, etc.)
|
|
34
|
+
### What users love:
|
|
35
|
+
-
|
|
36
|
+
|
|
37
|
+
### What users hate:
|
|
38
|
+
-
|
|
39
|
+
|
|
40
|
+
## Traffic / Traction
|
|
41
|
+
- Monthly visits (SimilarWeb):
|
|
42
|
+
- Social followers:
|
|
43
|
+
- Reviews count:
|
|
44
|
+
- Founded:
|
|
45
|
+
- Funding:
|
|
46
|
+
|
|
47
|
+
## How They Get Users
|
|
48
|
+
- [ ] SEO
|
|
49
|
+
- [ ] Paid ads
|
|
50
|
+
- [ ] Social media
|
|
51
|
+
- [ ] Referrals
|
|
52
|
+
- [ ] Partnerships
|
|
53
|
+
- [ ] Content marketing
|
|
54
|
+
- [ ] Other: ___
|
|
55
|
+
|
|
56
|
+
## Positioning
|
|
57
|
+
How do they describe themselves? What's their main message?
|
|
58
|
+
|
|
59
|
+
## Our Opportunity
|
|
60
|
+
What gap can we fill? How can we be different/better?
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: agent-name
|
|
3
|
+
description: What this agent does. When to use it.
|
|
4
|
+
tools: ["Read", "Grep", "Glob"]
|
|
5
|
+
model: sonnet
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
You are [identity]. Your job is [mission].
|
|
9
|
+
|
|
10
|
+
## Your Job
|
|
11
|
+
|
|
12
|
+
- Thing 1
|
|
13
|
+
- Thing 2
|
|
14
|
+
- Thing 3
|
|
15
|
+
|
|
16
|
+
## How You Think
|
|
17
|
+
|
|
18
|
+
[1-2 sentences on experience and approach]
|
|
19
|
+
|
|
20
|
+
Patterns you watch for:
|
|
21
|
+
- Pattern 1
|
|
22
|
+
- Pattern 2
|
|
23
|
+
- Pattern 3
|
|
24
|
+
|
|
25
|
+
## Process
|
|
26
|
+
|
|
27
|
+
1. **Step** - What happens
|
|
28
|
+
2. **Step** - What happens
|
|
29
|
+
3. **Step** - What happens
|
|
30
|
+
|
|
31
|
+
## Output Format
|
|
32
|
+
|
|
33
|
+
### Section Name
|
|
34
|
+
- [What goes here]
|
|
35
|
+
|
|
36
|
+
### Section Name
|
|
37
|
+
- [What goes here]
|
|
38
|
+
|
|
39
|
+
### Verdict
|
|
40
|
+
[FORMAT]
|
|
41
|
+
[Explanation format]
|
|
42
|
+
|
|
43
|
+
## Rules
|
|
44
|
+
|
|
45
|
+
- Rule 1
|
|
46
|
+
- Rule 2
|
|
47
|
+
- Rule 3
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: spartan:COMMAND-NAME
|
|
3
|
+
description: What this command does in one line
|
|
4
|
+
argument-hint: "[what the user passes]"
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Command Title: {{ args[0] | default: "fallback" }}
|
|
8
|
+
|
|
9
|
+
One sentence — what this does and when to use it.
|
|
10
|
+
|
|
11
|
+
## Steps
|
|
12
|
+
|
|
13
|
+
### Phase Name
|
|
14
|
+
1. First action
|
|
15
|
+
2. Second action
|
|
16
|
+
3. Third action
|
|
17
|
+
|
|
18
|
+
### Next Phase
|
|
19
|
+
4. Action
|
|
20
|
+
5. Action
|
|
21
|
+
6. Action
|
|
22
|
+
|
|
23
|
+
## Rules
|
|
24
|
+
|
|
25
|
+
- Rule 1
|
|
26
|
+
- Rule 2
|
|
27
|
+
- Rule 3
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Rule Name
|
|
2
|
+
|
|
3
|
+
> Full guide: use `/skill-name` skill
|
|
4
|
+
|
|
5
|
+
## The Rule
|
|
6
|
+
|
|
7
|
+
State the rule clearly in 1-2 sentences.
|
|
8
|
+
|
|
9
|
+
### WRONG
|
|
10
|
+
|
|
11
|
+
```kotlin
|
|
12
|
+
// bad code example
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
### CORRECT
|
|
16
|
+
|
|
17
|
+
```kotlin
|
|
18
|
+
// good code example
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Section 2 (if needed)
|
|
22
|
+
|
|
23
|
+
### WRONG
|
|
24
|
+
|
|
25
|
+
```kotlin
|
|
26
|
+
// bad code
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### CORRECT
|
|
30
|
+
|
|
31
|
+
```kotlin
|
|
32
|
+
// good code
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Quick Reference
|
|
36
|
+
|
|
37
|
+
| Situation | Do This | Not This |
|
|
38
|
+
|-----------|---------|----------|
|
|
39
|
+
| Case 1 | Good | Bad |
|
|
40
|
+
| Case 2 | Good | Bad |
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: skill-name
|
|
3
|
+
description: What this skill does. When to use it.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Skill Name
|
|
7
|
+
|
|
8
|
+
One sentence — what this turns input into.
|
|
9
|
+
|
|
10
|
+
## When to Use
|
|
11
|
+
|
|
12
|
+
- Situation 1
|
|
13
|
+
- Situation 2
|
|
14
|
+
- Situation 3
|
|
15
|
+
|
|
16
|
+
## Process
|
|
17
|
+
|
|
18
|
+
### 1. First Step
|
|
19
|
+
What to do. What to ask.
|
|
20
|
+
|
|
21
|
+
### 2. Second Step
|
|
22
|
+
What to produce.
|
|
23
|
+
|
|
24
|
+
### 3. Third Step
|
|
25
|
+
What to check.
|
|
26
|
+
|
|
27
|
+
## Interaction Style
|
|
28
|
+
|
|
29
|
+
How the skill talks to the user.
|
|
30
|
+
- What it always does
|
|
31
|
+
- What it never does
|
|
32
|
+
|
|
33
|
+
## Rules
|
|
34
|
+
|
|
35
|
+
- Rule 1
|
|
36
|
+
- Rule 2
|
|
37
|
+
- Rule 3
|
|
38
|
+
|
|
39
|
+
## Output
|
|
40
|
+
|
|
41
|
+
Where to save results. What format.
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# Design Config: [Project Name]
|
|
2
|
+
|
|
3
|
+
Per-project design system config. All design work reads this file first.
|
|
4
|
+
|
|
5
|
+
**Location:** Save this to `.planning/design-config.md` in your project root.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Brand Identity
|
|
10
|
+
|
|
11
|
+
- **App name**: [your app or product name]
|
|
12
|
+
- **Type**: [what kind of app — dashboard, SaaS, marketplace, etc.]
|
|
13
|
+
- **Users**: [who uses it — roles, personas]
|
|
14
|
+
- **Identity**: [3-5 words — e.g., "clean, professional, data-focused"]
|
|
15
|
+
- **Theme**: [Light / Dark / Both]
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## Color Palette
|
|
20
|
+
|
|
21
|
+
Use ONLY these colors. Don't invent new ones. Don't use Tailwind defaults.
|
|
22
|
+
|
|
23
|
+
| Role | Token | Value | Usage |
|
|
24
|
+
|------|-------|-------|-------|
|
|
25
|
+
| Background | `--color-bg` | [hex] | Page background |
|
|
26
|
+
| Surface | `--color-surface` | [hex or rgba] | Card backgrounds |
|
|
27
|
+
| Primary | `--color-primary` | [hex] | Buttons, active nav, links |
|
|
28
|
+
| Primary Hover | `--color-primary-hover` | [hex] | Hover states |
|
|
29
|
+
| Accent | `--color-accent` | [hex] | Highlights, badges (use sparingly) |
|
|
30
|
+
| Text | `--color-text` | [hex] | Headlines, body text |
|
|
31
|
+
| Text Secondary | `--color-text-secondary` | [hex] | Subtitles, descriptions |
|
|
32
|
+
| Text Muted | `--color-text-muted` | [hex] | Labels, captions |
|
|
33
|
+
| Border | `--color-border` | [hex or rgba] | Dividers, card edges |
|
|
34
|
+
| Success | `--color-success` | [hex] | Positive states |
|
|
35
|
+
| Warning | `--color-warning` | [hex] | Alert states |
|
|
36
|
+
| Error | `--color-error` | [hex] | Error states |
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## Typography
|
|
41
|
+
|
|
42
|
+
- **Font**: [font name — e.g., "Inter", "Plus Jakarta Sans"]
|
|
43
|
+
- **Headings weight**: [e.g., 600-700]
|
|
44
|
+
- **Body weight**: [e.g., 400-500]
|
|
45
|
+
- **Numbers**: [e.g., "tabular-nums" for data-heavy apps]
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## Spacing & Radius
|
|
50
|
+
|
|
51
|
+
- **Card radius**: [e.g., 12px]
|
|
52
|
+
- **Button radius**: [e.g., 8px]
|
|
53
|
+
- **Badge radius**: [e.g., 9999px (full round)]
|
|
54
|
+
- **Shadows**: [e.g., "subtle slate-tinted: rgba(15, 23, 42, 0.04-0.10)" or "none — use glow effects"]
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Theme Files
|
|
59
|
+
|
|
60
|
+
Where the actual CSS tokens live in the codebase:
|
|
61
|
+
|
|
62
|
+
- **CSS Tokens**: [e.g., `src/styles/tokens.css` or `src/index.css`]
|
|
63
|
+
- **Token prefix**: [e.g., `--color-` or `--color-brand-`]
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
## Design Personality
|
|
68
|
+
|
|
69
|
+
[2-3 sentences. What feeling should the app give? Examples:]
|
|
70
|
+
- "Dark, vibrant, premium. Glassmorphism cards, gradient orbs, glow effects."
|
|
71
|
+
- "Warm, professional, data-focused. Clean tables, colorful stat cards, amber accents."
|
|
72
|
+
- "Minimal, fast, developer-friendly. Monospace accents, high contrast, no decoration."
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
## Reference Apps
|
|
77
|
+
|
|
78
|
+
Apps that have the quality level we want:
|
|
79
|
+
|
|
80
|
+
| Reference | Why |
|
|
81
|
+
|-----------|-----|
|
|
82
|
+
| [app name] | [what to take from it — e.g., "clean data tables, good whitespace"] |
|
|
83
|
+
| [app name] | [e.g., "sidebar nav, dark theme done right"] |
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## Anti-References (What to NEVER Do)
|
|
88
|
+
|
|
89
|
+
Things that would make our app look wrong:
|
|
90
|
+
|
|
91
|
+
- [e.g., "NEVER light theme — this app is dark only"]
|
|
92
|
+
- [e.g., "No playful/gamified aesthetic — we're B2B"]
|
|
93
|
+
- [e.g., "No gradient blobs or decorative noise"]
|
|
94
|
+
- [e.g., "No generic AI aesthetics"]
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## Quick Reference
|
|
99
|
+
|
|
100
|
+
| Question | Answer |
|
|
101
|
+
|----------|--------|
|
|
102
|
+
| What theme? | [Light / Dark / Both] |
|
|
103
|
+
| Primary color? | [hex] |
|
|
104
|
+
| Font? | [name] |
|
|
105
|
+
| Token file? | [path] |
|
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
# Design Document: [Feature Name]
|
|
2
|
+
|
|
3
|
+
> **Workflow position:** Design is optional — use it for features with non-trivial UI work. It sits between Spec and Plan. After this passes the Design Gate, create the **implementation plan** (`implementation-plan.md`).
|
|
4
|
+
>
|
|
5
|
+
> ```
|
|
6
|
+
> Epic → Spec → ► [Design] → Plan → Build → Review
|
|
7
|
+
> ↑
|
|
8
|
+
> Design Gate
|
|
9
|
+
> ```
|
|
10
|
+
|
|
11
|
+
**Date**: [date]
|
|
12
|
+
**Status**: Draft | In Review | Approved
|
|
13
|
+
**Spec**: [path to spec, if exists]
|
|
14
|
+
**Design Config**: [path to design-config.md, if exists]
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## 0. Design References & Direction
|
|
19
|
+
|
|
20
|
+
### Visual References
|
|
21
|
+
|
|
22
|
+
| Reference | What to Take From It |
|
|
23
|
+
|-----------|---------------------|
|
|
24
|
+
| [screenshot/URL 1] | [e.g., "clean data table layout, good whitespace"] |
|
|
25
|
+
| [screenshot/URL 2] | [e.g., "sidebar nav pattern, metric cards"] |
|
|
26
|
+
|
|
27
|
+
### Design System
|
|
28
|
+
- **Theme files**: [path to CSS tokens]
|
|
29
|
+
- **Color palette**: [reference to design-config.md or existing design system]
|
|
30
|
+
- **Font**: [font family from design-config]
|
|
31
|
+
|
|
32
|
+
### Design Personality
|
|
33
|
+
[Copy from design-config.md — or describe in 2-3 sentences]
|
|
34
|
+
|
|
35
|
+
### Anti-References (What to Avoid)
|
|
36
|
+
[Copy from design-config.md Anti-References section]
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## 1. Design Brief
|
|
41
|
+
|
|
42
|
+
### What are we designing?
|
|
43
|
+
[One or two sentences. What screen, page, feature, or flow?]
|
|
44
|
+
|
|
45
|
+
### Who's the user?
|
|
46
|
+
[Target user persona]
|
|
47
|
+
|
|
48
|
+
### Goal
|
|
49
|
+
[What should the user be able to do after this is built?]
|
|
50
|
+
|
|
51
|
+
### Platform
|
|
52
|
+
[Desktop / Mobile / Both]
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## 2. User Flows
|
|
57
|
+
|
|
58
|
+
### Flow 1: [Flow Name]
|
|
59
|
+
|
|
60
|
+
**Trigger**: [What starts this flow?]
|
|
61
|
+
|
|
62
|
+
| Step | User Action | System Response | Screen |
|
|
63
|
+
|------|-------------|-----------------|--------|
|
|
64
|
+
| 1 | [action] | [response] | [screen name] |
|
|
65
|
+
| 2 | [action] | [response] | [screen name] |
|
|
66
|
+
|
|
67
|
+
### Edge Case Flows
|
|
68
|
+
|
|
69
|
+
| Scenario | What Happens | Screen/State |
|
|
70
|
+
|----------|--------------|--------------|
|
|
71
|
+
| No data | [behavior] | Empty state |
|
|
72
|
+
| Error | [behavior] | Error state |
|
|
73
|
+
| Loading | [behavior] | Skeleton state |
|
|
74
|
+
| Timeout | [behavior] | Retry state |
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
## 3. Screen Inventory
|
|
79
|
+
|
|
80
|
+
| Screen | Purpose | States | Mobile Different? |
|
|
81
|
+
|--------|---------|--------|-------------------|
|
|
82
|
+
| [name] | [what it does] | loading, empty, data, error | Yes/No |
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## 4. Component List
|
|
87
|
+
|
|
88
|
+
| Component | Used In | Key Props | States |
|
|
89
|
+
|-----------|---------|-----------|--------|
|
|
90
|
+
| [name] | [screens] | [props] | [default, hover, loading, error, etc.] |
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## 5. Section Zones
|
|
95
|
+
|
|
96
|
+
Plan how sections alternate backgrounds for visual rhythm:
|
|
97
|
+
|
|
98
|
+
| Section | Background | Mood |
|
|
99
|
+
|---------|-----------|------|
|
|
100
|
+
| [section name] | [color/token from design-config] | [e.g., "dramatic entry", "subtle shift"] |
|
|
101
|
+
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
## 6. Motion Plan
|
|
105
|
+
|
|
106
|
+
What moves, how, and when:
|
|
107
|
+
|
|
108
|
+
| Element | Animation | Trigger | Duration |
|
|
109
|
+
|---------|-----------|---------|----------|
|
|
110
|
+
| Section content | Fade up | Scroll into view | 0.6s ease |
|
|
111
|
+
| Cards | Stagger fade | Scroll into view | 0.6s + 0.15s stagger |
|
|
112
|
+
| Cards hover | Lift + shadow | Mouse hover | 0.2s ease |
|
|
113
|
+
|
|
114
|
+
---
|
|
115
|
+
|
|
116
|
+
## 7. Wireframes
|
|
117
|
+
|
|
118
|
+
### [Screen Name]
|
|
119
|
+
|
|
120
|
+
```
|
|
121
|
+
+------------------------------------------+
|
|
122
|
+
| Header / Nav |
|
|
123
|
+
+------------------------------------------+
|
|
124
|
+
| |
|
|
125
|
+
| [Main Content Area] |
|
|
126
|
+
| |
|
|
127
|
+
| +-------------+ +-------------+ |
|
|
128
|
+
| | Card 1 | | Card 2 | |
|
|
129
|
+
| +-------------+ +-------------+ |
|
|
130
|
+
| |
|
|
131
|
+
+------------------------------------------+
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
## 8. Visual Design
|
|
137
|
+
|
|
138
|
+
### Typography Scale
|
|
139
|
+
|
|
140
|
+
| Role | Size | Weight | Letter-spacing |
|
|
141
|
+
|------|------|--------|----------------|
|
|
142
|
+
| H1 | [size] | [weight] | [spacing] |
|
|
143
|
+
| H2 | [size] | [weight] | [spacing] |
|
|
144
|
+
| H3 | [size] | [weight] | [spacing] |
|
|
145
|
+
| Body | [size] | [weight] | normal |
|
|
146
|
+
| Caption | [size] | [weight] | normal |
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
150
|
+
## 9. Component Specs
|
|
151
|
+
|
|
152
|
+
### [Component Name]
|
|
153
|
+
|
|
154
|
+
**Purpose**: [What this component does]
|
|
155
|
+
|
|
156
|
+
**Props**:
|
|
157
|
+
| Prop | Type | Required | Default | Description |
|
|
158
|
+
|------|------|----------|---------|-------------|
|
|
159
|
+
| [name] | [type] | [yes/no] | [default] | [what it does] |
|
|
160
|
+
|
|
161
|
+
**States**:
|
|
162
|
+
| State | Visual | Motion |
|
|
163
|
+
|-------|--------|--------|
|
|
164
|
+
| Default | [description] | None |
|
|
165
|
+
| Hover | [description] | [animation] |
|
|
166
|
+
| Active | [description] | [animation] |
|
|
167
|
+
| Loading | [description] | Skeleton shimmer |
|
|
168
|
+
| Error | [description] | [animation] |
|
|
169
|
+
|
|
170
|
+
---
|
|
171
|
+
|
|
172
|
+
## 10. Responsive Behavior
|
|
173
|
+
|
|
174
|
+
| Breakpoint | Width | Layout Changes |
|
|
175
|
+
|------------|-------|----------------|
|
|
176
|
+
| Mobile | < 640px | Single column, hamburger nav, smaller type |
|
|
177
|
+
| Tablet | 640-1024px | 2 columns, collapsed sidebars |
|
|
178
|
+
| Desktop | > 1024px | Full layout, sidebars, 4+ columns |
|
|
179
|
+
|
|
180
|
+
---
|
|
181
|
+
|
|
182
|
+
## 11. Accessibility Checklist
|
|
183
|
+
|
|
184
|
+
- [ ] Color contrast meets WCAG AA (4.5:1 for text, 3:1 for large text)
|
|
185
|
+
- [ ] All interactive elements keyboard accessible
|
|
186
|
+
- [ ] Focus order follows visual layout
|
|
187
|
+
- [ ] Animations respect `prefers-reduced-motion`
|
|
188
|
+
- [ ] Touch targets at least 44x44px on mobile
|
|
189
|
+
- [ ] No information conveyed by color alone
|
|
190
|
+
|
|
191
|
+
---
|
|
192
|
+
|
|
193
|
+
## 12. Design Decisions Log
|
|
194
|
+
|
|
195
|
+
| Decision | Options Considered | Chosen | Why |
|
|
196
|
+
|----------|-------------------|--------|-----|
|
|
197
|
+
| [decision] | [options] | [chosen] | [reasoning] |
|
|
198
|
+
|
|
199
|
+
---
|
|
200
|
+
|
|
201
|
+
## Tips
|
|
202
|
+
|
|
203
|
+
- **Read design-config first** — every color and font must come from it
|
|
204
|
+
- **Cover all states** — loading, empty, error are just as important as the happy path
|
|
205
|
+
- **Be specific with copy** — use real feature names, not "Lorem ipsum"
|
|
206
|
+
- **Think mobile first** — if it works at 375px, it'll work everywhere
|
|
207
|
+
- **Component specs matter** — a dev should be able to build from just this doc
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# Epic: [Epic Name]
|
|
2
|
+
|
|
3
|
+
> **Workflow position:** Epic is the starting point. After filling this in, write a **feature spec** (`feature-spec.md`) for each feature listed below.
|
|
4
|
+
>
|
|
5
|
+
> ```
|
|
6
|
+
> ► Epic → Spec → [Design] → Plan → Build → Review
|
|
7
|
+
> ```
|
|
8
|
+
|
|
9
|
+
**Created**: [date]
|
|
10
|
+
**Status**: planning | in-progress | done
|
|
11
|
+
**Owner**: [who owns this]
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Why
|
|
16
|
+
|
|
17
|
+
What are we building and why? What's the big picture?
|
|
18
|
+
|
|
19
|
+
[2-3 sentences. Be specific about the outcome.]
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Success Criteria
|
|
24
|
+
|
|
25
|
+
How do we know the epic is done?
|
|
26
|
+
|
|
27
|
+
- [ ] [criteria 1]
|
|
28
|
+
- [ ] [criteria 2]
|
|
29
|
+
- [ ] [criteria 3]
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## Features
|
|
34
|
+
|
|
35
|
+
Ordered list of features. Each one becomes a spec → plan → build cycle.
|
|
36
|
+
|
|
37
|
+
| # | Feature | Status | Spec | Plan | Depends On |
|
|
38
|
+
|---|---------|--------|------|------|------------|
|
|
39
|
+
| 1 | [feature name] | todo | — | — | — |
|
|
40
|
+
| 2 | [feature name] | todo | — | — | #1 |
|
|
41
|
+
| 3 | [feature name] | todo | — | — | #1, #2 |
|
|
42
|
+
|
|
43
|
+
### Status values
|
|
44
|
+
- `todo` — not started
|
|
45
|
+
- `spec` — spec written, not built yet
|
|
46
|
+
- `planned` — plan written, not built yet
|
|
47
|
+
- `building` — currently being built
|
|
48
|
+
- `done` — built, reviewed, merged
|
|
49
|
+
- `skipped` — decided not to build
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## Feature Briefs
|
|
54
|
+
|
|
55
|
+
Short description of each feature. Enough to write a spec from.
|
|
56
|
+
|
|
57
|
+
### Feature 1: [name]
|
|
58
|
+
[2-3 sentences: what it does, why it matters, rough scope]
|
|
59
|
+
|
|
60
|
+
### Feature 2: [name]
|
|
61
|
+
[2-3 sentences]
|
|
62
|
+
|
|
63
|
+
### Feature 3: [name]
|
|
64
|
+
[2-3 sentences]
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## Risks
|
|
69
|
+
|
|
70
|
+
What could block us or go wrong?
|
|
71
|
+
|
|
72
|
+
- [risk 1]: [how to handle]
|
|
73
|
+
- [risk 2]: [how to handle]
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## Notes
|
|
78
|
+
|
|
79
|
+
- [note]
|
|
80
|
+
|
|
81
|
+
---
|
|
82
|
+
|
|
83
|
+
## Tips
|
|
84
|
+
|
|
85
|
+
- **Start with why** — what problem does the whole epic solve?
|
|
86
|
+
- **Order by dependency** — feature 2 shouldn't need feature 5
|
|
87
|
+
- **Keep features small** — each one should be 1-3 days of work, not a month
|
|
88
|
+
- **Be clear about scope** — what's in, what's out
|
|
89
|
+
- **Feature briefs matter** — they're the seed for each spec session
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## When to Use This vs Other Templates
|
|
94
|
+
|
|
95
|
+
| Situation | Use |
|
|
96
|
+
|-----------|-----|
|
|
97
|
+
| Big feature set (3+ features, multi-week) | This epic template |
|
|
98
|
+
| Single feature (1-3 days) | Skip epic, start with `feature-spec.md` |
|
|
99
|
+
| Quick task (< 1 day) | Skip epic, use `/spartan:spec` → `/spartan:build` |
|
|
100
|
+
| Product-level vision doc for stakeholders | Use `prd-template.md` instead |
|