@cluesmith/codev 1.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/bin/af.js +8 -0
- package/bin/codev.js +4 -0
- package/bin/consult.js +7 -0
- package/dist/agent-farm/cli.d.ts +11 -0
- package/dist/agent-farm/cli.d.ts.map +1 -0
- package/dist/agent-farm/cli.js +359 -0
- package/dist/agent-farm/cli.js.map +1 -0
- package/dist/agent-farm/commands/cleanup.d.ts +12 -0
- package/dist/agent-farm/commands/cleanup.d.ts.map +1 -0
- package/dist/agent-farm/commands/cleanup.js +154 -0
- package/dist/agent-farm/commands/cleanup.js.map +1 -0
- package/dist/agent-farm/commands/db.d.ts +38 -0
- package/dist/agent-farm/commands/db.d.ts.map +1 -0
- package/dist/agent-farm/commands/db.js +133 -0
- package/dist/agent-farm/commands/db.js.map +1 -0
- package/dist/agent-farm/commands/index.d.ts +11 -0
- package/dist/agent-farm/commands/index.d.ts.map +1 -0
- package/dist/agent-farm/commands/index.js +11 -0
- package/dist/agent-farm/commands/index.js.map +1 -0
- package/dist/agent-farm/commands/open.d.ts +15 -0
- package/dist/agent-farm/commands/open.d.ts.map +1 -0
- package/dist/agent-farm/commands/open.js +118 -0
- package/dist/agent-farm/commands/open.js.map +1 -0
- package/dist/agent-farm/commands/rename.d.ts +13 -0
- package/dist/agent-farm/commands/rename.d.ts.map +1 -0
- package/dist/agent-farm/commands/rename.js +33 -0
- package/dist/agent-farm/commands/rename.js.map +1 -0
- package/dist/agent-farm/commands/send.d.ts +9 -0
- package/dist/agent-farm/commands/send.d.ts.map +1 -0
- package/dist/agent-farm/commands/send.js +282 -0
- package/dist/agent-farm/commands/send.js.map +1 -0
- package/dist/agent-farm/commands/spawn.d.ts +15 -0
- package/dist/agent-farm/commands/spawn.d.ts.map +1 -0
- package/dist/agent-farm/commands/spawn.js +575 -0
- package/dist/agent-farm/commands/spawn.js.map +1 -0
- package/dist/agent-farm/commands/start.d.ts +9 -0
- package/dist/agent-farm/commands/start.d.ts.map +1 -0
- package/dist/agent-farm/commands/start.js +175 -0
- package/dist/agent-farm/commands/start.js.map +1 -0
- package/dist/agent-farm/commands/status.d.ts +8 -0
- package/dist/agent-farm/commands/status.d.ts.map +1 -0
- package/dist/agent-farm/commands/status.js +123 -0
- package/dist/agent-farm/commands/status.js.map +1 -0
- package/dist/agent-farm/commands/stop.d.ts +8 -0
- package/dist/agent-farm/commands/stop.d.ts.map +1 -0
- package/dist/agent-farm/commands/stop.js +76 -0
- package/dist/agent-farm/commands/stop.js.map +1 -0
- package/dist/agent-farm/commands/tower.d.ts +19 -0
- package/dist/agent-farm/commands/tower.d.ts.map +1 -0
- package/dist/agent-farm/commands/tower.js +125 -0
- package/dist/agent-farm/commands/tower.js.map +1 -0
- package/dist/agent-farm/commands/tutorial.d.ts +10 -0
- package/dist/agent-farm/commands/tutorial.d.ts.map +1 -0
- package/dist/agent-farm/commands/tutorial.js +49 -0
- package/dist/agent-farm/commands/tutorial.js.map +1 -0
- package/dist/agent-farm/commands/util.d.ts +15 -0
- package/dist/agent-farm/commands/util.d.ts.map +1 -0
- package/dist/agent-farm/commands/util.js +108 -0
- package/dist/agent-farm/commands/util.js.map +1 -0
- package/dist/agent-farm/db/errors.d.ts +17 -0
- package/dist/agent-farm/db/errors.d.ts.map +1 -0
- package/dist/agent-farm/db/errors.js +46 -0
- package/dist/agent-farm/db/errors.js.map +1 -0
- package/dist/agent-farm/db/index.d.ts +41 -0
- package/dist/agent-farm/db/index.d.ts.map +1 -0
- package/dist/agent-farm/db/index.js +168 -0
- package/dist/agent-farm/db/index.js.map +1 -0
- package/dist/agent-farm/db/migrate.d.ts +15 -0
- package/dist/agent-farm/db/migrate.d.ts.map +1 -0
- package/dist/agent-farm/db/migrate.js +137 -0
- package/dist/agent-farm/db/migrate.js.map +1 -0
- package/dist/agent-farm/db/schema.d.ts +16 -0
- package/dist/agent-farm/db/schema.d.ts.map +1 -0
- package/dist/agent-farm/db/schema.js +103 -0
- package/dist/agent-farm/db/schema.js.map +1 -0
- package/dist/agent-farm/db/types.d.ts +87 -0
- package/dist/agent-farm/db/types.d.ts.map +1 -0
- package/dist/agent-farm/db/types.js +65 -0
- package/dist/agent-farm/db/types.js.map +1 -0
- package/dist/agent-farm/index.d.ts +7 -0
- package/dist/agent-farm/index.d.ts.map +1 -0
- package/dist/agent-farm/index.js +373 -0
- package/dist/agent-farm/index.js.map +1 -0
- package/dist/agent-farm/servers/annotate-server.d.ts +9 -0
- package/dist/agent-farm/servers/annotate-server.d.ts.map +1 -0
- package/dist/agent-farm/servers/annotate-server.js +136 -0
- package/dist/agent-farm/servers/annotate-server.js.map +1 -0
- package/dist/agent-farm/servers/dashboard-server.d.ts +9 -0
- package/dist/agent-farm/servers/dashboard-server.d.ts.map +1 -0
- package/dist/agent-farm/servers/dashboard-server.js +939 -0
- package/dist/agent-farm/servers/dashboard-server.js.map +1 -0
- package/dist/agent-farm/servers/tower-server.d.ts +9 -0
- package/dist/agent-farm/servers/tower-server.d.ts.map +1 -0
- package/dist/agent-farm/servers/tower-server.js +463 -0
- package/dist/agent-farm/servers/tower-server.js.map +1 -0
- package/dist/agent-farm/state.d.ts +93 -0
- package/dist/agent-farm/state.d.ts.map +1 -0
- package/dist/agent-farm/state.js +253 -0
- package/dist/agent-farm/state.js.map +1 -0
- package/dist/agent-farm/tutorial/index.d.ts +8 -0
- package/dist/agent-farm/tutorial/index.d.ts.map +1 -0
- package/dist/agent-farm/tutorial/index.js +8 -0
- package/dist/agent-farm/tutorial/index.js.map +1 -0
- package/dist/agent-farm/tutorial/prompts.d.ts +57 -0
- package/dist/agent-farm/tutorial/prompts.d.ts.map +1 -0
- package/dist/agent-farm/tutorial/prompts.js +147 -0
- package/dist/agent-farm/tutorial/prompts.js.map +1 -0
- package/dist/agent-farm/tutorial/runner.d.ts +52 -0
- package/dist/agent-farm/tutorial/runner.d.ts.map +1 -0
- package/dist/agent-farm/tutorial/runner.js +204 -0
- package/dist/agent-farm/tutorial/runner.js.map +1 -0
- package/dist/agent-farm/tutorial/state.d.ts +26 -0
- package/dist/agent-farm/tutorial/state.d.ts.map +1 -0
- package/dist/agent-farm/tutorial/state.js +89 -0
- package/dist/agent-farm/tutorial/state.js.map +1 -0
- package/dist/agent-farm/tutorial/steps/first-spec.d.ts +7 -0
- package/dist/agent-farm/tutorial/steps/first-spec.d.ts.map +1 -0
- package/dist/agent-farm/tutorial/steps/first-spec.js +136 -0
- package/dist/agent-farm/tutorial/steps/first-spec.js.map +1 -0
- package/dist/agent-farm/tutorial/steps/implementation.d.ts +7 -0
- package/dist/agent-farm/tutorial/steps/implementation.d.ts.map +1 -0
- package/dist/agent-farm/tutorial/steps/implementation.js +76 -0
- package/dist/agent-farm/tutorial/steps/implementation.js.map +1 -0
- package/dist/agent-farm/tutorial/steps/index.d.ts +10 -0
- package/dist/agent-farm/tutorial/steps/index.d.ts.map +1 -0
- package/dist/agent-farm/tutorial/steps/index.js +10 -0
- package/dist/agent-farm/tutorial/steps/index.js.map +1 -0
- package/dist/agent-farm/tutorial/steps/planning.d.ts +7 -0
- package/dist/agent-farm/tutorial/steps/planning.d.ts.map +1 -0
- package/dist/agent-farm/tutorial/steps/planning.js +143 -0
- package/dist/agent-farm/tutorial/steps/planning.js.map +1 -0
- package/dist/agent-farm/tutorial/steps/review.d.ts +7 -0
- package/dist/agent-farm/tutorial/steps/review.d.ts.map +1 -0
- package/dist/agent-farm/tutorial/steps/review.js +78 -0
- package/dist/agent-farm/tutorial/steps/review.js.map +1 -0
- package/dist/agent-farm/tutorial/steps/setup.d.ts +7 -0
- package/dist/agent-farm/tutorial/steps/setup.d.ts.map +1 -0
- package/dist/agent-farm/tutorial/steps/setup.js +126 -0
- package/dist/agent-farm/tutorial/steps/setup.js.map +1 -0
- package/dist/agent-farm/tutorial/steps/welcome.d.ts +7 -0
- package/dist/agent-farm/tutorial/steps/welcome.d.ts.map +1 -0
- package/dist/agent-farm/tutorial/steps/welcome.js +50 -0
- package/dist/agent-farm/tutorial/steps/welcome.js.map +1 -0
- package/dist/agent-farm/types.d.ts +131 -0
- package/dist/agent-farm/types.d.ts.map +1 -0
- package/dist/agent-farm/types.js +5 -0
- package/dist/agent-farm/types.js.map +1 -0
- package/dist/agent-farm/utils/config.d.ts +27 -0
- package/dist/agent-farm/utils/config.d.ts.map +1 -0
- package/dist/agent-farm/utils/config.js +242 -0
- package/dist/agent-farm/utils/config.js.map +1 -0
- package/dist/agent-farm/utils/deps.d.ts +51 -0
- package/dist/agent-farm/utils/deps.d.ts.map +1 -0
- package/dist/agent-farm/utils/deps.js +194 -0
- package/dist/agent-farm/utils/deps.js.map +1 -0
- package/dist/agent-farm/utils/index.d.ts +6 -0
- package/dist/agent-farm/utils/index.d.ts.map +1 -0
- package/dist/agent-farm/utils/index.js +6 -0
- package/dist/agent-farm/utils/index.js.map +1 -0
- package/dist/agent-farm/utils/logger.d.ts +31 -0
- package/dist/agent-farm/utils/logger.d.ts.map +1 -0
- package/dist/agent-farm/utils/logger.js +58 -0
- package/dist/agent-farm/utils/logger.js.map +1 -0
- package/dist/agent-farm/utils/orphan-handler.d.ts +27 -0
- package/dist/agent-farm/utils/orphan-handler.d.ts.map +1 -0
- package/dist/agent-farm/utils/orphan-handler.js +127 -0
- package/dist/agent-farm/utils/orphan-handler.js.map +1 -0
- package/dist/agent-farm/utils/port-registry.d.ts +58 -0
- package/dist/agent-farm/utils/port-registry.d.ts.map +1 -0
- package/dist/agent-farm/utils/port-registry.js +149 -0
- package/dist/agent-farm/utils/port-registry.js.map +1 -0
- package/dist/agent-farm/utils/shell.d.ts +45 -0
- package/dist/agent-farm/utils/shell.d.ts.map +1 -0
- package/dist/agent-farm/utils/shell.js +120 -0
- package/dist/agent-farm/utils/shell.js.map +1 -0
- package/dist/cli.d.ts +10 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +160 -0
- package/dist/cli.js.map +1 -0
- package/dist/commands/adopt.d.ts +12 -0
- package/dist/commands/adopt.d.ts.map +1 -0
- package/dist/commands/adopt.js +178 -0
- package/dist/commands/adopt.js.map +1 -0
- package/dist/commands/consult/index.d.ts +17 -0
- package/dist/commands/consult/index.d.ts.map +1 -0
- package/dist/commands/consult/index.js +405 -0
- package/dist/commands/consult/index.js.map +1 -0
- package/dist/commands/doctor.d.ts +10 -0
- package/dist/commands/doctor.d.ts.map +1 -0
- package/dist/commands/doctor.js +346 -0
- package/dist/commands/doctor.js.map +1 -0
- package/dist/commands/init.d.ts +12 -0
- package/dist/commands/init.d.ts.map +1 -0
- package/dist/commands/init.js +167 -0
- package/dist/commands/init.js.map +1 -0
- package/dist/commands/tower.d.ts +16 -0
- package/dist/commands/tower.d.ts.map +1 -0
- package/dist/commands/tower.js +21 -0
- package/dist/commands/tower.js.map +1 -0
- package/dist/commands/update.d.ts +13 -0
- package/dist/commands/update.d.ts.map +1 -0
- package/dist/commands/update.js +137 -0
- package/dist/commands/update.js.map +1 -0
- package/dist/lib/templates.d.ts +57 -0
- package/dist/lib/templates.d.ts.map +1 -0
- package/dist/lib/templates.js +205 -0
- package/dist/lib/templates.js.map +1 -0
- package/package.json +55 -0
- package/templates/AGENTS.md +49 -0
- package/templates/CLAUDE.md +47 -0
- package/templates/DEPENDENCIES.md +344 -0
- package/templates/agents/architecture-documenter.md +189 -0
- package/templates/agents/codev-updater.md +276 -0
- package/templates/agents/spider-protocol-updater.md +118 -0
- package/templates/annotate.html +903 -0
- package/templates/bin/agent-farm +18 -0
- package/templates/bin/annotate-server.js +140 -0
- package/templates/bin/codev-doctor +335 -0
- package/templates/builders.md +30 -0
- package/templates/config.json +7 -0
- package/templates/dashboard-split.html +1679 -0
- package/templates/dashboard.html +149 -0
- package/templates/plans/.gitkeep +0 -0
- package/templates/protocols/experiment/protocol.md +229 -0
- package/templates/protocols/experiment/templates/notes.md +97 -0
- package/templates/protocols/maintain/protocol.md +235 -0
- package/templates/protocols/spider/protocol.md +639 -0
- package/templates/protocols/spider/templates/plan.md +169 -0
- package/templates/protocols/spider/templates/review.md +207 -0
- package/templates/protocols/spider/templates/spec.md +140 -0
- package/templates/protocols/spider-solo/protocol.md +619 -0
- package/templates/protocols/spider-solo/templates/plan.md +169 -0
- package/templates/protocols/spider-solo/templates/review.md +207 -0
- package/templates/protocols/spider-solo/templates/spec.md +140 -0
- package/templates/protocols/tick/protocol.md +250 -0
- package/templates/protocols/tick/templates/plan.md +67 -0
- package/templates/protocols/tick/templates/review.md +90 -0
- package/templates/protocols/tick/templates/spec.md +61 -0
- package/templates/reviews/.gitkeep +0 -0
- package/templates/roles/architect.md +230 -0
- package/templates/roles/builder.md +175 -0
- package/templates/roles/consultant.md +27 -0
- package/templates/specs/.gitkeep +0 -0
- package/templates/templates/projectlist.md +129 -0
- package/templates/tower.html +1032 -0
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
# Plan: [Title]
|
|
2
|
+
|
|
3
|
+
## Metadata
|
|
4
|
+
- **ID**: plan-[YYYY-MM-DD]-[short-name]
|
|
5
|
+
- **Status**: draft
|
|
6
|
+
- **Specification**: [Link to codev/specs/spec-file.md]
|
|
7
|
+
- **Created**: [YYYY-MM-DD]
|
|
8
|
+
|
|
9
|
+
## Executive Summary
|
|
10
|
+
[Brief overview of the implementation approach chosen and why. Reference the specification's selected approach.]
|
|
11
|
+
|
|
12
|
+
## Success Metrics
|
|
13
|
+
[Copy from specification and add implementation-specific metrics]
|
|
14
|
+
- [ ] All specification criteria met
|
|
15
|
+
- [ ] Test coverage >90%
|
|
16
|
+
- [ ] Performance benchmarks achieved
|
|
17
|
+
- [ ] Zero critical security issues
|
|
18
|
+
- [ ] Documentation complete
|
|
19
|
+
|
|
20
|
+
## Phase Breakdown
|
|
21
|
+
|
|
22
|
+
### Phase 1: [Descriptive Name]
|
|
23
|
+
**Dependencies**: None
|
|
24
|
+
|
|
25
|
+
#### Objectives
|
|
26
|
+
- [Clear, single objective for this phase]
|
|
27
|
+
- [What value does this phase deliver?]
|
|
28
|
+
|
|
29
|
+
#### Deliverables
|
|
30
|
+
- [ ] [Specific deliverable 1]
|
|
31
|
+
- [ ] [Specific deliverable 2]
|
|
32
|
+
- [ ] [Tests for this phase]
|
|
33
|
+
- [ ] [Documentation updates]
|
|
34
|
+
|
|
35
|
+
#### Implementation Details
|
|
36
|
+
[Specific technical approach for this phase. Include:
|
|
37
|
+
- Key files/modules to create or modify
|
|
38
|
+
- Architectural decisions
|
|
39
|
+
- API contracts
|
|
40
|
+
- Data models]
|
|
41
|
+
|
|
42
|
+
#### Acceptance Criteria
|
|
43
|
+
- [ ] [Testable criterion 1]
|
|
44
|
+
- [ ] [Testable criterion 2]
|
|
45
|
+
- [ ] All tests pass
|
|
46
|
+
- [ ] Code review completed
|
|
47
|
+
|
|
48
|
+
#### Test Plan
|
|
49
|
+
- **Unit Tests**: [What to test]
|
|
50
|
+
- **Integration Tests**: [What to test]
|
|
51
|
+
- **Manual Testing**: [Scenarios to verify]
|
|
52
|
+
|
|
53
|
+
#### Rollback Strategy
|
|
54
|
+
[How to revert this phase if issues arise]
|
|
55
|
+
|
|
56
|
+
#### Risks
|
|
57
|
+
- **Risk**: [Specific risk for this phase]
|
|
58
|
+
- **Mitigation**: [How to address]
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
### Phase 2: [Descriptive Name]
|
|
63
|
+
**Dependencies**: Phase 1
|
|
64
|
+
|
|
65
|
+
[Repeat structure for each phase]
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
### Phase 3: [Descriptive Name]
|
|
70
|
+
**Dependencies**: Phase 2
|
|
71
|
+
|
|
72
|
+
[Continue for all phases]
|
|
73
|
+
|
|
74
|
+
## Dependency Map
|
|
75
|
+
```
|
|
76
|
+
Phase 1 ──→ Phase 2 ──→ Phase 3
|
|
77
|
+
↓
|
|
78
|
+
Phase 4 (optional)
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Resource Requirements
|
|
82
|
+
### Development Resources
|
|
83
|
+
- **Engineers**: [Expertise needed]
|
|
84
|
+
- **Environment**: [Dev/staging requirements]
|
|
85
|
+
|
|
86
|
+
### Infrastructure
|
|
87
|
+
- [Database changes]
|
|
88
|
+
- [New services]
|
|
89
|
+
- [Configuration updates]
|
|
90
|
+
- [Monitoring additions]
|
|
91
|
+
|
|
92
|
+
## Integration Points
|
|
93
|
+
### External Systems
|
|
94
|
+
- **System**: [Name]
|
|
95
|
+
- **Integration Type**: [API/Database/Message Queue]
|
|
96
|
+
- **Phase**: [Which phase needs this]
|
|
97
|
+
- **Fallback**: [What if unavailable]
|
|
98
|
+
|
|
99
|
+
### Internal Systems
|
|
100
|
+
[Repeat structure]
|
|
101
|
+
|
|
102
|
+
## Risk Analysis
|
|
103
|
+
### Technical Risks
|
|
104
|
+
| Risk | Probability | Impact | Mitigation | Owner |
|
|
105
|
+
|------|------------|--------|------------|-------|
|
|
106
|
+
| [Risk 1] | L/M/H | L/M/H | [Strategy] | [Name] |
|
|
107
|
+
|
|
108
|
+
### Schedule Risks
|
|
109
|
+
| Risk | Probability | Impact | Mitigation | Owner |
|
|
110
|
+
|------|------------|--------|------------|-------|
|
|
111
|
+
| [Risk 1] | L/M/H | L/M/H | [Strategy] | [Name] |
|
|
112
|
+
|
|
113
|
+
## Validation Checkpoints
|
|
114
|
+
1. **After Phase 1**: [What to validate]
|
|
115
|
+
2. **After Phase 2**: [What to validate]
|
|
116
|
+
3. **Before Production**: [Final checks]
|
|
117
|
+
|
|
118
|
+
## Monitoring and Observability
|
|
119
|
+
### Metrics to Track
|
|
120
|
+
- [Metric 1: Description and threshold]
|
|
121
|
+
- [Metric 2: Description and threshold]
|
|
122
|
+
|
|
123
|
+
### Logging Requirements
|
|
124
|
+
- [What to log and at what level]
|
|
125
|
+
- [Retention requirements]
|
|
126
|
+
|
|
127
|
+
### Alerting
|
|
128
|
+
- [Alert condition and severity]
|
|
129
|
+
- [Who to notify]
|
|
130
|
+
|
|
131
|
+
## Documentation Updates Required
|
|
132
|
+
- [ ] API documentation
|
|
133
|
+
- [ ] Architecture diagrams
|
|
134
|
+
- [ ] Runbooks
|
|
135
|
+
- [ ] User guides
|
|
136
|
+
- [ ] Configuration guides
|
|
137
|
+
|
|
138
|
+
## Post-Implementation Tasks
|
|
139
|
+
- [ ] Performance validation
|
|
140
|
+
- [ ] Security audit
|
|
141
|
+
- [ ] Load testing
|
|
142
|
+
- [ ] User acceptance testing
|
|
143
|
+
- [ ] Monitoring validation
|
|
144
|
+
|
|
145
|
+
## Expert Review
|
|
146
|
+
**Date**: [YYYY-MM-DD]
|
|
147
|
+
**Model**: [Model consulted]
|
|
148
|
+
**Key Feedback**:
|
|
149
|
+
- [Feasibility assessment]
|
|
150
|
+
- [Missing considerations]
|
|
151
|
+
- [Risk identification]
|
|
152
|
+
- [Alternative suggestions]
|
|
153
|
+
|
|
154
|
+
**Plan Adjustments**:
|
|
155
|
+
- [How the plan was modified based on feedback]
|
|
156
|
+
|
|
157
|
+
## Approval
|
|
158
|
+
- [ ] Technical Lead Review
|
|
159
|
+
- [ ] Engineering Manager Approval
|
|
160
|
+
- [ ] Resource Allocation Confirmed
|
|
161
|
+
- [ ] Expert AI Consultation Complete
|
|
162
|
+
|
|
163
|
+
## Change Log
|
|
164
|
+
| Date | Change | Reason | Author |
|
|
165
|
+
|------|--------|--------|--------|
|
|
166
|
+
| [Date] | [What changed] | [Why] | [Who] |
|
|
167
|
+
|
|
168
|
+
## Notes
|
|
169
|
+
[Additional context, assumptions, or considerations]
|
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
# Review: [Feature/Project Name]
|
|
2
|
+
|
|
3
|
+
## Metadata
|
|
4
|
+
- **Date**: [YYYY-MM-DD]
|
|
5
|
+
- **Specification**: [Link to codev/specs/spec-file.md]
|
|
6
|
+
- **Plan**: [Link to codev/plans/plan-file.md]
|
|
7
|
+
|
|
8
|
+
## Executive Summary
|
|
9
|
+
[Brief overview of what was built, how it went, and key outcomes]
|
|
10
|
+
|
|
11
|
+
## Specification Compliance
|
|
12
|
+
|
|
13
|
+
### Success Criteria Assessment
|
|
14
|
+
| Criterion | Status | Evidence | Notes |
|
|
15
|
+
|-----------|--------|----------|-------|
|
|
16
|
+
| [Criterion 1] | ✅/❌/⚠️ | [Link/description] | [Any context] |
|
|
17
|
+
| [Criterion 2] | ✅/❌/⚠️ | [Link/description] | [Any context] |
|
|
18
|
+
| [All tests pass >90% coverage] | ✅/❌/⚠️ | [Coverage report] | [Details] |
|
|
19
|
+
| [Performance benchmarks met] | ✅/❌/⚠️ | [Metrics] | [Details] |
|
|
20
|
+
|
|
21
|
+
### Deviations from Specification
|
|
22
|
+
| Original Requirement | What Was Built | Reason for Deviation |
|
|
23
|
+
|---------------------|----------------|---------------------|
|
|
24
|
+
| [If any] | [Actual] | [Justification] |
|
|
25
|
+
|
|
26
|
+
## Plan Execution Review
|
|
27
|
+
|
|
28
|
+
### Phase Completion
|
|
29
|
+
| Phase | Status | Notes |
|
|
30
|
+
|-------|--------|-------|
|
|
31
|
+
| Phase 1 | Complete | [Context] |
|
|
32
|
+
| Phase 2 | Complete | [Context] |
|
|
33
|
+
|
|
34
|
+
### Deliverables Checklist
|
|
35
|
+
- [x] All planned features implemented
|
|
36
|
+
- [x] Test coverage achieved
|
|
37
|
+
- [x] Documentation updated
|
|
38
|
+
- [x] Performance requirements met
|
|
39
|
+
- [ ] [Any incomplete items]
|
|
40
|
+
|
|
41
|
+
## Code Quality Assessment
|
|
42
|
+
|
|
43
|
+
### Architecture Impact
|
|
44
|
+
- **Positive Changes**: [Improvements made to architecture]
|
|
45
|
+
- **Technical Debt Incurred**: [Any shortcuts taken]
|
|
46
|
+
- **Future Considerations**: [What should be refactored later]
|
|
47
|
+
|
|
48
|
+
### Code Metrics
|
|
49
|
+
- **Lines of Code**: [Added/Modified/Removed]
|
|
50
|
+
- **Test Coverage**: [Percentage and areas covered]
|
|
51
|
+
- **Code Complexity**: [Cyclomatic complexity if measured]
|
|
52
|
+
- **Documentation Coverage**: [Public APIs documented?]
|
|
53
|
+
|
|
54
|
+
### Security Review
|
|
55
|
+
- **Vulnerabilities Found**: [None/List]
|
|
56
|
+
- **Security Best Practices**: [Followed/Exceptions]
|
|
57
|
+
- **Sensitive Data Handling**: [Properly secured?]
|
|
58
|
+
|
|
59
|
+
## Performance Analysis
|
|
60
|
+
|
|
61
|
+
### Benchmarks
|
|
62
|
+
| Metric | Target | Achieved | Status |
|
|
63
|
+
|--------|--------|----------|---------|
|
|
64
|
+
| Response Time (p95) | <200ms | [Actual] | ✅/❌ |
|
|
65
|
+
| Throughput | 1000 rps | [Actual] | ✅/❌ |
|
|
66
|
+
| Memory Usage | <500MB | [Actual] | ✅/❌ |
|
|
67
|
+
|
|
68
|
+
### Load Testing Results
|
|
69
|
+
[Summary of load testing outcomes, if performed]
|
|
70
|
+
|
|
71
|
+
## Testing Summary
|
|
72
|
+
|
|
73
|
+
### Test Execution
|
|
74
|
+
- **Unit Tests**: [X passed, Y failed]
|
|
75
|
+
- **Integration Tests**: [X passed, Y failed]
|
|
76
|
+
- **E2E Tests**: [X passed, Y failed]
|
|
77
|
+
- **Manual Testing**: [Scenarios tested]
|
|
78
|
+
|
|
79
|
+
### Issues Found During Testing
|
|
80
|
+
| Issue | Severity | Resolution |
|
|
81
|
+
|-------|----------|------------|
|
|
82
|
+
| [Bug 1] | Critical/High/Medium/Low | [Fixed/Deferred] |
|
|
83
|
+
|
|
84
|
+
## Lessons Learned
|
|
85
|
+
|
|
86
|
+
### What Went Well
|
|
87
|
+
1. [Success point 1 - be specific]
|
|
88
|
+
2. [Success point 2 - include why it worked]
|
|
89
|
+
3. [Success point 3 - note for future replication]
|
|
90
|
+
|
|
91
|
+
### What Was Challenging
|
|
92
|
+
1. [Challenge 1 - describe the issue]
|
|
93
|
+
- **Root Cause**: [Why it happened]
|
|
94
|
+
- **Resolution**: [How it was addressed]
|
|
95
|
+
- **Prevention**: [How to avoid in future]
|
|
96
|
+
|
|
97
|
+
2. [Challenge 2]
|
|
98
|
+
- **Root Cause**:
|
|
99
|
+
- **Resolution**:
|
|
100
|
+
- **Prevention**:
|
|
101
|
+
|
|
102
|
+
### What Would You Do Differently
|
|
103
|
+
1. [Improvement 1 - be actionable]
|
|
104
|
+
2. [Improvement 2 - be specific]
|
|
105
|
+
3. [Improvement 3 - be realistic]
|
|
106
|
+
|
|
107
|
+
## Methodology Feedback
|
|
108
|
+
|
|
109
|
+
### SP(IDE)R Protocol Effectiveness
|
|
110
|
+
- **Specification Phase**: [Was it thorough enough? Too detailed?]
|
|
111
|
+
- **Planning Phase**: [Were estimates accurate? Phases well-sized?]
|
|
112
|
+
- **Implementation Loop**: [Did IDE cycle work well?]
|
|
113
|
+
- **Review Process**: [Is this review capturing the right information?]
|
|
114
|
+
|
|
115
|
+
### Suggested Improvements
|
|
116
|
+
1. **Template Updates**: [Any template improvements needed?]
|
|
117
|
+
2. **Process Changes**: [Any step modifications recommended?]
|
|
118
|
+
3. **Tool Needs**: [Any automation opportunities?]
|
|
119
|
+
|
|
120
|
+
## Resource Analysis
|
|
121
|
+
|
|
122
|
+
### Time Investment
|
|
123
|
+
- **Planned**: [X person-days]
|
|
124
|
+
- **Actual**: [Y person-days]
|
|
125
|
+
- **Variance Explanation**: [Why different?]
|
|
126
|
+
|
|
127
|
+
### Team Feedback
|
|
128
|
+
- [Feedback from team members]
|
|
129
|
+
- [Collaboration insights]
|
|
130
|
+
- [Communication effectiveness]
|
|
131
|
+
|
|
132
|
+
## Follow-Up Actions
|
|
133
|
+
|
|
134
|
+
### Immediate (This Week)
|
|
135
|
+
- [ ] [Action 1 - owner]
|
|
136
|
+
- [ ] [Action 2 - owner]
|
|
137
|
+
|
|
138
|
+
### Short-term (This Month)
|
|
139
|
+
- [ ] [Action 1 - owner]
|
|
140
|
+
- [ ] [Action 2 - owner]
|
|
141
|
+
|
|
142
|
+
### Long-term (Future Consideration)
|
|
143
|
+
- [ ] [Improvement opportunity 1]
|
|
144
|
+
- [ ] [Technical debt to address]
|
|
145
|
+
|
|
146
|
+
## Risk Retrospective
|
|
147
|
+
|
|
148
|
+
### Identified Risks That Materialized
|
|
149
|
+
| Risk | Impact | How Handled | Prevention for Future |
|
|
150
|
+
|------|--------|-------------|----------------------|
|
|
151
|
+
| [Risk] | [What happened] | [Resolution] | [Learning] |
|
|
152
|
+
|
|
153
|
+
### Unforeseen Issues
|
|
154
|
+
| Issue | Impact | How Handled | How to Predict |
|
|
155
|
+
|-------|--------|-------------|----------------|
|
|
156
|
+
| [Issue] | [Impact] | [Resolution] | [Detection method] |
|
|
157
|
+
|
|
158
|
+
## Documentation Updates
|
|
159
|
+
|
|
160
|
+
### Completed
|
|
161
|
+
- [x] API documentation updated
|
|
162
|
+
- [x] README updated
|
|
163
|
+
- [x] Architecture diagrams revised
|
|
164
|
+
- [ ] [Pending items]
|
|
165
|
+
|
|
166
|
+
### Knowledge Transfer
|
|
167
|
+
- **Wiki/Confluence Updates**: [Links]
|
|
168
|
+
- **Team Presentations**: [Scheduled/Completed]
|
|
169
|
+
- **Runbooks Created**: [Links]
|
|
170
|
+
|
|
171
|
+
## Stakeholder Feedback
|
|
172
|
+
- **Product Owner**: [Feedback]
|
|
173
|
+
- **End Users**: [Feedback if available]
|
|
174
|
+
- **Support Team**: [Readiness assessment]
|
|
175
|
+
|
|
176
|
+
## Final Recommendations
|
|
177
|
+
|
|
178
|
+
### For Future Similar Projects
|
|
179
|
+
1. [Recommendation 1]
|
|
180
|
+
2. [Recommendation 2]
|
|
181
|
+
|
|
182
|
+
### For Methodology Evolution
|
|
183
|
+
1. [Suggestion 1]
|
|
184
|
+
2. [Suggestion 2]
|
|
185
|
+
|
|
186
|
+
## Conclusion
|
|
187
|
+
[Summary statement about the project success, key achievements, and main learnings]
|
|
188
|
+
|
|
189
|
+
## Appendix
|
|
190
|
+
|
|
191
|
+
### Links
|
|
192
|
+
- **Code**: [Repository links, PRs]
|
|
193
|
+
- **Documentation**: [All related docs]
|
|
194
|
+
- **Metrics Dashboards**: [Monitoring links]
|
|
195
|
+
- **Test Reports**: [CI/CD links]
|
|
196
|
+
|
|
197
|
+
### Expert Consultation Summary
|
|
198
|
+
[If expert AI review was performed post-implementation]
|
|
199
|
+
- **Model**: [Which model]
|
|
200
|
+
- **Feedback**: [Key points]
|
|
201
|
+
- **Incorporated Changes**: [What was acted upon]
|
|
202
|
+
|
|
203
|
+
## Sign-off
|
|
204
|
+
- [ ] Technical Lead Review
|
|
205
|
+
- [ ] Team Retrospective Completed
|
|
206
|
+
- [ ] Lessons Documented
|
|
207
|
+
- [ ] Methodology Updates Proposed
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
# Specification: [Title]
|
|
2
|
+
|
|
3
|
+
## Metadata
|
|
4
|
+
- **ID**: spec-[YYYY-MM-DD]-[short-name]
|
|
5
|
+
- **Status**: draft
|
|
6
|
+
- **Created**: [YYYY-MM-DD]
|
|
7
|
+
|
|
8
|
+
## Clarifying Questions Asked
|
|
9
|
+
<!-- Document the questions you asked the user/stakeholder and their answers -->
|
|
10
|
+
[List the questions you asked to understand the problem better and the responses received. This shows the discovery process.]
|
|
11
|
+
|
|
12
|
+
## Problem Statement
|
|
13
|
+
[Clearly articulate the problem being solved. Include context about why this is important, who is affected, and what the current pain points are.]
|
|
14
|
+
|
|
15
|
+
## Current State
|
|
16
|
+
[Describe how things work today. What are the limitations? What workarounds exist? Include specific examples.]
|
|
17
|
+
|
|
18
|
+
## Desired State
|
|
19
|
+
[Describe the ideal solution. How should things work after implementation? What specific improvements will users see?]
|
|
20
|
+
|
|
21
|
+
## Stakeholders
|
|
22
|
+
- **Primary Users**: [Who will directly use this feature?]
|
|
23
|
+
- **Secondary Users**: [Who else is affected?]
|
|
24
|
+
- **Technical Team**: [Who will implement and maintain this?]
|
|
25
|
+
- **Business Owners**: [Who has decision authority?]
|
|
26
|
+
|
|
27
|
+
## Success Criteria
|
|
28
|
+
- [ ] [Specific, measurable criterion 1]
|
|
29
|
+
- [ ] [Specific, measurable criterion 2]
|
|
30
|
+
- [ ] [Specific, measurable criterion 3]
|
|
31
|
+
- [ ] All tests pass with >90% coverage
|
|
32
|
+
- [ ] Performance benchmarks met (specify below)
|
|
33
|
+
- [ ] Documentation updated
|
|
34
|
+
|
|
35
|
+
## Constraints
|
|
36
|
+
### Technical Constraints
|
|
37
|
+
- [Existing system limitations]
|
|
38
|
+
- [Technology stack requirements]
|
|
39
|
+
- [Integration points]
|
|
40
|
+
|
|
41
|
+
### Business Constraints
|
|
42
|
+
- [Timeline requirements]
|
|
43
|
+
- [Budget considerations]
|
|
44
|
+
- [Compliance requirements]
|
|
45
|
+
|
|
46
|
+
## Assumptions
|
|
47
|
+
- [List assumptions being made]
|
|
48
|
+
- [Include dependencies on other work]
|
|
49
|
+
- [Note any prerequisites]
|
|
50
|
+
|
|
51
|
+
## Solution Approaches
|
|
52
|
+
|
|
53
|
+
### Approach 1: [Name]
|
|
54
|
+
**Description**: [Brief overview of this approach]
|
|
55
|
+
|
|
56
|
+
**Pros**:
|
|
57
|
+
- [Advantage 1]
|
|
58
|
+
- [Advantage 2]
|
|
59
|
+
|
|
60
|
+
**Cons**:
|
|
61
|
+
- [Disadvantage 1]
|
|
62
|
+
- [Disadvantage 2]
|
|
63
|
+
|
|
64
|
+
**Estimated Complexity**: [Low/Medium/High]
|
|
65
|
+
**Risk Level**: [Low/Medium/High]
|
|
66
|
+
|
|
67
|
+
### Approach 2: [Name]
|
|
68
|
+
[Repeat structure for additional approaches]
|
|
69
|
+
|
|
70
|
+
[Add as many approaches as appropriate for the problem]
|
|
71
|
+
|
|
72
|
+
## Open Questions
|
|
73
|
+
|
|
74
|
+
### Critical (Blocks Progress)
|
|
75
|
+
- [ ] [Question that must be answered before proceeding]
|
|
76
|
+
|
|
77
|
+
### Important (Affects Design)
|
|
78
|
+
- [ ] [Question that influences technical decisions]
|
|
79
|
+
|
|
80
|
+
### Nice-to-Know (Optimization)
|
|
81
|
+
- [ ] [Question that could improve the solution]
|
|
82
|
+
|
|
83
|
+
## Performance Requirements
|
|
84
|
+
- **Response Time**: [e.g., <200ms p95]
|
|
85
|
+
- **Throughput**: [e.g., 1000 requests/second]
|
|
86
|
+
- **Resource Usage**: [e.g., <500MB memory]
|
|
87
|
+
- **Availability**: [e.g., 99.9% uptime]
|
|
88
|
+
|
|
89
|
+
## Security Considerations
|
|
90
|
+
- [Authentication requirements]
|
|
91
|
+
- [Authorization model]
|
|
92
|
+
- [Data privacy concerns]
|
|
93
|
+
- [Audit requirements]
|
|
94
|
+
|
|
95
|
+
## Test Scenarios
|
|
96
|
+
### Functional Tests
|
|
97
|
+
1. [Scenario 1: Happy path]
|
|
98
|
+
2. [Scenario 2: Edge case]
|
|
99
|
+
3. [Scenario 3: Error condition]
|
|
100
|
+
|
|
101
|
+
### Non-Functional Tests
|
|
102
|
+
1. [Performance test scenario]
|
|
103
|
+
2. [Security test scenario]
|
|
104
|
+
3. [Load test scenario]
|
|
105
|
+
|
|
106
|
+
## Dependencies
|
|
107
|
+
- **External Services**: [List any external APIs or services]
|
|
108
|
+
- **Internal Systems**: [List internal dependencies]
|
|
109
|
+
- **Libraries/Frameworks**: [List required libraries]
|
|
110
|
+
|
|
111
|
+
## References
|
|
112
|
+
- [Link to relevant documentation in codev/ref/]
|
|
113
|
+
- [Link to related specifications]
|
|
114
|
+
- [Link to architectural diagrams]
|
|
115
|
+
- [Link to research materials]
|
|
116
|
+
|
|
117
|
+
## Risks and Mitigation
|
|
118
|
+
| Risk | Probability | Impact | Mitigation Strategy |
|
|
119
|
+
|------|------------|--------|-------------------|
|
|
120
|
+
| [Risk 1] | Low/Med/High | Low/Med/High | [How to address] |
|
|
121
|
+
| [Risk 2] | Low/Med/High | Low/Med/High | [How to address] |
|
|
122
|
+
|
|
123
|
+
## Expert Consultation
|
|
124
|
+
<!-- Only if user requested multi-agent consultation -->
|
|
125
|
+
**Date**: [YYYY-MM-DD]
|
|
126
|
+
**Models Consulted**: [e.g., GPT-5 and Gemini Pro]
|
|
127
|
+
**Sections Updated**:
|
|
128
|
+
- [Section name]: [Brief description of change based on consultation]
|
|
129
|
+
- [Section name]: [Brief description of change based on consultation]
|
|
130
|
+
|
|
131
|
+
Note: All consultation feedback has been incorporated directly into the relevant sections above.
|
|
132
|
+
|
|
133
|
+
## Approval
|
|
134
|
+
- [ ] Technical Lead Review
|
|
135
|
+
- [ ] Product Owner Review
|
|
136
|
+
- [ ] Stakeholder Sign-off
|
|
137
|
+
- [ ] Expert AI Consultation Complete
|
|
138
|
+
|
|
139
|
+
## Notes
|
|
140
|
+
[Any additional context or considerations not covered above]
|