@dzhechkov/p-replicator 1.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/README.md +314 -0
- package/bin/cli.js +4 -0
- package/package.json +62 -0
- package/src/cli.js +160 -0
- package/src/commands/doctor.js +151 -0
- package/src/commands/init.js +155 -0
- package/src/commands/list.js +133 -0
- package/src/commands/remove.js +111 -0
- package/src/commands/update.js +102 -0
- package/src/utils.js +280 -0
- package/templates/.claude/agents/doc-validator.md +92 -0
- package/templates/.claude/agents/harvest-coordinator.md +91 -0
- package/templates/.claude/agents/product-discoverer.md +57 -0
- package/templates/.claude/agents/replicate-coordinator.md +98 -0
- package/templates/.claude/commands/harvest.md +106 -0
- package/templates/.claude/commands/replicate.md +389 -0
- package/templates/.claude/rules/replicate-pipeline.md +92 -0
- package/templates/.claude/skills/brutal-honesty-review/README.md +218 -0
- package/templates/.claude/skills/brutal-honesty-review/SKILL.md +225 -0
- package/templates/.claude/skills/brutal-honesty-review/resources/assessment-rubrics.md +295 -0
- package/templates/.claude/skills/brutal-honesty-review/resources/review-template.md +102 -0
- package/templates/.claude/skills/brutal-honesty-review/scripts/assess-code.sh +179 -0
- package/templates/.claude/skills/brutal-honesty-review/scripts/assess-tests.sh +223 -0
- package/templates/.claude/skills/cc-toolkit-generator-enhanced/SKILL.md +374 -0
- package/templates/.claude/skills/cc-toolkit-generator-enhanced/references/claude-md-strategy.md +178 -0
- package/templates/.claude/skills/cc-toolkit-generator-enhanced/references/enhanced-recommendations.md +416 -0
- package/templates/.claude/skills/cc-toolkit-generator-enhanced/references/extended-mapping.md +370 -0
- package/templates/.claude/skills/cc-toolkit-generator-enhanced/references/templates/automation-commands.md +733 -0
- package/templates/.claude/skills/cc-toolkit-generator-enhanced/references/templates/ddd-agents.md +416 -0
- package/templates/.claude/skills/cc-toolkit-generator-enhanced/references/templates/ddd-hooks-commands.md +524 -0
- package/templates/.claude/skills/cc-toolkit-generator-enhanced/references/templates/ddd-skills.md +350 -0
- package/templates/.claude/skills/cc-toolkit-generator-enhanced/references/templates/enhanced-claude-md.md +235 -0
- package/templates/.claude/skills/cc-toolkit-generator-enhanced/references/templates/feature-lifecycle-ent.md +400 -0
- package/templates/.claude/skills/cc-toolkit-generator-enhanced/references/templates/feature-lifecycle.md +325 -0
- package/templates/.claude/skills/cc-toolkit-generator-enhanced/references/templates/feature-suggestions.md +423 -0
- package/templates/.claude/skills/cc-toolkit-generator-enhanced/references/templates/insights-system.md +349 -0
- package/templates/.claude/skills/cc-toolkit-generator-enhanced/references/templates/mcp.md +274 -0
- package/templates/.claude/skills/cc-toolkit-generator-enhanced/references/templates/start-command.md +283 -0
- package/templates/.claude/skills/explore/SKILL.md +215 -0
- package/templates/.claude/skills/explore/references/questioning-techniques.md +151 -0
- package/templates/.claude/skills/explore/references/task-brief-templates.md +355 -0
- package/templates/.claude/skills/goap-research-ed25519/SKILL.md +415 -0
- package/templates/.claude/skills/goap-research-ed25519/references/ed25519-verification.md +658 -0
- package/templates/.claude/skills/goap-research-ed25519/references/research-actions.md +544 -0
- package/templates/.claude/skills/goap-research-ed25519/references/source-evaluation.md +560 -0
- package/templates/.claude/skills/goap-research-ed25519/scripts/ed25519_verifier.py +662 -0
- package/templates/.claude/skills/goap-research-ed25519/scripts/goap_planner.py +720 -0
- package/templates/.claude/skills/knowledge-extractor/SKILL.md +412 -0
- package/templates/.claude/skills/knowledge-extractor/examples/rate-limiting-extraction.md +259 -0
- package/templates/.claude/skills/knowledge-extractor/modules/01-agent-review.md +192 -0
- package/templates/.claude/skills/knowledge-extractor/modules/02-classify.md +122 -0
- package/templates/.claude/skills/knowledge-extractor/modules/03-decontextualize.md +156 -0
- package/templates/.claude/skills/knowledge-extractor/modules/04-integrate.md +178 -0
- package/templates/.claude/skills/knowledge-extractor/references/artifact-categories.md +342 -0
- package/templates/.claude/skills/knowledge-extractor/references/decontextualization-guide.md +247 -0
- package/templates/.claude/skills/knowledge-extractor/references/maturity-model.md +153 -0
- package/templates/.claude/skills/knowledge-extractor/templates/artifact-card.md +60 -0
- package/templates/.claude/skills/knowledge-extractor/templates/harvest-report.md +70 -0
- package/templates/.claude/skills/knowledge-extractor/templates/toolkit-harvest.md +38 -0
- package/templates/.claude/skills/pipeline-forge/SKILL.md +523 -0
- package/templates/.claude/skills/pipeline-forge/examples/replicate-analysis.md +291 -0
- package/templates/.claude/skills/pipeline-forge/references/patterns-catalog.md +408 -0
- package/templates/.claude/skills/pipeline-forge/references/quality-gates.md +268 -0
- package/templates/.claude/skills/pipeline-forge/references/skill-anatomy.md +292 -0
- package/templates/.claude/skills/pipeline-forge/templates/agent-template.md +60 -0
- package/templates/.claude/skills/pipeline-forge/templates/command-template.md +80 -0
- package/templates/.claude/skills/pipeline-forge/templates/pipeline-template.md +137 -0
- package/templates/.claude/skills/pipeline-forge/templates/skill-template.md +132 -0
- package/templates/.claude/skills/problem-solver-enhanced/SKILL.md +562 -0
- package/templates/.claude/skills/requirements-validator/SKILL.md +121 -0
- package/templates/.claude/skills/requirements-validator/assets/templates/bdd-feature-template.feature +69 -0
- package/templates/.claude/skills/requirements-validator/references/bdd-patterns.md +184 -0
- package/templates/.claude/skills/requirements-validator/references/invest-criteria.md +121 -0
- package/templates/.claude/skills/requirements-validator/references/scoring-system.md +134 -0
- package/templates/.claude/skills/requirements-validator/references/smart-criteria.md +130 -0
- package/templates/.claude/skills/reverse-engineering-unicorn/SKILL.md +194 -0
- package/templates/.claude/skills/reverse-engineering-unicorn/examples/noom-cjm-example.md +100 -0
- package/templates/.claude/skills/reverse-engineering-unicorn/examples/noom-module1-example.md +88 -0
- package/templates/.claude/skills/reverse-engineering-unicorn/modules/01-intelligence.md +328 -0
- package/templates/.claude/skills/reverse-engineering-unicorn/modules/02-product-customers.md +221 -0
- package/templates/.claude/skills/reverse-engineering-unicorn/modules/025-cjm-prototype.md +206 -0
- package/templates/.claude/skills/reverse-engineering-unicorn/modules/03-market-competition.md +402 -0
- package/templates/.claude/skills/reverse-engineering-unicorn/modules/04-business-finance.md +287 -0
- package/templates/.claude/skills/reverse-engineering-unicorn/modules/05-growth-engine.md +290 -0
- package/templates/.claude/skills/reverse-engineering-unicorn/modules/06-playbook-synthesis.md +286 -0
- package/templates/.claude/skills/reverse-engineering-unicorn/references/blue-ocean-canvas.md +39 -0
- package/templates/.claude/skills/reverse-engineering-unicorn/references/industry-benchmarks.md +67 -0
- package/templates/.claude/skills/reverse-engineering-unicorn/references/jtbd-canvas.md +48 -0
- package/templates/.claude/skills/sparc-prd-mini/SKILL.md +955 -0
- package/templates/.claude/skills/sparc-prd-mini/references/sparc-methodology.md +360 -0
- package/templates/.claude/skills/sparc-prd-mini/templates/CLAUDE.md +91 -0
- package/templates/.claude/skills/sparc-prd-mini/templates/prd.md +336 -0
|
@@ -0,0 +1,360 @@
|
|
|
1
|
+
# SPARC Methodology Reference
|
|
2
|
+
|
|
3
|
+
Complete guide to SPARC (Specification, Pseudocode, Architecture, Refinement, Completion) methodology for AI-assisted software development and Vibe Coding.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
SPARC — структурированная методология разработки ПО, оптимизированная для работы с AI coding assistants (Claude Code, Cursor, Aider, GitHub Copilot). Каждая фаза создаёт артефакты, которые AI может использовать для генерации качественного кода.
|
|
8
|
+
|
|
9
|
+
## Philosophy
|
|
10
|
+
|
|
11
|
+
### Why SPARC for Vibe Coding?
|
|
12
|
+
|
|
13
|
+
1. **AI-Readable Structure:** Документы структурированы для оптимального понимания LLM
|
|
14
|
+
2. **Incrementally Refinable:** Каждая фаза уточняет предыдущую
|
|
15
|
+
3. **Verification Points:** Checkpoints предотвращают cascade errors
|
|
16
|
+
4. **Context-Rich:** Достаточно контекста для осмысленной кодогенерации
|
|
17
|
+
|
|
18
|
+
### Traditional vs SPARC Development
|
|
19
|
+
|
|
20
|
+
```
|
|
21
|
+
Traditional:
|
|
22
|
+
Requirements → Design → Code → Test → Deploy
|
|
23
|
+
↑ │
|
|
24
|
+
└────────── Feedback Loop ───────────┘
|
|
25
|
+
(Long cycles, expensive corrections)
|
|
26
|
+
|
|
27
|
+
SPARC:
|
|
28
|
+
Spec ⟷ Pseudo ⟷ Arch ⟷ Refine ⟷ Complete
|
|
29
|
+
↓ ↓ ↓ ↓ ↓
|
|
30
|
+
[AI verifies each transition before proceeding]
|
|
31
|
+
(Short cycles, early correction)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Phase Details
|
|
35
|
+
|
|
36
|
+
### 1. Specification (SPEC)
|
|
37
|
+
|
|
38
|
+
**Purpose:** Define WHAT needs to be built with precision.
|
|
39
|
+
|
|
40
|
+
**Key Outputs:**
|
|
41
|
+
- Functional Requirements (User Stories)
|
|
42
|
+
- Non-Functional Requirements (NFRs)
|
|
43
|
+
- Acceptance Criteria
|
|
44
|
+
- Constraints & Assumptions
|
|
45
|
+
|
|
46
|
+
**AI Optimization Tips:**
|
|
47
|
+
```markdown
|
|
48
|
+
✅ GOOD for AI:
|
|
49
|
+
"User can login with email/password. On success, redirect to /dashboard.
|
|
50
|
+
On failure, show inline error and allow retry. Lock account after 5 failures."
|
|
51
|
+
|
|
52
|
+
❌ BAD for AI:
|
|
53
|
+
"User should be able to login."
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
**Specification Completeness Checklist:**
|
|
57
|
+
- [ ] Every feature has clear acceptance criteria
|
|
58
|
+
- [ ] Edge cases explicitly mentioned
|
|
59
|
+
- [ ] Error states defined
|
|
60
|
+
- [ ] Success metrics quantified
|
|
61
|
+
|
|
62
|
+
### 2. Pseudocode (PSEUDO)
|
|
63
|
+
|
|
64
|
+
**Purpose:** Define HOW logic should work without language syntax.
|
|
65
|
+
|
|
66
|
+
**Key Outputs:**
|
|
67
|
+
- Algorithm descriptions
|
|
68
|
+
- Data structures
|
|
69
|
+
- State transitions
|
|
70
|
+
- API contracts
|
|
71
|
+
|
|
72
|
+
**Best Practices for AI-Readable Pseudocode:**
|
|
73
|
+
|
|
74
|
+
```
|
|
75
|
+
✅ GOOD:
|
|
76
|
+
FUNCTION validateEmail(email):
|
|
77
|
+
INPUT: email (string)
|
|
78
|
+
OUTPUT: boolean
|
|
79
|
+
|
|
80
|
+
1. IF email is empty THEN RETURN false
|
|
81
|
+
2. IF email does not match regex /^[^@]+@[^@]+\.[^@]+$/ THEN RETURN false
|
|
82
|
+
3. IF email length > 255 THEN RETURN false
|
|
83
|
+
4. RETURN true
|
|
84
|
+
|
|
85
|
+
❌ BAD:
|
|
86
|
+
validate email - check if it's correct
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
**Pseudocode Detail Levels:**
|
|
90
|
+
|
|
91
|
+
| Level | Use Case | Detail |
|
|
92
|
+
|-------|----------|--------|
|
|
93
|
+
| High | Architecture discussions | Function names, inputs/outputs |
|
|
94
|
+
| Medium | Implementation planning | Control flow, key logic |
|
|
95
|
+
| Detailed | Complex algorithms | Every condition, edge case |
|
|
96
|
+
|
|
97
|
+
### 3. Architecture (ARCH)
|
|
98
|
+
|
|
99
|
+
**Purpose:** Define system STRUCTURE and technology choices.
|
|
100
|
+
|
|
101
|
+
**Key Outputs:**
|
|
102
|
+
- Component diagrams
|
|
103
|
+
- Technology stack
|
|
104
|
+
- Data models
|
|
105
|
+
- Integration points
|
|
106
|
+
- Security architecture
|
|
107
|
+
|
|
108
|
+
**AI-Friendly Architecture Patterns:**
|
|
109
|
+
|
|
110
|
+
```markdown
|
|
111
|
+
✅ GOOD:
|
|
112
|
+
## Authentication Flow
|
|
113
|
+
```
|
|
114
|
+
[Client] → POST /auth/login → [API Gateway]
|
|
115
|
+
↓
|
|
116
|
+
[Auth Service]
|
|
117
|
+
↓
|
|
118
|
+
[User DB] ← validate credentials
|
|
119
|
+
↓
|
|
120
|
+
[Token Service] ← generate JWT
|
|
121
|
+
↓
|
|
122
|
+
Response: {token, refreshToken}
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
❌ BAD:
|
|
126
|
+
"Use standard OAuth flow"
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
**Architecture Decision Records (ADR) Template:**
|
|
130
|
+
|
|
131
|
+
```markdown
|
|
132
|
+
## ADR-001: Database Selection
|
|
133
|
+
|
|
134
|
+
**Status:** Accepted
|
|
135
|
+
**Context:** Need persistent storage for user data with ACID compliance
|
|
136
|
+
**Decision:** PostgreSQL 16
|
|
137
|
+
**Rationale:**
|
|
138
|
+
- JSON support for flexible schemas
|
|
139
|
+
- Strong ecosystem (Prisma, TypeORM support)
|
|
140
|
+
- Team familiarity
|
|
141
|
+
**Consequences:**
|
|
142
|
+
- Need to manage connection pooling
|
|
143
|
+
- Requires managed service or self-hosting
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### 4. Refinement (REFINE)
|
|
147
|
+
|
|
148
|
+
**Purpose:** Improve quality, handle edge cases, optimize.
|
|
149
|
+
|
|
150
|
+
**Key Outputs:**
|
|
151
|
+
- Test specifications
|
|
152
|
+
- Performance optimizations
|
|
153
|
+
- Security hardening
|
|
154
|
+
- Error handling matrix
|
|
155
|
+
|
|
156
|
+
**Test Specification Format:**
|
|
157
|
+
|
|
158
|
+
```markdown
|
|
159
|
+
## Test Suite: UserAuthentication
|
|
160
|
+
|
|
161
|
+
### Unit Tests
|
|
162
|
+
| Test ID | Description | Input | Expected Output |
|
|
163
|
+
|---------|-------------|-------|-----------------|
|
|
164
|
+
| UT-001 | Valid login | valid email, password | {success: true, token} |
|
|
165
|
+
| UT-002 | Invalid password | valid email, wrong password | {success: false, error: "AUTH_FAILED"} |
|
|
166
|
+
| UT-003 | Locked account | valid credentials, locked account | {success: false, error: "ACCOUNT_LOCKED"} |
|
|
167
|
+
|
|
168
|
+
### Integration Tests
|
|
169
|
+
| Test ID | Scenario | Steps | Expected Result |
|
|
170
|
+
|---------|----------|-------|-----------------|
|
|
171
|
+
| IT-001 | Login flow | 1. POST /login with valid creds | 200, JWT in response |
|
|
172
|
+
| IT-002 | Rate limiting | 1. POST /login 11 times in 1 min | 429 on 11th request |
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
**Error Handling Matrix:**
|
|
176
|
+
|
|
177
|
+
| Error Code | HTTP | Trigger | User Message | System Action |
|
|
178
|
+
|------------|------|---------|--------------|---------------|
|
|
179
|
+
| AUTH_001 | 401 | Invalid credentials | "Email or password incorrect" | Log attempt |
|
|
180
|
+
| AUTH_002 | 423 | Account locked | "Account locked. Contact support." | Alert security |
|
|
181
|
+
| AUTH_003 | 429 | Rate limit exceeded | "Too many attempts. Wait 15 minutes." | Temp block IP |
|
|
182
|
+
|
|
183
|
+
### 5. Completion (COMP)
|
|
184
|
+
|
|
185
|
+
**Purpose:** Ensure production readiness.
|
|
186
|
+
|
|
187
|
+
**Key Outputs:**
|
|
188
|
+
- Deployment procedures
|
|
189
|
+
- CI/CD configuration
|
|
190
|
+
- Monitoring setup
|
|
191
|
+
- Documentation
|
|
192
|
+
- Handoff checklists
|
|
193
|
+
|
|
194
|
+
**Deployment Readiness Checklist:**
|
|
195
|
+
|
|
196
|
+
```markdown
|
|
197
|
+
## Pre-Deployment
|
|
198
|
+
- [ ] All tests passing (unit, integration, e2e)
|
|
199
|
+
- [ ] Security scan clear (no critical/high vulnerabilities)
|
|
200
|
+
- [ ] Performance benchmarks met
|
|
201
|
+
- [ ] Database migrations tested
|
|
202
|
+
- [ ] Rollback procedure documented and tested
|
|
203
|
+
- [ ] Feature flags configured
|
|
204
|
+
- [ ] Monitoring dashboards ready
|
|
205
|
+
- [ ] Alerting rules configured
|
|
206
|
+
- [ ] Documentation updated
|
|
207
|
+
|
|
208
|
+
## Deployment
|
|
209
|
+
- [ ] Maintenance window announced
|
|
210
|
+
- [ ] Backup created
|
|
211
|
+
- [ ] Deploy to staging
|
|
212
|
+
- [ ] Smoke tests on staging
|
|
213
|
+
- [ ] Deploy to production
|
|
214
|
+
- [ ] Smoke tests on production
|
|
215
|
+
- [ ] Monitor metrics for 30 minutes
|
|
216
|
+
|
|
217
|
+
## Post-Deployment
|
|
218
|
+
- [ ] Verify all health checks green
|
|
219
|
+
- [ ] Check error rates
|
|
220
|
+
- [ ] Confirm logs flowing
|
|
221
|
+
- [ ] Update status page
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
## SPARC for Different Project Types
|
|
225
|
+
|
|
226
|
+
### API Development
|
|
227
|
+
|
|
228
|
+
```
|
|
229
|
+
Spec: OpenAPI/Swagger spec, endpoint definitions
|
|
230
|
+
Pseudo: Request/response flows, validation logic
|
|
231
|
+
Arch: Service architecture, auth flow, rate limiting
|
|
232
|
+
Refine: API tests, error codes, pagination
|
|
233
|
+
Complete: API docs, SDK generation, versioning strategy
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
### Frontend Application
|
|
237
|
+
|
|
238
|
+
```
|
|
239
|
+
Spec: User stories, wireframes, interaction specs
|
|
240
|
+
Pseudo: State management logic, form validation
|
|
241
|
+
Arch: Component hierarchy, routing, state architecture
|
|
242
|
+
Refine: Unit tests, accessibility, performance optimization
|
|
243
|
+
Complete: Build pipeline, CDN config, monitoring
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
### Data Pipeline
|
|
247
|
+
|
|
248
|
+
```
|
|
249
|
+
Spec: Data sources, transformations, SLAs
|
|
250
|
+
Pseudo: ETL logic, validation rules
|
|
251
|
+
Arch: Pipeline architecture, storage strategy
|
|
252
|
+
Refine: Data quality tests, error recovery
|
|
253
|
+
Complete: Orchestration, monitoring, alerting
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
## Integration with AI Tools
|
|
257
|
+
|
|
258
|
+
### Claude Code
|
|
259
|
+
|
|
260
|
+
```bash
|
|
261
|
+
# Start project with SPARC context
|
|
262
|
+
claude --project ./my-sparc-project
|
|
263
|
+
|
|
264
|
+
# Claude will use CLAUDE.md and SPARC docs as context
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
**Recommended CLAUDE.md:**
|
|
268
|
+
|
|
269
|
+
```markdown
|
|
270
|
+
# Project: [Name]
|
|
271
|
+
|
|
272
|
+
## Documentation
|
|
273
|
+
Read these SPARC documents before implementing:
|
|
274
|
+
1. Specification.md - Requirements and acceptance criteria
|
|
275
|
+
2. Pseudocode.md - Implementation logic
|
|
276
|
+
3. Architecture.md - System design decisions
|
|
277
|
+
4. Refinement.md - Testing and edge cases
|
|
278
|
+
5. Completion.md - Deployment requirements
|
|
279
|
+
|
|
280
|
+
## Coding Standards
|
|
281
|
+
- Follow patterns in existing code
|
|
282
|
+
- Add tests for new functionality
|
|
283
|
+
- Update docs when changing interfaces
|
|
284
|
+
```
|
|
285
|
+
|
|
286
|
+
### Cursor
|
|
287
|
+
|
|
288
|
+
```markdown
|
|
289
|
+
# .cursorrules
|
|
290
|
+
|
|
291
|
+
## Project Context
|
|
292
|
+
This project follows SPARC methodology. Reference documents:
|
|
293
|
+
- /docs/Specification.md for requirements
|
|
294
|
+
- /docs/Architecture.md for system design
|
|
295
|
+
- /docs/Refinement.md for testing requirements
|
|
296
|
+
|
|
297
|
+
## Implementation Rules
|
|
298
|
+
1. Match pseudocode in Pseudocode.md when implementing algorithms
|
|
299
|
+
2. Follow error codes defined in Refinement.md
|
|
300
|
+
3. Ensure tests cover acceptance criteria from Specification.md
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
### Aider
|
|
304
|
+
|
|
305
|
+
```bash
|
|
306
|
+
# Add SPARC docs as read-only context
|
|
307
|
+
aider --read Specification.md Architecture.md Pseudocode.md
|
|
308
|
+
|
|
309
|
+
# Or use architect mode for design discussions
|
|
310
|
+
aider --architect --read Architecture.md
|
|
311
|
+
```
|
|
312
|
+
|
|
313
|
+
## Quality Metrics
|
|
314
|
+
|
|
315
|
+
### Document Quality Score
|
|
316
|
+
|
|
317
|
+
| Metric | Weight | Criteria |
|
|
318
|
+
|--------|--------|----------|
|
|
319
|
+
| Completeness | 30% | All sections filled |
|
|
320
|
+
| Consistency | 25% | No contradictions across docs |
|
|
321
|
+
| Specificity | 25% | Concrete, not vague |
|
|
322
|
+
| Testability | 20% | Claims verifiable |
|
|
323
|
+
|
|
324
|
+
### Vibe Coding Readiness Score
|
|
325
|
+
|
|
326
|
+
| Factor | Score | Description |
|
|
327
|
+
|--------|-------|-------------|
|
|
328
|
+
| 1 | Not ready | Missing major sections |
|
|
329
|
+
| 2 | Partial | Has structure, lacks detail |
|
|
330
|
+
| 3 | Ready | Can generate code with supervision |
|
|
331
|
+
| 4 | Excellent | Can generate production code |
|
|
332
|
+
| 5 | Optimal | AI can work autonomously |
|
|
333
|
+
|
|
334
|
+
## Common Pitfalls
|
|
335
|
+
|
|
336
|
+
### Spec Phase
|
|
337
|
+
❌ Vague requirements ("system should be fast")
|
|
338
|
+
✅ Quantified requirements ("API response < 200ms p99")
|
|
339
|
+
|
|
340
|
+
### Pseudo Phase
|
|
341
|
+
❌ Implementation-specific ("use Redis ZADD")
|
|
342
|
+
✅ Logic-focused ("add to sorted set with score")
|
|
343
|
+
|
|
344
|
+
### Arch Phase
|
|
345
|
+
❌ Over-engineering ("microservices for MVP")
|
|
346
|
+
✅ Right-sized ("monolith with clear module boundaries")
|
|
347
|
+
|
|
348
|
+
### Refine Phase
|
|
349
|
+
❌ Happy path only
|
|
350
|
+
✅ Explicit error cases and edge conditions
|
|
351
|
+
|
|
352
|
+
### Complete Phase
|
|
353
|
+
❌ "Deploy to production"
|
|
354
|
+
✅ Step-by-step runbook with rollback
|
|
355
|
+
|
|
356
|
+
## References
|
|
357
|
+
|
|
358
|
+
- [SPARC Framework Repository](https://github.com/ruvnet/sparc)
|
|
359
|
+
- [Claude Flow SPARC Integration](https://github.com/ruvnet/claude-flow)
|
|
360
|
+
- [SPARC CLI Documentation](https://github.com/ruvnet/sparc/tree/main/sparc_cli)
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# {PROJECT_NAME}
|
|
2
|
+
|
|
3
|
+
## Project Documentation
|
|
4
|
+
|
|
5
|
+
This project follows SPARC methodology. Read these documents in order:
|
|
6
|
+
|
|
7
|
+
### 1. Specification (WHAT to build)
|
|
8
|
+
- `Specification.md` - User stories, acceptance criteria, requirements
|
|
9
|
+
- `PRD.md` - Product context, personas, success metrics
|
|
10
|
+
|
|
11
|
+
### 2. Pseudocode (HOW it works)
|
|
12
|
+
- `Pseudocode.md` - Algorithms, data structures, state transitions
|
|
13
|
+
|
|
14
|
+
### 3. Architecture (SYSTEM design)
|
|
15
|
+
- `Architecture.md` - Components, tech stack, integrations
|
|
16
|
+
|
|
17
|
+
### 4. Refinement (QUALITY)
|
|
18
|
+
- `Refinement.md` - Edge cases, tests, optimizations
|
|
19
|
+
|
|
20
|
+
### 5. Completion (DEPLOY)
|
|
21
|
+
- `Completion.md` - CI/CD, monitoring, runbooks
|
|
22
|
+
|
|
23
|
+
## Implementation Rules
|
|
24
|
+
|
|
25
|
+
### Code Standards
|
|
26
|
+
- Match pseudocode specifications exactly
|
|
27
|
+
- Follow naming conventions established in Architecture.md
|
|
28
|
+
- Add tests for all new functionality
|
|
29
|
+
- Document public APIs
|
|
30
|
+
|
|
31
|
+
### Priority Order
|
|
32
|
+
1. Implement "Must" requirements first (see Specification.md)
|
|
33
|
+
2. Then "Should" requirements
|
|
34
|
+
3. "Could" requirements only if time permits
|
|
35
|
+
|
|
36
|
+
### Error Handling
|
|
37
|
+
- Use error codes defined in Refinement.md
|
|
38
|
+
- Log with structured format from Completion.md
|
|
39
|
+
- Always validate inputs before processing
|
|
40
|
+
|
|
41
|
+
### Testing
|
|
42
|
+
- Write tests BEFORE implementation (TDD)
|
|
43
|
+
- Cover all acceptance criteria
|
|
44
|
+
- Include edge cases from Refinement.md
|
|
45
|
+
|
|
46
|
+
## File Structure
|
|
47
|
+
|
|
48
|
+
```
|
|
49
|
+
src/
|
|
50
|
+
├── api/ # HTTP handlers
|
|
51
|
+
├── services/ # Business logic
|
|
52
|
+
├── repositories/ # Data access
|
|
53
|
+
├── models/ # Domain entities
|
|
54
|
+
├── utils/ # Shared utilities
|
|
55
|
+
└── config/ # Configuration
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Quick Reference
|
|
59
|
+
|
|
60
|
+
### Key Entities
|
|
61
|
+
<!-- Add main domain entities here -->
|
|
62
|
+
|
|
63
|
+
### API Endpoints
|
|
64
|
+
<!-- Add main API endpoints here -->
|
|
65
|
+
|
|
66
|
+
### Environment Variables
|
|
67
|
+
```
|
|
68
|
+
DATABASE_URL=
|
|
69
|
+
API_KEY=
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Getting Started
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
# Install dependencies
|
|
76
|
+
npm install # or pip install -r requirements.txt
|
|
77
|
+
|
|
78
|
+
# Run tests
|
|
79
|
+
npm test
|
|
80
|
+
|
|
81
|
+
# Start development
|
|
82
|
+
npm run dev
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## Notes for AI Assistants
|
|
86
|
+
|
|
87
|
+
- When implementing features, always check Specification.md first
|
|
88
|
+
- Cross-reference Pseudocode.md for algorithm details
|
|
89
|
+
- Verify technology choices against Architecture.md
|
|
90
|
+
- Check Refinement.md for edge cases before completing
|
|
91
|
+
- Follow deployment checklist in Completion.md
|