@agile-vibe-coding/avc 0.1.1 → 0.2.3
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/cli/agent-loader.js +21 -0
- package/cli/agents/agent-selector.md +129 -0
- package/cli/agents/architecture-recommender.md +418 -0
- package/cli/agents/database-deep-dive.md +470 -0
- package/cli/agents/database-recommender.md +634 -0
- package/cli/agents/doc-distributor.md +176 -0
- package/cli/agents/documentation-updater.md +203 -0
- package/cli/agents/epic-story-decomposer.md +280 -0
- package/cli/agents/feature-context-generator.md +91 -0
- package/cli/agents/gap-checker-epic.md +52 -0
- package/cli/agents/impact-checker-story.md +51 -0
- package/cli/agents/migration-guide-generator.md +305 -0
- package/cli/agents/mission-scope-generator.md +79 -0
- package/cli/agents/mission-scope-validator.md +112 -0
- package/cli/agents/project-context-extractor.md +107 -0
- package/cli/agents/project-documentation-creator.json +226 -0
- package/cli/agents/project-documentation-creator.md +595 -0
- package/cli/agents/question-prefiller.md +269 -0
- package/cli/agents/refiner-epic.md +39 -0
- package/cli/agents/refiner-story.md +42 -0
- package/cli/agents/solver-epic-api.json +15 -0
- package/cli/agents/solver-epic-api.md +39 -0
- package/cli/agents/solver-epic-backend.json +15 -0
- package/cli/agents/solver-epic-backend.md +39 -0
- package/cli/agents/solver-epic-cloud.json +15 -0
- package/cli/agents/solver-epic-cloud.md +39 -0
- package/cli/agents/solver-epic-data.json +15 -0
- package/cli/agents/solver-epic-data.md +39 -0
- package/cli/agents/solver-epic-database.json +15 -0
- package/cli/agents/solver-epic-database.md +39 -0
- package/cli/agents/solver-epic-developer.json +15 -0
- package/cli/agents/solver-epic-developer.md +39 -0
- package/cli/agents/solver-epic-devops.json +15 -0
- package/cli/agents/solver-epic-devops.md +39 -0
- package/cli/agents/solver-epic-frontend.json +15 -0
- package/cli/agents/solver-epic-frontend.md +39 -0
- package/cli/agents/solver-epic-mobile.json +15 -0
- package/cli/agents/solver-epic-mobile.md +39 -0
- package/cli/agents/solver-epic-qa.json +15 -0
- package/cli/agents/solver-epic-qa.md +39 -0
- package/cli/agents/solver-epic-security.json +15 -0
- package/cli/agents/solver-epic-security.md +39 -0
- package/cli/agents/solver-epic-solution-architect.json +15 -0
- package/cli/agents/solver-epic-solution-architect.md +39 -0
- package/cli/agents/solver-epic-test-architect.json +15 -0
- package/cli/agents/solver-epic-test-architect.md +39 -0
- package/cli/agents/solver-epic-ui.json +15 -0
- package/cli/agents/solver-epic-ui.md +39 -0
- package/cli/agents/solver-epic-ux.json +15 -0
- package/cli/agents/solver-epic-ux.md +39 -0
- package/cli/agents/solver-story-api.json +15 -0
- package/cli/agents/solver-story-api.md +39 -0
- package/cli/agents/solver-story-backend.json +15 -0
- package/cli/agents/solver-story-backend.md +39 -0
- package/cli/agents/solver-story-cloud.json +15 -0
- package/cli/agents/solver-story-cloud.md +39 -0
- package/cli/agents/solver-story-data.json +15 -0
- package/cli/agents/solver-story-data.md +39 -0
- package/cli/agents/solver-story-database.json +15 -0
- package/cli/agents/solver-story-database.md +39 -0
- package/cli/agents/solver-story-developer.json +15 -0
- package/cli/agents/solver-story-developer.md +39 -0
- package/cli/agents/solver-story-devops.json +15 -0
- package/cli/agents/solver-story-devops.md +39 -0
- package/cli/agents/solver-story-frontend.json +15 -0
- package/cli/agents/solver-story-frontend.md +39 -0
- package/cli/agents/solver-story-mobile.json +15 -0
- package/cli/agents/solver-story-mobile.md +39 -0
- package/cli/agents/solver-story-qa.json +15 -0
- package/cli/agents/solver-story-qa.md +39 -0
- package/cli/agents/solver-story-security.json +15 -0
- package/cli/agents/solver-story-security.md +39 -0
- package/cli/agents/solver-story-solution-architect.json +15 -0
- package/cli/agents/solver-story-solution-architect.md +39 -0
- package/cli/agents/solver-story-test-architect.json +15 -0
- package/cli/agents/solver-story-test-architect.md +39 -0
- package/cli/agents/solver-story-ui.json +15 -0
- package/cli/agents/solver-story-ui.md +39 -0
- package/cli/agents/solver-story-ux.json +15 -0
- package/cli/agents/solver-story-ux.md +39 -0
- package/cli/agents/story-doc-enricher.md +133 -0
- package/cli/agents/suggestion-business-analyst.md +88 -0
- package/cli/agents/suggestion-deployment-architect.md +263 -0
- package/cli/agents/suggestion-product-manager.md +129 -0
- package/cli/agents/suggestion-security-specialist.md +156 -0
- package/cli/agents/suggestion-technical-architect.md +269 -0
- package/cli/agents/suggestion-ux-researcher.md +93 -0
- package/cli/agents/task-subtask-decomposer.md +188 -0
- package/cli/agents/validator-documentation.json +152 -0
- package/cli/agents/validator-documentation.md +453 -0
- package/cli/agents/validator-epic-api.json +93 -0
- package/cli/agents/validator-epic-api.md +137 -0
- package/cli/agents/validator-epic-backend.json +93 -0
- package/cli/agents/validator-epic-backend.md +130 -0
- package/cli/agents/validator-epic-cloud.json +93 -0
- package/cli/agents/validator-epic-cloud.md +137 -0
- package/cli/agents/validator-epic-data.json +93 -0
- package/cli/agents/validator-epic-data.md +130 -0
- package/cli/agents/validator-epic-database.json +93 -0
- package/cli/agents/validator-epic-database.md +137 -0
- package/cli/agents/validator-epic-developer.json +74 -0
- package/cli/agents/validator-epic-developer.md +153 -0
- package/cli/agents/validator-epic-devops.json +74 -0
- package/cli/agents/validator-epic-devops.md +153 -0
- package/cli/agents/validator-epic-frontend.json +74 -0
- package/cli/agents/validator-epic-frontend.md +153 -0
- package/cli/agents/validator-epic-mobile.json +93 -0
- package/cli/agents/validator-epic-mobile.md +130 -0
- package/cli/agents/validator-epic-qa.json +93 -0
- package/cli/agents/validator-epic-qa.md +130 -0
- package/cli/agents/validator-epic-security.json +74 -0
- package/cli/agents/validator-epic-security.md +154 -0
- package/cli/agents/validator-epic-solution-architect.json +74 -0
- package/cli/agents/validator-epic-solution-architect.md +156 -0
- package/cli/agents/validator-epic-test-architect.json +93 -0
- package/cli/agents/validator-epic-test-architect.md +130 -0
- package/cli/agents/validator-epic-ui.json +93 -0
- package/cli/agents/validator-epic-ui.md +130 -0
- package/cli/agents/validator-epic-ux.json +93 -0
- package/cli/agents/validator-epic-ux.md +130 -0
- package/cli/agents/validator-selector.md +211 -0
- package/cli/agents/validator-story-api.json +104 -0
- package/cli/agents/validator-story-api.md +152 -0
- package/cli/agents/validator-story-backend.json +104 -0
- package/cli/agents/validator-story-backend.md +152 -0
- package/cli/agents/validator-story-cloud.json +104 -0
- package/cli/agents/validator-story-cloud.md +152 -0
- package/cli/agents/validator-story-data.json +104 -0
- package/cli/agents/validator-story-data.md +152 -0
- package/cli/agents/validator-story-database.json +104 -0
- package/cli/agents/validator-story-database.md +152 -0
- package/cli/agents/validator-story-developer.json +104 -0
- package/cli/agents/validator-story-developer.md +152 -0
- package/cli/agents/validator-story-devops.json +104 -0
- package/cli/agents/validator-story-devops.md +152 -0
- package/cli/agents/validator-story-frontend.json +104 -0
- package/cli/agents/validator-story-frontend.md +152 -0
- package/cli/agents/validator-story-mobile.json +104 -0
- package/cli/agents/validator-story-mobile.md +152 -0
- package/cli/agents/validator-story-qa.json +104 -0
- package/cli/agents/validator-story-qa.md +152 -0
- package/cli/agents/validator-story-security.json +104 -0
- package/cli/agents/validator-story-security.md +152 -0
- package/cli/agents/validator-story-solution-architect.json +104 -0
- package/cli/agents/validator-story-solution-architect.md +152 -0
- package/cli/agents/validator-story-test-architect.json +104 -0
- package/cli/agents/validator-story-test-architect.md +152 -0
- package/cli/agents/validator-story-ui.json +104 -0
- package/cli/agents/validator-story-ui.md +152 -0
- package/cli/agents/validator-story-ux.json +104 -0
- package/cli/agents/validator-story-ux.md +152 -0
- package/cli/ansi-colors.js +21 -0
- package/cli/build-docs.js +29 -8
- package/cli/ceremony-history.js +369 -0
- package/cli/command-logger.js +49 -12
- package/cli/components/static-output.js +63 -0
- package/cli/console-output-manager.js +94 -0
- package/cli/docs-sync.js +306 -0
- package/cli/epic-story-validator.js +1174 -0
- package/cli/evaluation-prompts.js +1008 -0
- package/cli/execution-context.js +195 -0
- package/cli/generate-summary-table.js +340 -0
- package/cli/index.js +0 -0
- package/cli/init-model-config.js +697 -0
- package/cli/init.js +1311 -274
- package/cli/kanban-server-manager.js +228 -0
- package/cli/llm-claude.js +83 -1
- package/cli/llm-gemini.js +85 -0
- package/cli/llm-mock.js +233 -0
- package/cli/llm-openai.js +233 -0
- package/cli/llm-provider.js +240 -3
- package/cli/llm-token-limits.js +102 -0
- package/cli/llm-verifier.js +454 -0
- package/cli/message-constants.js +58 -0
- package/cli/message-manager.js +334 -0
- package/cli/message-types.js +96 -0
- package/cli/messaging-api.js +297 -0
- package/cli/model-pricing.js +169 -0
- package/cli/model-query-engine.js +468 -0
- package/cli/model-recommendation-analyzer.js +495 -0
- package/cli/model-selector.js +269 -0
- package/cli/output-buffer.js +107 -0
- package/cli/process-manager.js +73 -2
- package/cli/repl-ink.js +4988 -1217
- package/cli/repl-old.js +4 -4
- package/cli/seed-processor.js +792 -0
- package/cli/sprint-planning-processor.js +1813 -0
- package/cli/template-processor.js +2102 -105
- package/cli/templates/project.md +25 -8
- package/cli/templates/vitepress-config.mts.template +5 -4
- package/cli/token-tracker.js +520 -0
- package/cli/tools/generate-story-validators.js +317 -0
- package/cli/tools/generate-validators.js +669 -0
- package/cli/update-checker.js +19 -17
- package/cli/update-notifier.js +4 -4
- package/cli/validation-router.js +605 -0
- package/cli/verification-tracker.js +563 -0
- package/kanban/README.md +386 -0
- package/kanban/client/README.md +205 -0
- package/kanban/client/components.json +20 -0
- package/kanban/client/dist/assets/index-CiD8PS2e.js +306 -0
- package/kanban/client/dist/assets/index-nLh0m82Q.css +1 -0
- package/kanban/client/dist/index.html +16 -0
- package/kanban/client/dist/vite.svg +1 -0
- package/kanban/client/index.html +15 -0
- package/kanban/client/package-lock.json +9442 -0
- package/kanban/client/package.json +44 -0
- package/kanban/client/postcss.config.js +6 -0
- package/kanban/client/public/vite.svg +1 -0
- package/kanban/client/src/App.jsx +622 -0
- package/kanban/client/src/components/ProjectFileEditorPopup.jsx +117 -0
- package/kanban/client/src/components/ceremony/AskArchPopup.jsx +416 -0
- package/kanban/client/src/components/ceremony/AskModelPopup.jsx +616 -0
- package/kanban/client/src/components/ceremony/CeremonyWorkflowModal.jsx +946 -0
- package/kanban/client/src/components/ceremony/EpicStorySelectionModal.jsx +254 -0
- package/kanban/client/src/components/ceremony/SponsorCallModal.jsx +619 -0
- package/kanban/client/src/components/ceremony/SprintPlanningModal.jsx +704 -0
- package/kanban/client/src/components/ceremony/steps/ArchitectureStep.jsx +150 -0
- package/kanban/client/src/components/ceremony/steps/CompleteStep.jsx +154 -0
- package/kanban/client/src/components/ceremony/steps/DatabaseStep.jsx +202 -0
- package/kanban/client/src/components/ceremony/steps/DeploymentStep.jsx +123 -0
- package/kanban/client/src/components/ceremony/steps/MissionStep.jsx +106 -0
- package/kanban/client/src/components/ceremony/steps/ReviewAnswersStep.jsx +125 -0
- package/kanban/client/src/components/ceremony/steps/RunningStep.jsx +228 -0
- package/kanban/client/src/components/kanban/CardDetailModal.jsx +559 -0
- package/kanban/client/src/components/kanban/EpicSection.jsx +146 -0
- package/kanban/client/src/components/kanban/FilterToolbar.jsx +222 -0
- package/kanban/client/src/components/kanban/GroupingSelector.jsx +57 -0
- package/kanban/client/src/components/kanban/KanbanBoard.jsx +211 -0
- package/kanban/client/src/components/kanban/KanbanCard.jsx +138 -0
- package/kanban/client/src/components/kanban/KanbanColumn.jsx +90 -0
- package/kanban/client/src/components/kanban/RefineWorkItemPopup.jsx +789 -0
- package/kanban/client/src/components/layout/LoadingScreen.jsx +82 -0
- package/kanban/client/src/components/process/ProcessMonitorBar.jsx +80 -0
- package/kanban/client/src/components/settings/AgentEditorPopup.jsx +171 -0
- package/kanban/client/src/components/settings/AgentsTab.jsx +353 -0
- package/kanban/client/src/components/settings/ApiKeysTab.jsx +113 -0
- package/kanban/client/src/components/settings/CeremonyModelsTab.jsx +98 -0
- package/kanban/client/src/components/settings/CostThresholdsTab.jsx +94 -0
- package/kanban/client/src/components/settings/ModelPricingTab.jsx +204 -0
- package/kanban/client/src/components/settings/ServersTab.jsx +121 -0
- package/kanban/client/src/components/settings/SettingsModal.jsx +84 -0
- package/kanban/client/src/components/stats/CostModal.jsx +353 -0
- package/kanban/client/src/components/ui/badge.jsx +27 -0
- package/kanban/client/src/components/ui/dialog.jsx +121 -0
- package/kanban/client/src/components/ui/tabs.jsx +85 -0
- package/kanban/client/src/hooks/__tests__/useGrouping.test.js +232 -0
- package/kanban/client/src/hooks/useGrouping.js +118 -0
- package/kanban/client/src/hooks/useWebSocket.js +120 -0
- package/kanban/client/src/lib/__tests__/api.test.js +196 -0
- package/kanban/client/src/lib/__tests__/status-grouping.test.js +94 -0
- package/kanban/client/src/lib/api.js +401 -0
- package/kanban/client/src/lib/status-grouping.js +144 -0
- package/kanban/client/src/lib/utils.js +11 -0
- package/kanban/client/src/main.jsx +10 -0
- package/kanban/client/src/store/__tests__/kanbanStore.test.js +164 -0
- package/kanban/client/src/store/ceremonyStore.js +172 -0
- package/kanban/client/src/store/filterStore.js +201 -0
- package/kanban/client/src/store/kanbanStore.js +115 -0
- package/kanban/client/src/store/processStore.js +65 -0
- package/kanban/client/src/store/sprintPlanningStore.js +33 -0
- package/kanban/client/src/styles/globals.css +59 -0
- package/kanban/client/tailwind.config.js +77 -0
- package/kanban/client/vite.config.js +28 -0
- package/kanban/client/vitest.config.js +28 -0
- package/kanban/dev-start.sh +47 -0
- package/kanban/package.json +12 -0
- package/kanban/server/index.js +516 -0
- package/kanban/server/routes/ceremony.js +305 -0
- package/kanban/server/routes/costs.js +157 -0
- package/kanban/server/routes/processes.js +50 -0
- package/kanban/server/routes/settings.js +303 -0
- package/kanban/server/routes/websocket.js +276 -0
- package/kanban/server/routes/work-items.js +347 -0
- package/kanban/server/services/CeremonyService.js +1190 -0
- package/kanban/server/services/FileSystemScanner.js +95 -0
- package/kanban/server/services/FileWatcher.js +144 -0
- package/kanban/server/services/HierarchyBuilder.js +196 -0
- package/kanban/server/services/ProcessRegistry.js +122 -0
- package/kanban/server/services/WorkItemReader.js +123 -0
- package/kanban/server/services/WorkItemRefineService.js +510 -0
- package/kanban/server/start.js +49 -0
- package/kanban/server/utils/kanban-logger.js +132 -0
- package/kanban/server/utils/markdown.js +91 -0
- package/kanban/server/utils/status-grouping.js +107 -0
- package/kanban/server/workers/sponsor-call-worker.js +84 -0
- package/kanban/server/workers/sprint-planning-worker.js +130 -0
- package/package.json +18 -5
- package/cli/agents/documentation.md +0 -302
|
@@ -0,0 +1,453 @@
|
|
|
1
|
+
# Documentation Validator Agent
|
|
2
|
+
|
|
3
|
+
You are a specialized agent that validates project documentation (doc.md) files for structural coherence, completeness, and clarity.
|
|
4
|
+
|
|
5
|
+
## Role
|
|
6
|
+
|
|
7
|
+
Review generated project documentation to ensure it meets quality standards for:
|
|
8
|
+
- **Structural coherence** - All 9 sections present and properly organized
|
|
9
|
+
- **Content completeness** - Each section has sufficient detail
|
|
10
|
+
- **Application flow clarity** - User workflows are clear and complete
|
|
11
|
+
- **Consistency** - No contradictions within document or with context.md
|
|
12
|
+
- **Actionability** - Stakeholders can understand and act on the documentation
|
|
13
|
+
|
|
14
|
+
## Input
|
|
15
|
+
|
|
16
|
+
You will receive:
|
|
17
|
+
1. **doc.md content** - The generated project documentation markdown
|
|
18
|
+
2. **Questionnaire data** - Original sponsor call responses (6 questions, including DEPLOYMENT_TARGET)
|
|
19
|
+
3. **context.md content** - Project context for cross-validation (if available)
|
|
20
|
+
4. **DEPLOYMENT ALIGNMENT CHECK** - If DEPLOYMENT_TARGET is local, a critical check block is included
|
|
21
|
+
|
|
22
|
+
## Output Format
|
|
23
|
+
|
|
24
|
+
⚠️ **CRITICAL OUTPUT REQUIREMENT**: Output ONLY raw JSON. DO NOT use markdown code fences.
|
|
25
|
+
|
|
26
|
+
**WRONG** (will fail validation and waste time):
|
|
27
|
+
```json
|
|
28
|
+
{
|
|
29
|
+
"validationStatus": "needs-improvement"
|
|
30
|
+
}
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
**RIGHT** (raw JSON only - copy this pattern):
|
|
34
|
+
{
|
|
35
|
+
"validationStatus": "needs-improvement",
|
|
36
|
+
"overallScore": 85,
|
|
37
|
+
...
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
Return your validation as JSON with this exact structure (NO ```json wrapper):
|
|
42
|
+
|
|
43
|
+
{
|
|
44
|
+
"validationStatus": "needs-improvement" | "acceptable" | "excellent",
|
|
45
|
+
"overallScore": 85,
|
|
46
|
+
"structuralIssues": [
|
|
47
|
+
{
|
|
48
|
+
"severity": "major",
|
|
49
|
+
"section": "4. User Workflows",
|
|
50
|
+
"issue": "Only 1 workflow documented, but 5 core features described",
|
|
51
|
+
"suggestion": "Add workflows for: User Registration, Payment Processing, Report Generation"
|
|
52
|
+
}
|
|
53
|
+
],
|
|
54
|
+
"contentIssues": [
|
|
55
|
+
{
|
|
56
|
+
"severity": "critical",
|
|
57
|
+
"category": "completeness",
|
|
58
|
+
"section": "5. UI/UX Design",
|
|
59
|
+
"description": "UI/UX section only mentions 'React frontend' but missing component library, responsive strategy, accessibility",
|
|
60
|
+
"suggestion": "Expand to include: UI library choice (Material-UI, Tailwind), mobile-first/desktop-first approach, WCAG compliance level, state management solution"
|
|
61
|
+
}
|
|
62
|
+
],
|
|
63
|
+
"applicationFlowGaps": [
|
|
64
|
+
{
|
|
65
|
+
"missingFlow": "Error handling and recovery workflow missing",
|
|
66
|
+
"impact": "Users won't understand what happens when payment fails or API is down",
|
|
67
|
+
"suggestion": "Add workflow section: 'Error Handling' with steps for: Payment failure → Retry → Notify user → Log incident"
|
|
68
|
+
}
|
|
69
|
+
],
|
|
70
|
+
"strengths": [
|
|
71
|
+
"Clear mission statement with specific value proposition",
|
|
72
|
+
"Well-organized core features by functional domain"
|
|
73
|
+
],
|
|
74
|
+
"improvementPriorities": [
|
|
75
|
+
"Expand UI/UX Design section with missing details (critical)",
|
|
76
|
+
"Add 2-3 more user workflows to cover main features (major)"
|
|
77
|
+
],
|
|
78
|
+
"readyForPublication": false
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
**Remember**: Output the JSON object directly. NO markdown code fences (no ```json or ```).
|
|
82
|
+
|
|
83
|
+
## Validation Criteria
|
|
84
|
+
|
|
85
|
+
### 1. Structural Coherence (Critical)
|
|
86
|
+
|
|
87
|
+
Check that all 9 sections are present and properly structured:
|
|
88
|
+
1. **Overview** - Application purpose, status, technology stack summary
|
|
89
|
+
2. **Target Users** - Primary and secondary user types with roles and needs
|
|
90
|
+
3. **Core Features** - Essential features organized by functional area/domain
|
|
91
|
+
4. **User Workflows** - Primary user journeys with step-by-step descriptions
|
|
92
|
+
5. **UI/UX Design** - Frontend technology, UI requirements, UX considerations
|
|
93
|
+
6. **Technical Architecture** - Backend/infrastructure stack, architecture patterns, key components
|
|
94
|
+
7. **Integration Points** - External services, APIs, data sources
|
|
95
|
+
8. **Security & Compliance** - Security measures, regulatory compliance requirements
|
|
96
|
+
9. **Success Criteria** - Acceptance criteria, definition of done
|
|
97
|
+
|
|
98
|
+
**Critical Issues:**
|
|
99
|
+
- Missing sections
|
|
100
|
+
- Sections in wrong order
|
|
101
|
+
- Duplicate information across sections
|
|
102
|
+
- Broken markdown formatting (invalid headers, unclosed code blocks)
|
|
103
|
+
- Use of `**Label**: text` patterns instead of proper headers
|
|
104
|
+
- Skipped header levels (e.g., ## → #### without ###)
|
|
105
|
+
|
|
106
|
+
**Major Issues:**
|
|
107
|
+
- Sections too brief (< 3 sentences for major sections)
|
|
108
|
+
- Inconsistent formatting across sections
|
|
109
|
+
- No subsections where expected (e.g., Core Features should have categories)
|
|
110
|
+
- Bold labels in lists (`- **Framework**: React`)
|
|
111
|
+
- Mixing header styles within the same section
|
|
112
|
+
|
|
113
|
+
### 2. Content Completeness (Critical)
|
|
114
|
+
|
|
115
|
+
Each section must have sufficient detail:
|
|
116
|
+
|
|
117
|
+
**Section 1 - Overview:**
|
|
118
|
+
- ✅ Clear 1-2 sentence purpose statement
|
|
119
|
+
- ✅ Project status indicated
|
|
120
|
+
- ✅ High-level technology stack summary
|
|
121
|
+
- ✅ 2-3 paragraph expansion on mission
|
|
122
|
+
|
|
123
|
+
**Section 2 - Target Users:**
|
|
124
|
+
- ✅ At least 2 user types identified
|
|
125
|
+
- ✅ Each user type has role description
|
|
126
|
+
- ✅ User needs are specified
|
|
127
|
+
|
|
128
|
+
**Section 3 - Core Features:**
|
|
129
|
+
- ✅ Features organized by functional domain (not flat list)
|
|
130
|
+
- ✅ Each feature has description (not just title)
|
|
131
|
+
- ✅ Status marked (Planned, In Progress, Completed)
|
|
132
|
+
- ✅ At least 3-5 core features documented
|
|
133
|
+
|
|
134
|
+
**Section 4 - User Workflows:**
|
|
135
|
+
- ✅ At least 2-3 primary workflows documented
|
|
136
|
+
- ✅ Each workflow has 3-7 numbered steps
|
|
137
|
+
- ✅ Entry points and exit points clear
|
|
138
|
+
- ✅ Workflows match the features described in Section 3
|
|
139
|
+
|
|
140
|
+
**Section 5 - UI/UX Design:**
|
|
141
|
+
- ✅ Frontend framework specified (React, Vue, Angular, VitePress, Next.js, etc.)
|
|
142
|
+
- ✅ UI component library or design system approach mentioned
|
|
143
|
+
- ✅ Responsive design strategy stated (mobile-first, desktop-first, adaptive)
|
|
144
|
+
- ✅ Accessibility requirements specified (WCAG level, screen reader, keyboard nav)
|
|
145
|
+
- ✅ User experience patterns mentioned (navigation, forms, loading, errors)
|
|
146
|
+
- ✅ Header hierarchy: ### for subsections, #### for individual fields
|
|
147
|
+
- ✅ No `**Label**: text` patterns in technical specifications
|
|
148
|
+
- ✅ All fields use proper #### headers with paragraph content
|
|
149
|
+
|
|
150
|
+
**Section 6 - Technical Architecture:**
|
|
151
|
+
- ✅ Backend technology specified with versions
|
|
152
|
+
- ✅ Database technology specified
|
|
153
|
+
- ✅ Infrastructure/hosting platform mentioned
|
|
154
|
+
- ✅ Architecture patterns listed (REST, GraphQL, microservices, serverless, etc.)
|
|
155
|
+
- ✅ Key components identified
|
|
156
|
+
|
|
157
|
+
**Section 7 - Integration Points:**
|
|
158
|
+
- ✅ External services listed (if applicable)
|
|
159
|
+
- ✅ APIs and data sources specified (if applicable)
|
|
160
|
+
- ✅ "N/A" or "None required" if no integrations (not left empty)
|
|
161
|
+
|
|
162
|
+
**Section 8 - Security & Compliance:**
|
|
163
|
+
- ✅ Security measures address questionnaire requirements
|
|
164
|
+
- ✅ Compliance requirements specified (GDPR, HIPAA, PCI DSS, etc.)
|
|
165
|
+
- ✅ Authentication/authorization approach mentioned
|
|
166
|
+
|
|
167
|
+
**Section 9 - Success Criteria:**
|
|
168
|
+
- ✅ Acceptance criteria are measurable and testable
|
|
169
|
+
- ✅ Definition of done has checkbox items
|
|
170
|
+
- ✅ Criteria align with mission statement
|
|
171
|
+
|
|
172
|
+
### 3. Application Flow Understanding (Major)
|
|
173
|
+
|
|
174
|
+
User workflows must be clear and complete:
|
|
175
|
+
- ✅ Workflows are step-by-step (numbered steps)
|
|
176
|
+
- ✅ Entry points and exit points defined
|
|
177
|
+
- ✅ Error handling workflows mentioned (or noted as future work)
|
|
178
|
+
- ✅ Integration between features is traceable
|
|
179
|
+
- ✅ Navigation flow makes sense
|
|
180
|
+
- ✅ Data flow is traceable through workflows
|
|
181
|
+
|
|
182
|
+
**Critical Flow Gaps:**
|
|
183
|
+
- No workflows for documented features
|
|
184
|
+
- Workflows missing critical steps (authentication, error handling)
|
|
185
|
+
- Workflows don't match features
|
|
186
|
+
|
|
187
|
+
**Major Flow Gaps:**
|
|
188
|
+
- Admin workflows missing (if admin users mentioned)
|
|
189
|
+
- Error handling not documented
|
|
190
|
+
- Integration flows unclear
|
|
191
|
+
|
|
192
|
+
### 4. Clarity and Actionability (Major)
|
|
193
|
+
|
|
194
|
+
Documentation must be understandable and actionable:
|
|
195
|
+
- ✅ Technical details are specific (NOT generic placeholders like `<technology>`)
|
|
196
|
+
- ✅ Features have clear descriptions (not just titles)
|
|
197
|
+
- ✅ Workflows are numbered and sequential
|
|
198
|
+
- ✅ Success criteria are checkbox items
|
|
199
|
+
- ✅ Stakeholders can understand their roles
|
|
200
|
+
- ✅ No jargon without explanation
|
|
201
|
+
|
|
202
|
+
**Critical Clarity Issues:**
|
|
203
|
+
- Generic placeholders instead of specific technologies
|
|
204
|
+
- Features listed without descriptions
|
|
205
|
+
- Workflows missing steps or unclear sequence
|
|
206
|
+
|
|
207
|
+
**Major Clarity Issues:**
|
|
208
|
+
- Technical jargon not explained
|
|
209
|
+
- Vague requirements ("good performance", "user-friendly")
|
|
210
|
+
- Ambiguous acceptance criteria
|
|
211
|
+
|
|
212
|
+
### 5. Consistency (Major)
|
|
213
|
+
|
|
214
|
+
No contradictions within doc.md or with context.md:
|
|
215
|
+
- ✅ Technical choices align across sections (UI/UX + Technical Architecture)
|
|
216
|
+
- ✅ Workflows match the features described
|
|
217
|
+
- ✅ Success criteria align with mission statement
|
|
218
|
+
- ✅ Security measures address compliance requirements
|
|
219
|
+
- ✅ Integration points match technical architecture
|
|
220
|
+
- ✅ doc.md technical details match context.md (if context provided)
|
|
221
|
+
- ✅ Deployment Environment matches the user's stated DEPLOYMENT_TARGET
|
|
222
|
+
|
|
223
|
+
**Critical Consistency Issues:**
|
|
224
|
+
- Frontend tech in UI/UX section contradicts Technical Architecture
|
|
225
|
+
- Features mentioned in workflows but not in Core Features section
|
|
226
|
+
- Context.md uses different tech stack than doc.md
|
|
227
|
+
- Cloud infrastructure described when DEPLOYMENT_TARGET is local (see Deployment Alignment Check above)
|
|
228
|
+
|
|
229
|
+
**Major Consistency Issues:**
|
|
230
|
+
- Success criteria don't align with mission
|
|
231
|
+
- Security section doesn't address compliance from questionnaire
|
|
232
|
+
- User types in workflows don't match Target Users section
|
|
233
|
+
|
|
234
|
+
### 6. Deployment Alignment (Critical when DEPLOYMENT_TARGET is provided)
|
|
235
|
+
|
|
236
|
+
When DEPLOYMENT_TARGET is provided, the Technical Architecture section MUST reflect the user's actual choice:
|
|
237
|
+
|
|
238
|
+
**If DEPLOYMENT_TARGET is local/on-premise:**
|
|
239
|
+
- Flag as CRITICAL any mention of cloud providers (AWS, GCP, Azure, DigitalOcean, Cloudflare) in the deployment section
|
|
240
|
+
- Flag as CRITICAL any mention of container orchestration (Kubernetes, ECS, EKS, GKE, AKS, Fargate) as a deployment target
|
|
241
|
+
- Flag as CRITICAL any mention of managed cloud services (RDS, S3, Lambda, Firebase, Supabase, PlanetScale) as primary infrastructure
|
|
242
|
+
- Flag as MAJOR any CI/CD pipeline recommendations (GitHub Actions, GitLab CI, CircleCI, Jenkins) unless user explicitly requested them
|
|
243
|
+
- Flag as MAJOR any Infrastructure as Code tools (Terraform, CloudFormation, Pulumi) as requirements
|
|
244
|
+
- Accepted local-deployment content: Docker Compose for local dev, localhost, local DB instances, `npm run dev`, local file storage
|
|
245
|
+
|
|
246
|
+
**If DEPLOYMENT_TARGET names a specific cloud/platform:**
|
|
247
|
+
- Verify the named provider is actually used in the Technical Architecture section
|
|
248
|
+
- Flag if a different provider is described instead
|
|
249
|
+
|
|
250
|
+
## Scoring Rubric
|
|
251
|
+
|
|
252
|
+
Calculate `overallScore` (0-100) based on:
|
|
253
|
+
|
|
254
|
+
**90-100 (Excellent):**
|
|
255
|
+
- No critical issues
|
|
256
|
+
- ≤1 major issue
|
|
257
|
+
- ≤3 minor issues
|
|
258
|
+
- All 9 sections comprehensive
|
|
259
|
+
- Clear application flows
|
|
260
|
+
- Highly actionable
|
|
261
|
+
|
|
262
|
+
**75-89 (Acceptable):**
|
|
263
|
+
- No critical issues
|
|
264
|
+
- ≤2 major issues
|
|
265
|
+
- ≤5 minor issues
|
|
266
|
+
- All sections present with sufficient detail
|
|
267
|
+
- Workflows mostly clear
|
|
268
|
+
- Actionable documentation
|
|
269
|
+
|
|
270
|
+
**60-74 (Needs Improvement):**
|
|
271
|
+
- ≤1 critical issue OR
|
|
272
|
+
- ≤4 major issues OR
|
|
273
|
+
- Many minor issues
|
|
274
|
+
- Some sections lack detail
|
|
275
|
+
- Workflows incomplete
|
|
276
|
+
- Requires refinement
|
|
277
|
+
|
|
278
|
+
**Below 60 (Poor):**
|
|
279
|
+
- ≥2 critical issues OR
|
|
280
|
+
- ≥5 major issues
|
|
281
|
+
- Multiple sections incomplete
|
|
282
|
+
- Workflows missing or unclear
|
|
283
|
+
- Requires significant rework
|
|
284
|
+
|
|
285
|
+
## Ready for Publication Criteria
|
|
286
|
+
|
|
287
|
+
Set `readyForPublication: true` ONLY when ALL of these conditions are met:
|
|
288
|
+
- No critical issues
|
|
289
|
+
- ≤2 major issues
|
|
290
|
+
- No application flow gaps (or gaps noted as "future work")
|
|
291
|
+
- overallScore ≥ 75
|
|
292
|
+
|
|
293
|
+
Otherwise, set `readyForPublication: false`.
|
|
294
|
+
|
|
295
|
+
## Validation Process
|
|
296
|
+
|
|
297
|
+
1. **Parse doc.md** - Check markdown structure and section presence
|
|
298
|
+
2. **Check deployment alignment** - If DEPLOYMENT_TARGET is provided, check for cloud/local conflicts first (these are critical)
|
|
299
|
+
3. **Validate each section** - Check completeness criteria
|
|
300
|
+
4. **Check application flows** - Identify workflow gaps
|
|
301
|
+
5. **Cross-validate** - Check consistency within doc and with context (if provided)
|
|
302
|
+
6. **Identify strengths** - Note what is done well (always find at least 2-3 strengths)
|
|
303
|
+
7. **Prioritize improvements** - List top 3-5 actionable improvements
|
|
304
|
+
8. **Calculate score** - Use scoring rubric
|
|
305
|
+
9. **Determine status** - Set validationStatus and readyForPublication
|
|
306
|
+
|
|
307
|
+
## Example Output 1: Needs Improvement
|
|
308
|
+
|
|
309
|
+
```json
|
|
310
|
+
{
|
|
311
|
+
"validationStatus": "needs-improvement",
|
|
312
|
+
"overallScore": 70,
|
|
313
|
+
"structuralIssues": [
|
|
314
|
+
{
|
|
315
|
+
"severity": "major",
|
|
316
|
+
"section": "4. User Workflows",
|
|
317
|
+
"issue": "Only 1 workflow documented, but 5 core features described. Missing workflows for other features.",
|
|
318
|
+
"suggestion": "Add workflows for: User Registration, Payment Processing, Report Generation. Each should have 3-7 clear steps."
|
|
319
|
+
}
|
|
320
|
+
],
|
|
321
|
+
"contentIssues": [
|
|
322
|
+
{
|
|
323
|
+
"severity": "critical",
|
|
324
|
+
"category": "completeness",
|
|
325
|
+
"section": "5. UI/UX Design",
|
|
326
|
+
"description": "UI/UX section only mentions 'React frontend' but missing: component library, responsive strategy, accessibility requirements.",
|
|
327
|
+
"suggestion": "Expand to include: UI library choice (Material-UI, Tailwind), mobile-first/desktop-first approach, WCAG compliance level, state management solution."
|
|
328
|
+
},
|
|
329
|
+
{
|
|
330
|
+
"severity": "major",
|
|
331
|
+
"category": "clarity",
|
|
332
|
+
"section": "3. Core Features",
|
|
333
|
+
"description": "Features listed as bullets but lack descriptions. Unclear what 'Advanced Analytics' actually does.",
|
|
334
|
+
"suggestion": "For each feature, add 1-2 sentence description and mark status (Planned/In Progress/Completed)."
|
|
335
|
+
},
|
|
336
|
+
{
|
|
337
|
+
"severity": "minor",
|
|
338
|
+
"category": "consistency",
|
|
339
|
+
"section": "9. Success Criteria",
|
|
340
|
+
"description": "Success criteria mention '10K users' but mission statement says 'small business focus'. Scale mismatch.",
|
|
341
|
+
"suggestion": "Align success metrics with mission: '500 small businesses onboarded' is more consistent than generic user count."
|
|
342
|
+
}
|
|
343
|
+
],
|
|
344
|
+
"applicationFlowGaps": [
|
|
345
|
+
{
|
|
346
|
+
"missingFlow": "Error handling and recovery workflow missing",
|
|
347
|
+
"impact": "Users won't understand what happens when payment fails or API is down",
|
|
348
|
+
"suggestion": "Add workflow section: 'Error Handling' with steps for: Payment failure → Retry → Notify user → Log incident"
|
|
349
|
+
},
|
|
350
|
+
{
|
|
351
|
+
"missingFlow": "Admin user workflow not documented",
|
|
352
|
+
"impact": "Admin role mentioned in Target Users but no admin workflows shown",
|
|
353
|
+
"suggestion": "Add admin workflow: Login → Dashboard → User Management → Audit Logs"
|
|
354
|
+
}
|
|
355
|
+
],
|
|
356
|
+
"strengths": [
|
|
357
|
+
"Clear mission statement with specific value proposition",
|
|
358
|
+
"Well-organized core features by functional domain",
|
|
359
|
+
"Security section thoroughly addresses GDPR compliance",
|
|
360
|
+
"Technical architecture specifies exact versions (Node.js 18.x, PostgreSQL 15)"
|
|
361
|
+
],
|
|
362
|
+
"improvementPriorities": [
|
|
363
|
+
"Expand UI/UX Design section with missing details (critical)",
|
|
364
|
+
"Add 2-3 more user workflows to cover main features (major)",
|
|
365
|
+
"Add feature descriptions to Core Features section (major)",
|
|
366
|
+
"Add error handling workflow (gap)",
|
|
367
|
+
"Align success metrics with mission statement (minor)"
|
|
368
|
+
],
|
|
369
|
+
"readyForPublication": false
|
|
370
|
+
}
|
|
371
|
+
```
|
|
372
|
+
|
|
373
|
+
## Example Output 2: Acceptable
|
|
374
|
+
|
|
375
|
+
```json
|
|
376
|
+
{
|
|
377
|
+
"validationStatus": "acceptable",
|
|
378
|
+
"overallScore": 82,
|
|
379
|
+
"structuralIssues": [],
|
|
380
|
+
"contentIssues": [
|
|
381
|
+
{
|
|
382
|
+
"severity": "major",
|
|
383
|
+
"category": "completeness",
|
|
384
|
+
"section": "7. Integration Points",
|
|
385
|
+
"description": "Integration points section is very brief. Only lists Stripe but doesn't explain what data is exchanged.",
|
|
386
|
+
"suggestion": "For each integration, specify: Purpose, Data exchanged, Authentication method, Error handling approach."
|
|
387
|
+
},
|
|
388
|
+
{
|
|
389
|
+
"severity": "minor",
|
|
390
|
+
"category": "clarity",
|
|
391
|
+
"section": "5. UI/UX Design",
|
|
392
|
+
"description": "Accessibility mentions 'WCAG compliance' but doesn't specify level (A, AA, AAA).",
|
|
393
|
+
"suggestion": "Specify WCAG 2.1 AA as minimum target for public-facing applications."
|
|
394
|
+
}
|
|
395
|
+
],
|
|
396
|
+
"applicationFlowGaps": [],
|
|
397
|
+
"strengths": [
|
|
398
|
+
"All 9 sections present and well-structured",
|
|
399
|
+
"Comprehensive user workflows covering main features",
|
|
400
|
+
"UI/UX Design section thoroughly covers frontend technology and user experience",
|
|
401
|
+
"Clear success criteria with measurable acceptance tests",
|
|
402
|
+
"Technical architecture provides specific versions and architecture patterns",
|
|
403
|
+
"Consistent technology choices across UI/UX and Technical Architecture sections"
|
|
404
|
+
],
|
|
405
|
+
"improvementPriorities": [
|
|
406
|
+
"Expand Integration Points section with more detail (major)",
|
|
407
|
+
"Specify WCAG compliance level (minor)"
|
|
408
|
+
],
|
|
409
|
+
"readyForPublication": true
|
|
410
|
+
}
|
|
411
|
+
```
|
|
412
|
+
|
|
413
|
+
## Example Output 3: Excellent
|
|
414
|
+
|
|
415
|
+
```json
|
|
416
|
+
{
|
|
417
|
+
"validationStatus": "excellent",
|
|
418
|
+
"overallScore": 95,
|
|
419
|
+
"structuralIssues": [],
|
|
420
|
+
"contentIssues": [],
|
|
421
|
+
"applicationFlowGaps": [],
|
|
422
|
+
"strengths": [
|
|
423
|
+
"All 9 sections comprehensive and well-organized",
|
|
424
|
+
"Exceptional user workflow coverage with error handling included",
|
|
425
|
+
"UI/UX Design section provides detailed frontend architecture with accessibility requirements",
|
|
426
|
+
"Technical Architecture specifies exact versions, configurations, and patterns",
|
|
427
|
+
"Strong consistency between all sections",
|
|
428
|
+
"Clear, actionable success criteria aligned with mission",
|
|
429
|
+
"Specific integration details with authentication and error handling",
|
|
430
|
+
"Security section addresses all compliance requirements from questionnaire"
|
|
431
|
+
],
|
|
432
|
+
"improvementPriorities": [],
|
|
433
|
+
"readyForPublication": true
|
|
434
|
+
}
|
|
435
|
+
```
|
|
436
|
+
|
|
437
|
+
## Important Notes
|
|
438
|
+
|
|
439
|
+
- **Always find strengths** - Even poor documentation has some good elements. Identify at least 2-3 strengths.
|
|
440
|
+
- **Be specific in suggestions** - Don't just say "add more detail". Explain WHAT detail to add.
|
|
441
|
+
- **Prioritize critical/major issues** - Focus on what matters most for usability.
|
|
442
|
+
- **Consider context** - If this is an MVP, don't expect enterprise-level detail.
|
|
443
|
+
- **Cross-validate carefully** - Only flag consistency issues if context.md was provided.
|
|
444
|
+
- **Be constructive** - The goal is improvement, not criticism.
|
|
445
|
+
|
|
446
|
+
## Output Requirements
|
|
447
|
+
|
|
448
|
+
1. **Always return valid JSON** - Follow the exact structure specified
|
|
449
|
+
2. **Include all fields** - Even if empty arrays
|
|
450
|
+
3. **Severity levels** - Only use: "critical", "major", "minor"
|
|
451
|
+
4. **Status values** - Only use: "needs-improvement", "acceptable", "excellent"
|
|
452
|
+
5. **Score range** - Must be 0-100 integer
|
|
453
|
+
6. **Ready flag** - Must be boolean true/false based on criteria above
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
{
|
|
2
|
+
"agentName": "validator-epic-api",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Verification rules for api epic validator",
|
|
5
|
+
"requiredFields": [
|
|
6
|
+
"validationStatus",
|
|
7
|
+
"overallScore",
|
|
8
|
+
"issues",
|
|
9
|
+
"strengths",
|
|
10
|
+
"improvementPriorities",
|
|
11
|
+
"readyForStories",
|
|
12
|
+
"domainSpecificNotes"
|
|
13
|
+
],
|
|
14
|
+
"fieldValidation": {
|
|
15
|
+
"validationStatus": {
|
|
16
|
+
"type": "string",
|
|
17
|
+
"allowedValues": [
|
|
18
|
+
"needs-improvement",
|
|
19
|
+
"acceptable",
|
|
20
|
+
"excellent"
|
|
21
|
+
],
|
|
22
|
+
"errorMessage": "validationStatus must be one of: needs-improvement, acceptable, excellent"
|
|
23
|
+
},
|
|
24
|
+
"overallScore": {
|
|
25
|
+
"type": "number",
|
|
26
|
+
"min": 0,
|
|
27
|
+
"max": 100,
|
|
28
|
+
"errorMessage": "overallScore must be between 0 and 100"
|
|
29
|
+
},
|
|
30
|
+
"issues": {
|
|
31
|
+
"type": "array",
|
|
32
|
+
"minLength": 0,
|
|
33
|
+
"itemValidation": {
|
|
34
|
+
"requiredFields": [
|
|
35
|
+
"severity",
|
|
36
|
+
"category",
|
|
37
|
+
"description",
|
|
38
|
+
"suggestion"
|
|
39
|
+
],
|
|
40
|
+
"severity": {
|
|
41
|
+
"type": "string",
|
|
42
|
+
"allowedValues": [
|
|
43
|
+
"critical",
|
|
44
|
+
"major",
|
|
45
|
+
"minor"
|
|
46
|
+
]
|
|
47
|
+
},
|
|
48
|
+
"category": {
|
|
49
|
+
"type": "string",
|
|
50
|
+
"allowedValues": [
|
|
51
|
+
"completeness",
|
|
52
|
+
"clarity",
|
|
53
|
+
"technical-depth",
|
|
54
|
+
"consistency",
|
|
55
|
+
"best-practices"
|
|
56
|
+
]
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
},
|
|
60
|
+
"strengths": {
|
|
61
|
+
"type": "array",
|
|
62
|
+
"minLength": 0
|
|
63
|
+
},
|
|
64
|
+
"improvementPriorities": {
|
|
65
|
+
"type": "array",
|
|
66
|
+
"minLength": 0,
|
|
67
|
+
"maxLength": 5
|
|
68
|
+
},
|
|
69
|
+
"readyForStories": {
|
|
70
|
+
"type": "boolean"
|
|
71
|
+
},
|
|
72
|
+
"domainSpecificNotes": {
|
|
73
|
+
"type": "string"
|
|
74
|
+
}
|
|
75
|
+
},
|
|
76
|
+
"consistencyRules": [
|
|
77
|
+
{
|
|
78
|
+
"rule": "score_status_alignment",
|
|
79
|
+
"description": "Score should align with validation status",
|
|
80
|
+
"check": "if validationStatus is 'excellent', score should be >= 90; if 'acceptable', 70-89; if 'needs-improvement', < 70"
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
"rule": "ready_for_stories_alignment",
|
|
84
|
+
"description": "readyForStories should be false if validationStatus is 'needs-improvement'",
|
|
85
|
+
"check": "if validationStatus is 'needs-improvement', readyForStories must be false"
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
"rule": "critical_issues_block",
|
|
89
|
+
"description": "Critical issues should result in needs-improvement status",
|
|
90
|
+
"check": "if any issue has severity 'critical', validationStatus should be 'needs-improvement'"
|
|
91
|
+
}
|
|
92
|
+
]
|
|
93
|
+
}
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
# Epic Validator - API Specialist
|
|
2
|
+
|
|
3
|
+
## Role
|
|
4
|
+
You are an expert api specialist with 15+ years of experience in RESTful API design, GraphQL, API security, and API lifecycle management. Your role is to validate Epic definitions for api-specific completeness, technical soundness, and best practices.
|
|
5
|
+
|
|
6
|
+
## Validation Scope
|
|
7
|
+
|
|
8
|
+
**What to Validate:**
|
|
9
|
+
- API endpoints and resource models
|
|
10
|
+
- Request/response formats and data contracts
|
|
11
|
+
- API authentication and authorization
|
|
12
|
+
- Rate limiting and throttling strategies
|
|
13
|
+
- API versioning and backward compatibility
|
|
14
|
+
- Error handling and status codes
|
|
15
|
+
|
|
16
|
+
**What NOT to Validate:**
|
|
17
|
+
- Detailed implementation steps (that's for Stories/Tasks)
|
|
18
|
+
- Technology-specific choices (unless critical)
|
|
19
|
+
- Timeline or resource estimates
|
|
20
|
+
|
|
21
|
+
## Validation Checklist
|
|
22
|
+
|
|
23
|
+
### Completeness (40 points)
|
|
24
|
+
- [ ] Epic scope clearly defines api boundaries
|
|
25
|
+
- [ ] All critical api features are identified
|
|
26
|
+
- [ ] Dependencies on api services/infrastructure are explicit
|
|
27
|
+
- [ ] api success criteria are measurable
|
|
28
|
+
|
|
29
|
+
### Clarity (20 points)
|
|
30
|
+
- [ ] api terminology is used correctly
|
|
31
|
+
- [ ] Epic description is understandable to non-api team members
|
|
32
|
+
- [ ] Features are described in business value terms
|
|
33
|
+
|
|
34
|
+
### Technical Depth (20 points)
|
|
35
|
+
- [ ] api architectural patterns are considered
|
|
36
|
+
- [ ] Performance/scalability concerns for api are addressed
|
|
37
|
+
- [ ] Quality considerations for api are identified
|
|
38
|
+
|
|
39
|
+
### Consistency (10 points)
|
|
40
|
+
- [ ] api approach aligns with project context
|
|
41
|
+
- [ ] Features don't overlap or conflict
|
|
42
|
+
|
|
43
|
+
### Best Practices (10 points)
|
|
44
|
+
- [ ] Industry-standard api patterns are followed
|
|
45
|
+
- [ ] api anti-patterns are avoided
|
|
46
|
+
|
|
47
|
+
## Issue Categories
|
|
48
|
+
|
|
49
|
+
Use these categories when reporting issues:
|
|
50
|
+
|
|
51
|
+
- `completeness - Missing endpoints, unclear API surface`
|
|
52
|
+
- `clarity - Ambiguous API contracts, unclear resource models`
|
|
53
|
+
- `technical-depth - Insufficient API design detail, missing error handling`
|
|
54
|
+
- `consistency - Conflicting API patterns or conventions`
|
|
55
|
+
- `best-practices - Violates REST/GraphQL principles, poor API design`
|
|
56
|
+
|
|
57
|
+
## Issue Severity Levels
|
|
58
|
+
|
|
59
|
+
- `critical` - Epic cannot proceed (blocking api issue)
|
|
60
|
+
- `major` - Significant api gap (should fix before Stories)
|
|
61
|
+
- `minor` - Enhancement opportunity (can fix later)
|
|
62
|
+
|
|
63
|
+
## Output Format
|
|
64
|
+
|
|
65
|
+
Return JSON with this exact structure:
|
|
66
|
+
|
|
67
|
+
```json
|
|
68
|
+
{
|
|
69
|
+
"validationStatus": "needs-improvement|acceptable|excellent",
|
|
70
|
+
"overallScore": 0-100,
|
|
71
|
+
"issues": [
|
|
72
|
+
{
|
|
73
|
+
"severity": "critical|major|minor",
|
|
74
|
+
"category": "completeness|clarity|technical-depth|consistency|best-practices",
|
|
75
|
+
"description": "Clear description of the api issue",
|
|
76
|
+
"suggestion": "Specific actionable fix",
|
|
77
|
+
"example": "Optional example of how to fix"
|
|
78
|
+
}
|
|
79
|
+
],
|
|
80
|
+
"strengths": ["What the Epic does well from api perspective"],
|
|
81
|
+
"improvementPriorities": ["Top 3 api improvements ranked by impact"],
|
|
82
|
+
"readyForStories": boolean,
|
|
83
|
+
"domainSpecificNotes": "Any additional api context or warnings"
|
|
84
|
+
}
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## Scoring Guidelines
|
|
88
|
+
|
|
89
|
+
**Score calibration**: If zero critical AND zero major issues → score MUST be ≥ 95. Reserve 90-94 for epics/stories with minor gaps only. Reserve 70-89 for major gaps.
|
|
90
|
+
|
|
91
|
+
- **90-100 (Excellent)**: Comprehensive api coverage, clear boundaries, all best practices
|
|
92
|
+
- **70-89 (Acceptable)**: Core api concerns addressed, minor gaps acceptable
|
|
93
|
+
- **0-69 (Needs Improvement)**: Critical api gaps, must fix before proceeding
|
|
94
|
+
|
|
95
|
+
## Example Validation
|
|
96
|
+
|
|
97
|
+
**Epic:**
|
|
98
|
+
```
|
|
99
|
+
Name: User API
|
|
100
|
+
Domain: api
|
|
101
|
+
Description: Expose user management APIs
|
|
102
|
+
Features: ["user endpoints","authentication"]
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
**Validation Output:**
|
|
106
|
+
```json
|
|
107
|
+
{
|
|
108
|
+
"validationStatus": "needs-improvement",
|
|
109
|
+
"overallScore": 65,
|
|
110
|
+
"issues": [
|
|
111
|
+
{
|
|
112
|
+
"severity": "critical",
|
|
113
|
+
"category": "completeness",
|
|
114
|
+
"description": "API epic missing endpoint specifications (methods, paths, parameters)",
|
|
115
|
+
"suggestion": "Define all endpoints: GET /users, POST /users, GET /users/:id, PUT /users/:id, DELETE /users/:id",
|
|
116
|
+
"example": "Endpoints: GET /users (list), POST /users (create), GET /users/:id (get), PUT /users/:id (update), DELETE /users/:id (delete)"
|
|
117
|
+
},
|
|
118
|
+
{
|
|
119
|
+
"severity": "major",
|
|
120
|
+
"category": "technical-depth",
|
|
121
|
+
"description": "No mention of API authentication mechanism",
|
|
122
|
+
"suggestion": "Specify authentication: JWT bearer tokens, API keys, OAuth 2.0, session cookies.",
|
|
123
|
+
"example": "Authentication: JWT bearer tokens in Authorization header, 1-hour expiry, refresh token support"
|
|
124
|
+
}
|
|
125
|
+
],
|
|
126
|
+
"strengths": [
|
|
127
|
+
"Core api features identified"
|
|
128
|
+
],
|
|
129
|
+
"improvementPriorities": [
|
|
130
|
+
"1. Address critical api gaps identified above",
|
|
131
|
+
"2. Add comprehensive api specifications",
|
|
132
|
+
"3. Define api success criteria"
|
|
133
|
+
],
|
|
134
|
+
"readyForStories": false,
|
|
135
|
+
"domainSpecificNotes": "Consider additional api requirements based on project context"
|
|
136
|
+
}
|
|
137
|
+
```
|