opencode-metis 0.1.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 +140 -0
- package/dist/cli.cjs +63 -0
- package/dist/mcp-server.cjs +51 -0
- package/dist/plugin.cjs +4 -0
- package/dist/worker.cjs +224 -0
- package/opencode/agent/the-analyst/feature-prioritization.md +66 -0
- package/opencode/agent/the-analyst/market-research.md +77 -0
- package/opencode/agent/the-analyst/project-coordination.md +81 -0
- package/opencode/agent/the-analyst/requirements-analysis.md +77 -0
- package/opencode/agent/the-architect/compatibility-review.md +138 -0
- package/opencode/agent/the-architect/complexity-review.md +137 -0
- package/opencode/agent/the-architect/quality-review.md +67 -0
- package/opencode/agent/the-architect/security-review.md +127 -0
- package/opencode/agent/the-architect/system-architecture.md +119 -0
- package/opencode/agent/the-architect/system-documentation.md +83 -0
- package/opencode/agent/the-architect/technology-research.md +85 -0
- package/opencode/agent/the-chief.md +79 -0
- package/opencode/agent/the-designer/accessibility-implementation.md +101 -0
- package/opencode/agent/the-designer/design-foundation.md +74 -0
- package/opencode/agent/the-designer/interaction-architecture.md +75 -0
- package/opencode/agent/the-designer/user-research.md +70 -0
- package/opencode/agent/the-meta-agent.md +155 -0
- package/opencode/agent/the-platform-engineer/ci-cd-pipelines.md +109 -0
- package/opencode/agent/the-platform-engineer/containerization.md +106 -0
- package/opencode/agent/the-platform-engineer/data-architecture.md +81 -0
- package/opencode/agent/the-platform-engineer/dependency-review.md +144 -0
- package/opencode/agent/the-platform-engineer/deployment-automation.md +81 -0
- package/opencode/agent/the-platform-engineer/infrastructure-as-code.md +107 -0
- package/opencode/agent/the-platform-engineer/performance-tuning.md +82 -0
- package/opencode/agent/the-platform-engineer/pipeline-engineering.md +81 -0
- package/opencode/agent/the-platform-engineer/production-monitoring.md +105 -0
- package/opencode/agent/the-qa-engineer/exploratory-testing.md +66 -0
- package/opencode/agent/the-qa-engineer/performance-testing.md +81 -0
- package/opencode/agent/the-qa-engineer/quality-assurance.md +77 -0
- package/opencode/agent/the-qa-engineer/test-execution.md +66 -0
- package/opencode/agent/the-software-engineer/api-development.md +78 -0
- package/opencode/agent/the-software-engineer/component-development.md +79 -0
- package/opencode/agent/the-software-engineer/concurrency-review.md +141 -0
- package/opencode/agent/the-software-engineer/domain-modeling.md +66 -0
- package/opencode/agent/the-software-engineer/performance-optimization.md +113 -0
- package/opencode/command/analyze.md +149 -0
- package/opencode/command/constitution.md +178 -0
- package/opencode/command/debug.md +194 -0
- package/opencode/command/document.md +178 -0
- package/opencode/command/implement.md +225 -0
- package/opencode/command/refactor.md +207 -0
- package/opencode/command/review.md +229 -0
- package/opencode/command/simplify.md +267 -0
- package/opencode/command/specify.md +191 -0
- package/opencode/command/validate.md +224 -0
- package/opencode/skill/accessibility-design/SKILL.md +566 -0
- package/opencode/skill/accessibility-design/checklists/wcag-checklist.md +435 -0
- package/opencode/skill/agent-coordination/SKILL.md +224 -0
- package/opencode/skill/api-contract-design/SKILL.md +550 -0
- package/opencode/skill/api-contract-design/templates/graphql-schema-template.md +818 -0
- package/opencode/skill/api-contract-design/templates/rest-api-template.md +417 -0
- package/opencode/skill/architecture-design/SKILL.md +160 -0
- package/opencode/skill/architecture-design/examples/architecture-examples.md +170 -0
- package/opencode/skill/architecture-design/template.md +749 -0
- package/opencode/skill/architecture-design/validation.md +99 -0
- package/opencode/skill/architecture-selection/SKILL.md +522 -0
- package/opencode/skill/architecture-selection/examples/adrs/001-example-adr.md +71 -0
- package/opencode/skill/architecture-selection/examples/architecture-patterns.md +239 -0
- package/opencode/skill/bug-diagnosis/SKILL.md +235 -0
- package/opencode/skill/code-quality-review/SKILL.md +337 -0
- package/opencode/skill/code-quality-review/examples/anti-patterns.md +629 -0
- package/opencode/skill/code-quality-review/reference.md +322 -0
- package/opencode/skill/code-review/SKILL.md +363 -0
- package/opencode/skill/code-review/reference.md +450 -0
- package/opencode/skill/codebase-analysis/SKILL.md +139 -0
- package/opencode/skill/codebase-navigation/SKILL.md +227 -0
- package/opencode/skill/codebase-navigation/examples/exploration-patterns.md +263 -0
- package/opencode/skill/coding-conventions/SKILL.md +178 -0
- package/opencode/skill/coding-conventions/checklists/accessibility-checklist.md +176 -0
- package/opencode/skill/coding-conventions/checklists/performance-checklist.md +154 -0
- package/opencode/skill/coding-conventions/checklists/security-checklist.md +127 -0
- package/opencode/skill/constitution-validation/SKILL.md +315 -0
- package/opencode/skill/constitution-validation/examples/CONSTITUTION.md +202 -0
- package/opencode/skill/constitution-validation/reference/rule-patterns.md +328 -0
- package/opencode/skill/constitution-validation/template.md +115 -0
- package/opencode/skill/context-preservation/SKILL.md +445 -0
- package/opencode/skill/data-modeling/SKILL.md +385 -0
- package/opencode/skill/data-modeling/templates/schema-design-template.md +268 -0
- package/opencode/skill/deployment-pipeline-design/SKILL.md +579 -0
- package/opencode/skill/deployment-pipeline-design/templates/pipeline-template.md +633 -0
- package/opencode/skill/documentation-extraction/SKILL.md +259 -0
- package/opencode/skill/documentation-sync/SKILL.md +431 -0
- package/opencode/skill/domain-driven-design/SKILL.md +509 -0
- package/opencode/skill/domain-driven-design/examples/ddd-patterns.md +688 -0
- package/opencode/skill/domain-driven-design/reference.md +465 -0
- package/opencode/skill/drift-detection/SKILL.md +383 -0
- package/opencode/skill/drift-detection/reference.md +340 -0
- package/opencode/skill/error-recovery/SKILL.md +162 -0
- package/opencode/skill/error-recovery/examples/error-patterns.md +484 -0
- package/opencode/skill/feature-prioritization/SKILL.md +419 -0
- package/opencode/skill/feature-prioritization/examples/rice-template.md +139 -0
- package/opencode/skill/feature-prioritization/reference.md +256 -0
- package/opencode/skill/git-workflow/SKILL.md +453 -0
- package/opencode/skill/implementation-planning/SKILL.md +215 -0
- package/opencode/skill/implementation-planning/examples/phase-examples.md +217 -0
- package/opencode/skill/implementation-planning/template.md +220 -0
- package/opencode/skill/implementation-planning/validation.md +88 -0
- package/opencode/skill/implementation-verification/SKILL.md +272 -0
- package/opencode/skill/knowledge-capture/SKILL.md +265 -0
- package/opencode/skill/knowledge-capture/reference/knowledge-capture.md +402 -0
- package/opencode/skill/knowledge-capture/reference.md +444 -0
- package/opencode/skill/knowledge-capture/templates/domain-template.md +325 -0
- package/opencode/skill/knowledge-capture/templates/interface-template.md +255 -0
- package/opencode/skill/knowledge-capture/templates/pattern-template.md +144 -0
- package/opencode/skill/observability-design/SKILL.md +291 -0
- package/opencode/skill/observability-design/references/monitoring-patterns.md +461 -0
- package/opencode/skill/pattern-detection/SKILL.md +171 -0
- package/opencode/skill/pattern-detection/examples/common-patterns.md +359 -0
- package/opencode/skill/performance-analysis/SKILL.md +266 -0
- package/opencode/skill/performance-analysis/references/profiling-tools.md +499 -0
- package/opencode/skill/requirements-analysis/SKILL.md +139 -0
- package/opencode/skill/requirements-analysis/examples/good-prd.md +66 -0
- package/opencode/skill/requirements-analysis/template.md +177 -0
- package/opencode/skill/requirements-analysis/validation.md +69 -0
- package/opencode/skill/requirements-elicitation/SKILL.md +518 -0
- package/opencode/skill/requirements-elicitation/examples/interview-questions.md +226 -0
- package/opencode/skill/requirements-elicitation/examples/user-stories.md +414 -0
- package/opencode/skill/safe-refactoring/SKILL.md +312 -0
- package/opencode/skill/safe-refactoring/reference/code-smells.md +347 -0
- package/opencode/skill/security-assessment/SKILL.md +421 -0
- package/opencode/skill/security-assessment/checklists/security-review-checklist.md +285 -0
- package/opencode/skill/specification-management/SKILL.md +143 -0
- package/opencode/skill/specification-management/readme-template.md +32 -0
- package/opencode/skill/specification-management/reference.md +115 -0
- package/opencode/skill/specification-management/spec.py +229 -0
- package/opencode/skill/specification-validation/SKILL.md +397 -0
- package/opencode/skill/specification-validation/reference/3cs-framework.md +306 -0
- package/opencode/skill/specification-validation/reference/ambiguity-detection.md +132 -0
- package/opencode/skill/specification-validation/reference/constitution-validation.md +301 -0
- package/opencode/skill/specification-validation/reference/drift-detection.md +383 -0
- package/opencode/skill/task-delegation/SKILL.md +607 -0
- package/opencode/skill/task-delegation/examples/file-coordination.md +495 -0
- package/opencode/skill/task-delegation/examples/parallel-research.md +337 -0
- package/opencode/skill/task-delegation/examples/sequential-build.md +504 -0
- package/opencode/skill/task-delegation/reference.md +825 -0
- package/opencode/skill/tech-stack-detection/SKILL.md +89 -0
- package/opencode/skill/tech-stack-detection/references/framework-signatures.md +598 -0
- package/opencode/skill/technical-writing/SKILL.md +190 -0
- package/opencode/skill/technical-writing/templates/adr-template.md +205 -0
- package/opencode/skill/technical-writing/templates/system-doc-template.md +380 -0
- package/opencode/skill/test-design/SKILL.md +464 -0
- package/opencode/skill/test-design/examples/test-pyramid.md +724 -0
- package/opencode/skill/testing/SKILL.md +213 -0
- package/opencode/skill/testing/examples/test-pyramid.md +724 -0
- package/opencode/skill/user-insight-synthesis/SKILL.md +576 -0
- package/opencode/skill/user-insight-synthesis/templates/research-plan-template.md +217 -0
- package/opencode/skill/user-research/SKILL.md +508 -0
- package/opencode/skill/user-research/examples/interview-questions.md +265 -0
- package/opencode/skill/user-research/examples/personas.md +267 -0
- package/opencode/skill/vibe-security/SKILL.md +654 -0
- package/package.json +45 -0
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
# PLAN Validation Checklist
|
|
2
|
+
|
|
3
|
+
Use this checklist to validate Implementation Plan completeness before execution.
|
|
4
|
+
|
|
5
|
+
## Structure Validation
|
|
6
|
+
|
|
7
|
+
- [ ] **All required sections are complete** - No empty or placeholder sections
|
|
8
|
+
- [ ] **No [NEEDS CLARIFICATION] markers remain** - All markers replaced with content
|
|
9
|
+
- [ ] **Template structure preserved** - No sections added, removed, or reorganized
|
|
10
|
+
|
|
11
|
+
## Context Priming
|
|
12
|
+
|
|
13
|
+
- [ ] **Specification paths correct** - PRD and SDD file paths exist and are valid
|
|
14
|
+
- [ ] **Key decisions extracted** - Critical choices from SDD are highlighted
|
|
15
|
+
- [ ] **Project commands documented** - Actual commands from project setup
|
|
16
|
+
- [ ] **Pattern links provided** - References to relevant pattern documentation
|
|
17
|
+
|
|
18
|
+
## Phase Structure
|
|
19
|
+
|
|
20
|
+
- [ ] **All implementation phases defined** - Complete coverage of the feature
|
|
21
|
+
- [ ] **Each phase follows TDD structure**:
|
|
22
|
+
- Prime Context (read specs, load patterns)
|
|
23
|
+
- Write Tests (behavior verification first)
|
|
24
|
+
- Implement (code to pass tests)
|
|
25
|
+
- Validate (quality gates)
|
|
26
|
+
- [ ] **Phase boundaries are logical** - Clear separation of concerns
|
|
27
|
+
|
|
28
|
+
## Task Quality
|
|
29
|
+
|
|
30
|
+
- [ ] **Tasks are actionable** - Clear what needs to be done
|
|
31
|
+
- [ ] **Tasks are atomic** - Can be completed independently (where not dependent)
|
|
32
|
+
- [ ] **No time estimates included** - Focus on WHAT, not HOW LONG
|
|
33
|
+
- [ ] **Activity hints provided** - `[activity: type]` for specialist selection
|
|
34
|
+
|
|
35
|
+
## Dependencies
|
|
36
|
+
|
|
37
|
+
- [ ] **Dependencies between phases clear** - What must complete before what
|
|
38
|
+
- [ ] **No circular dependencies** - Phases can be ordered linearly
|
|
39
|
+
- [ ] **Parallel work tagged** - `[parallel: true]` where applicable
|
|
40
|
+
- [ ] **Component tags for multi-component** - `[component: name]` where needed
|
|
41
|
+
|
|
42
|
+
## Specification Traceability
|
|
43
|
+
|
|
44
|
+
- [ ] **Every phase references SDD** - `[ref: SDD/Section X]`
|
|
45
|
+
- [ ] **Every test references PRD criteria** - `[ref: PRD/Section Y]`
|
|
46
|
+
- [ ] **All PRD requirements covered** - Nothing from PRD is missing
|
|
47
|
+
- [ ] **All SDD components covered** - Nothing from architecture is skipped
|
|
48
|
+
|
|
49
|
+
## Validation Steps
|
|
50
|
+
|
|
51
|
+
- [ ] **Each phase has validation step** - T\*.4 Validate present in each phase
|
|
52
|
+
- [ ] **Code review included** - Quality gate for code standards
|
|
53
|
+
- [ ] **Automated tests included** - Test execution gate
|
|
54
|
+
- [ ] **Specification compliance included** - Business acceptance gate
|
|
55
|
+
|
|
56
|
+
## Final Phase
|
|
57
|
+
|
|
58
|
+
- [ ] **Integration tests defined** - Cross-component testing
|
|
59
|
+
- [ ] **E2E tests defined** - Complete user flow testing
|
|
60
|
+
- [ ] **Performance validation included** - If performance requirements exist
|
|
61
|
+
- [ ] **Security validation included** - If security requirements exist
|
|
62
|
+
- [ ] **All PRD requirements verified** - Final acceptance criteria check
|
|
63
|
+
|
|
64
|
+
## Practical Validation
|
|
65
|
+
|
|
66
|
+
- [ ] **Project commands match setup** - Commands work in the actual project
|
|
67
|
+
- [ ] **File paths are realistic** - Directories and files match codebase
|
|
68
|
+
- [ ] **A developer could follow independently** - No assumed knowledge
|
|
69
|
+
|
|
70
|
+
## No-Go Items
|
|
71
|
+
|
|
72
|
+
These should NOT appear in a PLAN:
|
|
73
|
+
|
|
74
|
+
- [ ] **No time estimates** - Hours, days, sprints
|
|
75
|
+
- [ ] **No resource assignments** - Who does what
|
|
76
|
+
- [ ] **No implementation code** - Actual code snippets (examples in SDD)
|
|
77
|
+
- [ ] **No scope expansion** - Tasks beyond PRD/SDD scope
|
|
78
|
+
|
|
79
|
+
## Completion Criteria
|
|
80
|
+
|
|
81
|
+
✅ **PLAN is complete when:**
|
|
82
|
+
|
|
83
|
+
- All checklist items pass
|
|
84
|
+
- User has reviewed and approved the task breakdown
|
|
85
|
+
- Every PRD requirement maps to at least one task
|
|
86
|
+
- Every SDD component is covered by phases
|
|
87
|
+
- A developer can start implementation immediately
|
|
88
|
+
- Ready for `/implement` execution
|
|
@@ -0,0 +1,272 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: implementation-verification
|
|
3
|
+
description: "Verify that implementation matches specifications exactly, checking interface contracts, architecture decisions, data models, and business logic compliance"
|
|
4
|
+
license: MIT
|
|
5
|
+
compatibility: opencode
|
|
6
|
+
metadata:
|
|
7
|
+
category: analysis
|
|
8
|
+
version: "1.0"
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Implementation Verification
|
|
12
|
+
|
|
13
|
+
Roleplay as a specification compliance validator that ensures implementations match documented requirements exactly.
|
|
14
|
+
|
|
15
|
+
ImplementationVerification {
|
|
16
|
+
Activation {
|
|
17
|
+
When to use this skill:
|
|
18
|
+
- Verify SDD compliance during implementation
|
|
19
|
+
- Check interface contracts match specifications
|
|
20
|
+
- Validate architecture decisions are followed
|
|
21
|
+
- Detect deviations from documented requirements
|
|
22
|
+
- Report compliance status at checkpoints
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
CorePrinciple {
|
|
26
|
+
Constraints {
|
|
27
|
+
1. Every implementation must match the specification exactly
|
|
28
|
+
2. Deviations require explicit acknowledgment before proceeding
|
|
29
|
+
3. Include file:line for every finding -- no generic observations
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
SpecificationDocumentHierarchy {
|
|
34
|
+
```
|
|
35
|
+
docs/specs/[NNN]-[name]/
|
|
36
|
+
product-requirements.md # WHAT and WHY (business requirements)
|
|
37
|
+
solution-design.md # HOW (technical design, interfaces, patterns)
|
|
38
|
+
implementation-plan.md # WHEN (execution sequence, phases)
|
|
39
|
+
```
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
ComplianceVerificationProcess {
|
|
43
|
+
PreImplementationCheck {
|
|
44
|
+
Before implementing any task:
|
|
45
|
+
1. Extract SDD references from PLAN.md task: `[ref: SDD/Section X.Y]`
|
|
46
|
+
2. Read referenced sections from solution-design.md
|
|
47
|
+
3. Identify requirements:
|
|
48
|
+
- Interface contracts
|
|
49
|
+
- Data structures
|
|
50
|
+
- Business logic flows
|
|
51
|
+
- Architecture decisions
|
|
52
|
+
- Quality requirements
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
DuringImplementation {
|
|
56
|
+
For each task, verify:
|
|
57
|
+
- [ ] Interface contracts match -- Function signatures, parameters, return types
|
|
58
|
+
- [ ] Data structures align -- Schema, types, relationships as specified
|
|
59
|
+
- [ ] Business logic follows -- Defined flows and rules from SDD
|
|
60
|
+
- [ ] Architecture respected -- Patterns, layers, dependencies as designed
|
|
61
|
+
- [ ] Quality met -- Performance, security requirements from SDD
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
PostImplementationValidation {
|
|
65
|
+
After task completion:
|
|
66
|
+
1. Compare implementation to specification
|
|
67
|
+
2. Document any deviations found
|
|
68
|
+
3. Classify deviations by severity
|
|
69
|
+
4. Report compliance status
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
DeviationClassification {
|
|
74
|
+
CriticalDeviations {
|
|
75
|
+
Definition: Must fix before proceeding
|
|
76
|
+
- Interface contract violations
|
|
77
|
+
- Missing required functionality
|
|
78
|
+
- Security requirement breaches
|
|
79
|
+
- Breaking architectural constraints
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
NotableDeviations {
|
|
83
|
+
Definition: Require acknowledgment
|
|
84
|
+
- Implementation differs but functionally equivalent
|
|
85
|
+
- Enhancement beyond specification
|
|
86
|
+
- Simplified approach with same outcome
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
AcceptableVariations {
|
|
90
|
+
Definition: Can proceed
|
|
91
|
+
- Internal implementation details differ
|
|
92
|
+
- Optimizations within spec boundaries
|
|
93
|
+
- Naming/style variations
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
InterfaceVerification {
|
|
98
|
+
APIEndpoints {
|
|
99
|
+
```
|
|
100
|
+
Verifying: POST /api/users
|
|
101
|
+
SDD Spec: Section 4.2.1
|
|
102
|
+
|
|
103
|
+
Request Schema:
|
|
104
|
+
PASS body.email: string (required)
|
|
105
|
+
PASS body.password: string (min 8 chars)
|
|
106
|
+
FAIL body.role: missing (spec requires optional role param)
|
|
107
|
+
|
|
108
|
+
Response Schema:
|
|
109
|
+
PASS 201: { id, email, createdAt }
|
|
110
|
+
PASS 400: { error: string }
|
|
111
|
+
NOTE 409: Added conflict handling (not in spec, beneficial)
|
|
112
|
+
```
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
DataModels {
|
|
116
|
+
```
|
|
117
|
+
Verifying: User Model
|
|
118
|
+
SDD Spec: Section 3.1.2
|
|
119
|
+
|
|
120
|
+
Fields:
|
|
121
|
+
PASS id: UUID (primary key)
|
|
122
|
+
PASS email: string (unique)
|
|
123
|
+
PASS passwordHash: string
|
|
124
|
+
NOTE lastLoginAt: timestamp (added, not in spec)
|
|
125
|
+
FAIL role: enum (missing from implementation)
|
|
126
|
+
|
|
127
|
+
Relationships:
|
|
128
|
+
PASS hasMany: sessions
|
|
129
|
+
PASS belongsTo: organization
|
|
130
|
+
```
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
ArchitectureDecisionVerification {
|
|
135
|
+
Format {
|
|
136
|
+
For each ADR in SDD:
|
|
137
|
+
```
|
|
138
|
+
ADR-1: [Decision Title]
|
|
139
|
+
Implementation Status:
|
|
140
|
+
|
|
141
|
+
Decision: [What was decided]
|
|
142
|
+
Evidence: [Where implemented]
|
|
143
|
+
Compliance: [Matched / Deviated]
|
|
144
|
+
|
|
145
|
+
If deviated:
|
|
146
|
+
Deviation: [What differs]
|
|
147
|
+
Impact: [Consequences]
|
|
148
|
+
Action: [Fix / Accept with rationale]
|
|
149
|
+
```
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
TraceabilityMatrix {
|
|
154
|
+
Build a requirements-to-implementation map:
|
|
155
|
+
```
|
|
156
|
+
+-------------------+-----------------------+--------+
|
|
157
|
+
| Requirement | Implementation | Status |
|
|
158
|
+
+-------------------+-----------------------+--------+
|
|
159
|
+
| PRD-1: User auth | src/auth/login.ts | PASS |
|
|
160
|
+
| PRD-2: Validation | src/validators/*.ts | PASS |
|
|
161
|
+
| SDD-3: Repo layer | src/repositories/*.ts | PASS |
|
|
162
|
+
| SDD-4: Rate limit | NOT FOUND | FAIL |
|
|
163
|
+
+-------------------+-----------------------+--------+
|
|
164
|
+
```
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
ValidationCommands {
|
|
168
|
+
Run these at checkpoints:
|
|
169
|
+
```bash
|
|
170
|
+
# Type checking (if TypeScript)
|
|
171
|
+
npm run typecheck
|
|
172
|
+
|
|
173
|
+
# Linting
|
|
174
|
+
npm run lint
|
|
175
|
+
|
|
176
|
+
# Test suite
|
|
177
|
+
npm test
|
|
178
|
+
|
|
179
|
+
# Build verification
|
|
180
|
+
npm run build
|
|
181
|
+
```
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
ComplianceGates {
|
|
185
|
+
BeforeProceedingToNextPhase {
|
|
186
|
+
All must be true:
|
|
187
|
+
- [ ] All critical deviations resolved
|
|
188
|
+
- [ ] Notable deviations acknowledged by user
|
|
189
|
+
- [ ] Validation commands pass
|
|
190
|
+
- [ ] SDD coverage for phase is complete
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
BeforeFinalCompletion {
|
|
194
|
+
- [ ] All phases compliant
|
|
195
|
+
- [ ] All interfaces verified
|
|
196
|
+
- [ ] All architecture decisions respected
|
|
197
|
+
- [ ] Quality requirements met
|
|
198
|
+
- [ ] User confirmed any variations
|
|
199
|
+
}
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
ReportFormats {
|
|
203
|
+
PerTaskReport {
|
|
204
|
+
```
|
|
205
|
+
Specification Compliance: [Task Name]
|
|
206
|
+
|
|
207
|
+
SDD Reference: Section [X.Y]
|
|
208
|
+
|
|
209
|
+
Requirements Checked:
|
|
210
|
+
PASS Interface: [function/endpoint] matches signature
|
|
211
|
+
PASS Data: [model/schema] matches structure
|
|
212
|
+
PASS Logic: [flow/rule] implemented correctly
|
|
213
|
+
NOTE Enhancement: [description] - beyond spec but compatible
|
|
214
|
+
FAIL Deviation: [description] - requires fix
|
|
215
|
+
|
|
216
|
+
Status: [COMPLIANT / DEVIATION FOUND / NEEDS REVIEW]
|
|
217
|
+
```
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
PhaseCompletionReport {
|
|
221
|
+
```
|
|
222
|
+
Phase [X] Specification Compliance Summary
|
|
223
|
+
|
|
224
|
+
Tasks Validated: [N]
|
|
225
|
+
- Fully Compliant: [X]
|
|
226
|
+
- With Acceptable Variations: [Y]
|
|
227
|
+
- With Notable Deviations: [Z]
|
|
228
|
+
- Critical Issues: [W]
|
|
229
|
+
|
|
230
|
+
SDD Sections Covered:
|
|
231
|
+
- Section 2.1: Compliant
|
|
232
|
+
- Section 2.2: Compliant
|
|
233
|
+
- Section 3.1: Variation documented
|
|
234
|
+
|
|
235
|
+
Critical Issues (if any):
|
|
236
|
+
1. [Description and required fix]
|
|
237
|
+
|
|
238
|
+
Recommendation: [PROCEED / FIX REQUIRED / USER REVIEW]
|
|
239
|
+
```
|
|
240
|
+
}
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
IntegrationWithOtherSkills {
|
|
244
|
+
Works alongside:
|
|
245
|
+
- `skill({ name: "specification-validation" })` -- Comprehensive spec quality checks
|
|
246
|
+
- `skill({ name: "drift-detection" })` -- Spec-implementation alignment monitoring
|
|
247
|
+
- `skill({ name: "constitution-validation" })` -- Governance compliance
|
|
248
|
+
- `skill({ name: "specification-management" })` -- Read spec metadata and locate documents
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
QuickReference {
|
|
252
|
+
AlwaysCheck {
|
|
253
|
+
- Interface signatures match exactly
|
|
254
|
+
- Required fields are present
|
|
255
|
+
- Business logic follows specified flows
|
|
256
|
+
- Architecture patterns are respected
|
|
257
|
+
}
|
|
258
|
+
|
|
259
|
+
DocumentDeviations {
|
|
260
|
+
- What differs from spec
|
|
261
|
+
- Why it differs (if known)
|
|
262
|
+
- Impact assessment
|
|
263
|
+
- Recommended action
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
GateCompliance {
|
|
267
|
+
- Critical = must fix
|
|
268
|
+
- Notable = must acknowledge
|
|
269
|
+
- Acceptable = can proceed
|
|
270
|
+
}
|
|
271
|
+
}
|
|
272
|
+
}
|
|
@@ -0,0 +1,265 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: knowledge-capture
|
|
3
|
+
description: "Capture and organize business rules, technical patterns, and service interfaces discovered during analysis or implementation into structured documentation"
|
|
4
|
+
license: MIT
|
|
5
|
+
compatibility: opencode
|
|
6
|
+
metadata:
|
|
7
|
+
category: documentation
|
|
8
|
+
version: "1.0"
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Knowledge Capture
|
|
12
|
+
|
|
13
|
+
Roleplay as a documentation specialist that captures and organizes knowledge discovered during development work.
|
|
14
|
+
|
|
15
|
+
KnowledgeCapture {
|
|
16
|
+
Activation {
|
|
17
|
+
- Document business rules discovered during analysis or implementation
|
|
18
|
+
- Capture technical patterns found in or applied to the codebase
|
|
19
|
+
- Record service interfaces for external API contracts and integrations
|
|
20
|
+
- Organize domain knowledge for team reference and onboarding
|
|
21
|
+
- Deduplicate documentation to prevent fragmentation
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
Constraints {
|
|
25
|
+
1. Deduplication is critical - Always check first
|
|
26
|
+
2. Categories matter - Business vs Technical vs External
|
|
27
|
+
3. Names are discoverable - Use full, descriptive names
|
|
28
|
+
4. Templates ensure consistency - Follow the structure
|
|
29
|
+
5. Cross-reference liberally - Connect related knowledge
|
|
30
|
+
6. Maintain freshness - Update docs when code changes
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
ReferenceMaterials {
|
|
34
|
+
See `reference/` directory for detailed methodology:
|
|
35
|
+
- [knowledge-capture.md](reference/knowledge-capture.md) -- Advanced categorization, naming conventions, decision matrices, quality standards
|
|
36
|
+
|
|
37
|
+
See `templates/` directory for consistent formatting:
|
|
38
|
+
- [pattern-template.md](templates/pattern-template.md) -- Technical patterns
|
|
39
|
+
- [interface-template.md](templates/interface-template.md) -- External integrations
|
|
40
|
+
- [domain-template.md](templates/domain-template.md) -- Business rules
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
DocumentationStructure {
|
|
44
|
+
All documentation follows this hierarchy:
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
docs/
|
|
48
|
+
domain/ # Business rules, domain logic, workflows, validation rules
|
|
49
|
+
patterns/ # Technical patterns, architectural solutions, code patterns
|
|
50
|
+
interfaces/ # External API contracts, service integrations, webhooks
|
|
51
|
+
```
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
DecisionTree {
|
|
55
|
+
DocsDomain {
|
|
56
|
+
Business rules and domain logic:
|
|
57
|
+
- User permissions and authorization rules
|
|
58
|
+
- Workflow state machines
|
|
59
|
+
- Business validation rules
|
|
60
|
+
- Domain entity behaviors
|
|
61
|
+
- Industry-specific logic
|
|
62
|
+
|
|
63
|
+
Examples:
|
|
64
|
+
- `user-permissions.md` -- Who can do what
|
|
65
|
+
- `order-workflow.md` -- Order state transitions
|
|
66
|
+
- `pricing-rules.md` -- How prices are calculated
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
DocsPatterns {
|
|
70
|
+
Technical and architectural patterns:
|
|
71
|
+
- Code structure patterns
|
|
72
|
+
- Architectural approaches
|
|
73
|
+
- Design patterns in use
|
|
74
|
+
- Data modeling strategies
|
|
75
|
+
- Error handling patterns
|
|
76
|
+
|
|
77
|
+
Examples:
|
|
78
|
+
- `repository-pattern.md` -- Data access abstraction
|
|
79
|
+
- `caching-strategy.md` -- How caching is implemented
|
|
80
|
+
- `error-handling.md` -- Standardized error responses
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
DocsInterfaces {
|
|
84
|
+
External service contracts:
|
|
85
|
+
- Third-party API integrations
|
|
86
|
+
- Webhook specifications
|
|
87
|
+
- External service authentication
|
|
88
|
+
- Data exchange formats
|
|
89
|
+
- Partner integrations
|
|
90
|
+
|
|
91
|
+
Examples:
|
|
92
|
+
- `stripe-api.md` -- Payment processing integration
|
|
93
|
+
- `sendgrid-webhooks.md` -- Email event handling
|
|
94
|
+
- `oauth-providers.md` -- Authentication integrations
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
Workflow {
|
|
99
|
+
Step0_Deduplication {
|
|
100
|
+
REQUIRED - DO THIS FIRST
|
|
101
|
+
|
|
102
|
+
Always check for existing documentation before creating new files:
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
# Search for existing documentation
|
|
106
|
+
grep -ri "main keyword" docs/domain/ docs/patterns/ docs/interfaces/
|
|
107
|
+
find docs -name "*topic-keyword*"
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
DecisionTree:
|
|
111
|
+
- Found similar documentation --> Use edit to UPDATE existing file instead
|
|
112
|
+
- Found NO similar documentation --> Proceed to Step 1 (Determine Category)
|
|
113
|
+
|
|
114
|
+
Critical: Always prefer updating existing files over creating new ones.
|
|
115
|
+
Deduplication prevents documentation fragmentation.
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
Step1_DetermineCategory {
|
|
119
|
+
Ask yourself:
|
|
120
|
+
- Is this about business logic? --> `docs/domain/`
|
|
121
|
+
- Is this about how we build? --> `docs/patterns/`
|
|
122
|
+
- Is this about external services? --> `docs/interfaces/`
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
Step2_ChooseCreateOrUpdate {
|
|
126
|
+
Create new if:
|
|
127
|
+
- No related documentation exists
|
|
128
|
+
- Topic is distinct enough to warrant separation
|
|
129
|
+
- Would create confusion to merge with existing doc
|
|
130
|
+
|
|
131
|
+
Update existing if:
|
|
132
|
+
- Related documentation already exists
|
|
133
|
+
- New info enhances existing document
|
|
134
|
+
- Same category and closely related topic
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
Step3_UseDescriptiveSearchableNames {
|
|
138
|
+
Good names:
|
|
139
|
+
- `authentication-flow.md` (clear, searchable)
|
|
140
|
+
- `database-migration-strategy.md` (specific)
|
|
141
|
+
- `stripe-payment-integration.md` (exact)
|
|
142
|
+
|
|
143
|
+
Bad names:
|
|
144
|
+
- `auth.md` (too vague)
|
|
145
|
+
- `db.md` (unclear)
|
|
146
|
+
- `api.md` (which API?)
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
Step4_FollowTemplateStructure {
|
|
150
|
+
Use the templates in `templates/` for consistent formatting:
|
|
151
|
+
- `pattern-template.md` -- For technical patterns
|
|
152
|
+
- `interface-template.md` -- For external integrations
|
|
153
|
+
- `domain-template.md` -- For business rules
|
|
154
|
+
}
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
DocumentStructureStandards {
|
|
158
|
+
Every document should include:
|
|
159
|
+
|
|
160
|
+
1. **Title and Purpose** -- What this documents
|
|
161
|
+
2. **Context** -- When/why this applies
|
|
162
|
+
3. **Details** -- The actual content (patterns, rules, contracts)
|
|
163
|
+
4. **Examples** -- Code snippets or scenarios
|
|
164
|
+
5. **References** -- Related docs or external links
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
DeduplicationProtocol {
|
|
168
|
+
Before creating any documentation:
|
|
169
|
+
|
|
170
|
+
1. **Search by topic**: `grep -ri "topic" docs/`
|
|
171
|
+
2. **Check category**: List files in target category
|
|
172
|
+
3. **Read related files**: Verify no overlap
|
|
173
|
+
4. **Decide**: Create new vs enhance existing
|
|
174
|
+
5. **Cross-reference**: Link between related docs
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
GrayAreasAndEdgeCases {
|
|
178
|
+
WhenBusinessAndTechnicalOverlap {
|
|
179
|
+
Authentication Example:
|
|
180
|
+
- `docs/domain/user-roles.md` -- WHO can access WHAT (business rule)
|
|
181
|
+
- `docs/patterns/authentication-flow.md` -- HOW authentication works (technical)
|
|
182
|
+
- `docs/interfaces/oauth-providers.md` -- EXTERNAL services used (integration)
|
|
183
|
+
|
|
184
|
+
Guideline: If it affects WHAT users can do, it belongs in domain.
|
|
185
|
+
If it affects HOW we build it, it belongs in patterns.
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
WhenMultipleCategoriesApply {
|
|
189
|
+
Create separate documents for each perspective.
|
|
190
|
+
Cross-reference heavily.
|
|
191
|
+
}
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
CrossReferencing {
|
|
195
|
+
When documentation relates to other docs:
|
|
196
|
+
|
|
197
|
+
```markdown
|
|
198
|
+
## Related Documentation
|
|
199
|
+
|
|
200
|
+
- [Authentication Flow](../patterns/authentication-flow.md) - Technical implementation
|
|
201
|
+
- [OAuth Providers](../interfaces/oauth-providers.md) - External integrations
|
|
202
|
+
- [User Permissions](../domain/user-permissions.md) - Business rules
|
|
203
|
+
```
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
DocumentationMaintenance {
|
|
207
|
+
StalenessDetection {
|
|
208
|
+
Check for stale documentation when modifying code:
|
|
209
|
+
|
|
210
|
+
1. Git-based staleness: Compare doc and code modification times
|
|
211
|
+
- If source file changed after related doc, flag for review
|
|
212
|
+
|
|
213
|
+
2. Reference validation: Verify documented items still exist
|
|
214
|
+
- Function names, API endpoints, configuration options
|
|
215
|
+
|
|
216
|
+
3. Example validation: Confirm code examples still work
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
StalenessCategories {
|
|
220
|
+
| Category | Indicator | Action |
|
|
221
|
+
|----------|-----------|--------|
|
|
222
|
+
| Critical | Code changed, doc not updated | Update immediately |
|
|
223
|
+
| Warning | > 90 days since doc update | Review needed |
|
|
224
|
+
| Info | > 180 days since update | Consider refresh |
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
SyncDuringImplementation {
|
|
228
|
+
When modifying code, proactively check documentation impact:
|
|
229
|
+
|
|
230
|
+
Function signature changes --> Update JSDoc/docstrings and API docs
|
|
231
|
+
New public API --> Create documentation before PR
|
|
232
|
+
Breaking changes --> Update all references, add migration notes
|
|
233
|
+
}
|
|
234
|
+
}
|
|
235
|
+
|
|
236
|
+
QualityChecklist {
|
|
237
|
+
Before finalizing any documentation:
|
|
238
|
+
|
|
239
|
+
- [ ] Checked for existing related documentation
|
|
240
|
+
- [ ] Chosen correct category (domain/patterns/interfaces)
|
|
241
|
+
- [ ] Used descriptive, searchable filename
|
|
242
|
+
- [ ] Included title, context, details, examples
|
|
243
|
+
- [ ] Added cross-references to related docs
|
|
244
|
+
- [ ] Used appropriate template structure
|
|
245
|
+
- [ ] Verified no duplicate content
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
IntegrationWithOtherSkills {
|
|
249
|
+
Works alongside:
|
|
250
|
+
- `skill({ name: "documentation-sync" })` -- Keeping documentation in sync with code changes
|
|
251
|
+
- `skill({ name: "codebase-analysis" })` -- Discovering patterns and knowledge during analysis
|
|
252
|
+
- `skill({ name: "specification-management" })` -- Referencing specifications from documentation
|
|
253
|
+
}
|
|
254
|
+
|
|
255
|
+
OutputFormat {
|
|
256
|
+
After documenting, always report:
|
|
257
|
+
|
|
258
|
+
```
|
|
259
|
+
Documentation Created/Updated:
|
|
260
|
+
- docs/[category]/[filename].md
|
|
261
|
+
Purpose: [Brief description]
|
|
262
|
+
Action: [Created new / Updated existing / Merged with existing]
|
|
263
|
+
```
|
|
264
|
+
}
|
|
265
|
+
}
|