@pzy560117/codex-harness 0.1.3 → 0.1.5
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 +164 -27
- package/bin/harness.js +7 -7
- package/lib/commands/doctor.js +12 -12
- package/lib/commands/init.js +105 -105
- package/lib/commands/run.js +22 -22
- package/lib/commands/verify.js +12 -12
- package/lib/main.js +62 -62
- package/lib/powershell/find-powershell.js +20 -20
- package/lib/powershell/invoke-script.js +34 -34
- package/lib/project/assert-initialized.js +20 -20
- package/lib/project/detect-project-root.js +5 -5
- package/lib/release/cache-layout.js +34 -34
- package/lib/release/download-release.js +25 -25
- package/lib/release/package-source-layout.js +13 -13
- package/lib/release/release-config.js +6 -6
- package/lib/release/release-manifest.js +76 -76
- package/lib/release/resolve-package-source.js +21 -21
- package/lib/release/resolve-version.js +26 -26
- package/lib/release/unpack-zip.js +25 -25
- package/lib/release/verify-sha256.js +16 -16
- package/package-source/AGENTS.md +48 -57
- package/package-source/PACKAGE.md +7 -7
- package/package-source/README.md +85 -81
- package/package-source/docs/codex-harness-engineering/templates/AGENTS.md +51 -0
- package/package-source/docs/codex-harness-engineering/templates/README.md +21 -20
- package/package-source/docs/codex-harness-engineering/templates/bootstrap-codex-harness.ps1 +144 -110
- package/package-source/docs/codex-harness-engineering/templates/ci/AGENTS.md +15 -0
- package/package-source/docs/codex-harness-engineering/templates/ci/github-action-codex-review.yml +110 -110
- package/package-source/docs/codex-harness-engineering/templates/config/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/config/agents/architect.toml +18 -17
- package/package-source/docs/codex-harness-engineering/templates/config/agents/backend-worker.toml +15 -14
- package/package-source/docs/codex-harness-engineering/templates/config/agents/docs-researcher.toml +13 -12
- package/package-source/docs/codex-harness-engineering/templates/config/agents/docs-worker.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/agents/explorer.toml +15 -14
- package/package-source/docs/codex-harness-engineering/templates/config/agents/failure-triage.toml +19 -18
- package/package-source/docs/codex-harness-engineering/templates/config/agents/frontend-worker.toml +15 -14
- package/package-source/docs/codex-harness-engineering/templates/config/agents/harness-writer.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/agents/planner.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/agents/readonly-research.toml +14 -13
- package/package-source/docs/codex-harness-engineering/templates/config/agents/reviewer.toml +13 -12
- package/package-source/docs/codex-harness-engineering/templates/config/agents/security-reviewer.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/agents/stage1-reviewer.toml +15 -14
- package/package-source/docs/codex-harness-engineering/templates/config/agents/stage2-reviewer.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/agents/test-planner.toml +18 -17
- package/package-source/docs/codex-harness-engineering/templates/config/agents/test-runner.toml +15 -14
- package/package-source/docs/codex-harness-engineering/templates/config/agents/visual-reviewer.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/codex-agent-roles.md +24 -24
- package/package-source/docs/codex-harness-engineering/templates/config/codex-config.toml +12 -12
- package/package-source/docs/codex-harness-engineering/templates/config/codex-readme.md +6 -6
- package/package-source/docs/codex-harness-engineering/templates/config/env-check.ps1 +44 -40
- package/package-source/docs/codex-harness-engineering/templates/config/env.example +13 -12
- package/package-source/docs/codex-harness-engineering/templates/config/global-AGENTS.md +40 -40
- package/package-source/docs/codex-harness-engineering/templates/config/global-config.toml +19 -19
- package/package-source/docs/codex-harness-engineering/templates/config/rules/agents.md +118 -115
- package/package-source/docs/codex-harness-engineering/templates/config/rules/coding-style.md +57 -74
- package/package-source/docs/codex-harness-engineering/templates/config/rules/constitution.md +4 -4
- package/package-source/docs/codex-harness-engineering/templates/config/rules/git.rules +41 -41
- package/package-source/docs/codex-harness-engineering/templates/config/rules/harness.rules +29 -29
- package/package-source/docs/codex-harness-engineering/templates/config/rules/safety.rules +35 -35
- package/package-source/docs/codex-harness-engineering/templates/context/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/context/API_MAP.md +18 -0
- package/package-source/docs/codex-harness-engineering/templates/context/CHANGELOG_AI.md +11 -0
- package/package-source/docs/codex-harness-engineering/templates/context/CURRENT_TASK.md +114 -0
- package/package-source/docs/codex-harness-engineering/templates/context/DB_SCHEMA.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/context/DECISIONS.md +12 -0
- package/package-source/docs/codex-harness-engineering/templates/context/KNOWN_ISSUES.md +12 -0
- package/package-source/docs/codex-harness-engineering/templates/context/PROJECT_CONTEXT.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/context/architecture-brief.md +58 -58
- package/package-source/docs/codex-harness-engineering/templates/context/dev-plan.md +89 -83
- package/package-source/docs/codex-harness-engineering/templates/context/feature-pack.md +101 -101
- package/package-source/docs/codex-harness-engineering/templates/context/repo-map.md +102 -78
- package/package-source/docs/codex-harness-engineering/templates/context/service-dependency-matrix.yaml +25 -25
- package/package-source/docs/codex-harness-engineering/templates/contracts/AGENTS.md +17 -0
- package/package-source/docs/codex-harness-engineering/templates/contracts/README.md +24 -16
- package/package-source/docs/codex-harness-engineering/templates/contracts/openapi.yaml +182 -182
- package/package-source/docs/codex-harness-engineering/templates/contracts/orval.config.ts +20 -20
- package/package-source/docs/codex-harness-engineering/templates/contracts/prism-usage.md +41 -34
- package/package-source/docs/codex-harness-engineering/templates/design/AGENTS.md +21 -0
- package/package-source/docs/codex-harness-engineering/templates/design/ai-image-brief.md +122 -122
- package/package-source/docs/codex-harness-engineering/templates/design/component-map.md +45 -31
- package/package-source/docs/codex-harness-engineering/templates/design/design-brief.md +183 -178
- package/package-source/docs/codex-harness-engineering/templates/design/design-tokens.json +88 -88
- package/package-source/docs/codex-harness-engineering/templates/design/frontend-architecture.md +164 -146
- package/package-source/docs/codex-harness-engineering/templates/design/image-to-frontend-spec.md +64 -52
- package/package-source/docs/codex-harness-engineering/templates/design/screen-states.md +157 -122
- package/package-source/docs/codex-harness-engineering/templates/design/visual-parity-review.md +21 -21
- package/package-source/docs/codex-harness-engineering/templates/docs/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/architecture-constraints.md +97 -83
- package/package-source/docs/codex-harness-engineering/templates/docs/code-semantics-and-navigation.md +54 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/code-style-and-naming.md +116 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/directory-structure-template.md +88 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/env-and-deployment-template.md +60 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/frontend-quality-rules.md +165 -138
- package/package-source/docs/codex-harness-engineering/templates/docs/governance-auto-repair.md +82 -80
- package/package-source/docs/codex-harness-engineering/templates/docs/harness-architecture.md +78 -78
- package/package-source/docs/codex-harness-engineering/templates/docs/install-manifest-governance.md +16 -16
- package/package-source/docs/codex-harness-engineering/templates/docs/knowledge-architecture.md +241 -219
- package/package-source/docs/codex-harness-engineering/templates/docs/knowledge-import.md +108 -108
- package/package-source/docs/codex-harness-engineering/templates/docs/knowledge-lint.md +98 -98
- package/package-source/docs/codex-harness-engineering/templates/docs/mcp-knowledge-governance.md +24 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/new-project-checklist.md +7 -7
- package/package-source/docs/codex-harness-engineering/templates/docs/new-project-usage.md +107 -43
- package/package-source/docs/codex-harness-engineering/templates/docs/project-agents-template.md +211 -154
- package/package-source/docs/codex-harness-engineering/templates/docs/prompt-knowledge-integration.md +100 -89
- package/package-source/docs/codex-harness-engineering/templates/docs/regression-rules.md +47 -45
- package/package-source/docs/codex-harness-engineering/templates/docs/requirement-prep-kit/README.md +3 -3
- package/package-source/docs/codex-harness-engineering/templates/docs/rule-governance.md +98 -98
- package/package-source/docs/codex-harness-engineering/templates/docs/service-dependency-matrix.md +70 -55
- package/package-source/docs/codex-harness-engineering/templates/docs/task-session-strategy.md +133 -116
- package/package-source/docs/codex-harness-engineering/templates/docs/team-knowledge-sync.md +187 -187
- package/package-source/docs/codex-harness-engineering/templates/docs/trace-format.md +44 -32
- package/package-source/docs/codex-harness-engineering/templates/governance/AGENTS.md +18 -0
- package/package-source/docs/codex-harness-engineering/templates/governance/branch-protection-checklist.md +50 -50
- package/package-source/docs/codex-harness-engineering/templates/governance/feedback-evolution-loop.md +55 -55
- package/package-source/docs/codex-harness-engineering/templates/governance/retry-budget.yaml +30 -30
- package/package-source/docs/codex-harness-engineering/templates/governance/risk-levels.yaml +53 -53
- package/package-source/docs/codex-harness-engineering/templates/governance/sandbox-policy.md +13 -13
- package/package-source/docs/codex-harness-engineering/templates/hooks/AGENTS.md +15 -0
- package/package-source/docs/codex-harness-engineering/templates/hooks/hook-stop-verify.ps1 +171 -118
- package/package-source/docs/codex-harness-engineering/templates/hooks/hooks.json +40 -40
- package/package-source/docs/codex-harness-engineering/templates/knowledge/AGENTS.md +16 -0
- package/package-source/docs/codex-harness-engineering/templates/knowledge/catalog.md +6 -6
- package/package-source/docs/codex-harness-engineering/templates/knowledge/decisions/DECISION-HARNESS-001.md +39 -39
- package/package-source/docs/codex-harness-engineering/templates/knowledge/guidelines/GUIDELINE-RULES-001.md +30 -30
- package/package-source/docs/codex-harness-engineering/templates/knowledge/knowledge-catalog.md +41 -41
- package/package-source/docs/codex-harness-engineering/templates/package-assets/.specify/templates/plan-template.md +252 -252
- package/package-source/docs/codex-harness-engineering/templates/package-assets/.specify/templates/spec-template.md +145 -145
- package/package-source/docs/codex-harness-engineering/templates/package-assets/.specify/templates/tasks-template.md +47 -47
- package/package-source/docs/codex-harness-engineering/templates/package-assets/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/AGENTS.md +25 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/README.md +118 -42
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/START-HERE.md +66 -53
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/agent-ecosystem-practices.md +140 -140
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/best-practices.md +9 -9
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/codex-global-rules-example.md +48 -48
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/goal-templates.md +380 -380
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/README.md +64 -64
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/contracts/openapi.yaml +25 -25
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/contracts/orval.config.ts +20 -20
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/ai-image-brief.md +44 -44
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/component-map.md +17 -17
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/design-brief.md +58 -58
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/frontend-architecture.md +106 -106
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/image-to-frontend-spec.md +72 -72
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/screen-states.md +25 -25
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/ui-image-review.md +38 -38
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/product/difficulty-research.md +39 -39
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/product/page-inventory.md +5 -5
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/product/prd-lite.md +41 -41
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/product/requirement-interface-matrix.md +32 -32
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/product/state-matrix.yaml +14 -14
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/packages/api-client/generated/model/Ticket.ts +6 -6
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/packages/api-client/generated/ticket-api.ts +35 -35
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/packages/api-client/http-client.ts +8 -8
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/packages/ui/TicketFilterBar.tsx +72 -72
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/plans/features/ticket-filter.dev-plan.md +48 -48
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/progress.txt +1 -1
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/stories/TicketFilterBar.stories.tsx +33 -33
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/task.json +54 -54
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/verify.ps1 +42 -42
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/global-rules-and-bootstrap.md +157 -157
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/goal-harness-integration-guide.md +364 -364
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/implementation-flow.md +7 -5
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/implementation-guide.md +25 -25
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/knowledge-surface-map.md +186 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/mode-matrix.md +57 -57
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/new-project-usage.md +176 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/project-agents-template.md +168 -154
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/superpowers-codex-solo-builder-playbook.md +676 -676
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/AGENTS.md +22 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/context/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/context/API_MAP.md +18 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/context/CURRENT_TASK.md +89 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/context/dev-plan.md +166 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/contracts/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/contracts/README.md +24 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/contracts/prism-usage.md +41 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/component-map.md +45 -31
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/design-brief.md +183 -178
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/design-tokens.json +88 -88
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/frontend-architecture.md +164 -146
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/image-to-frontend-spec.md +64 -52
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/screen-states.md +157 -122
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/visual-parity-review.md +21 -21
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/env-and-deployment-template.md +60 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/frontend-quality-rules.md +161 -138
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/regression-rules.md +47 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/trace-format.md +86 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/product/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/product/prd-lite.md +166 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/product/state-matrix.yaml +116 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/prompts/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/prompts/implement-one-task.md +150 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/prompts/repair-one-finding.md +70 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/spec/11-security-design.md +43 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/spec/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/EVIDENCE_PROTOCOL.md +54 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/NATURAL_LANGUAGE_TEST_CASES.md +690 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/REGRESSION_PLAN.md +28 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/TEST_STRATEGY.md +98 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/TRACEABILITY_MATRIX.md +23 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/verify-matrix.md +51 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/ecc-zh-CN/README.md +10 -10
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/ecc-zh-CN/commands/e2e.md +30 -30
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/README.md +60 -60
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/app/Mobile_App_Production_Readiness_Framework_/347/247/273/345/212/250/347/253/257/345/205/250/345/271/263/345/217/260/347/224/237/344/272/247/345/217/257/344/270/212/347/272/277/350/247/204/350/214/203.md +2457 -2457
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/app/catalog.md +33 -33
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/architecture.md +358 -358
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/common/AI_Coding_Production_Control_Framework_AI/345/206/231/345/256/214/347/232/204/344/273/243/347/240/201/345/246/202/344/275/225/344/270/215/345/244/261/346/216/247.md +2055 -2055
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/common/catalog.md +34 -34
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/initial-content.md +296 -296
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/integration-roadmap.md +221 -221
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/architecture-constraints.md +95 -83
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/code-semantics-and-navigation.md +17 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/code-style-and-naming.md +116 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/frontend-quality-rules.md +138 -138
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/governance-auto-repair.md +82 -80
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/mcp-knowledge-governance.md +24 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/service-dependency-matrix.md +55 -55
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/speckit-requirements-gate.md +124 -124
- package/package-source/docs/codex-harness-engineering/templates/package-assets/root/PACKAGE.md +7 -7
- package/package-source/docs/codex-harness-engineering/templates/package-assets/root/README.md +52 -52
- package/package-source/docs/codex-harness-engineering/templates/package-assets/root/install-agent-here.ps1 +57 -57
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/agents.md +115 -115
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/coding-style.md +57 -74
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/constitution.md +4 -4
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/git.rules +41 -41
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/harness.rules +29 -29
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/safety.rules +35 -35
- package/package-source/docs/codex-harness-engineering/templates/package-assets/scripts/ai-workflow/check-ai-sync-drift.ps1 +205 -205
- package/package-source/docs/codex-harness-engineering/templates/package-assets/scripts/ai-workflow/sync-ai-config-to-targets.ps1 +826 -826
- package/package-source/docs/codex-harness-engineering/templates/package-assets/scripts/ai-workflow/sync-targets.example.json +35 -35
- package/package-source/docs/codex-harness-engineering/templates/package-assets/scripts/harness/harness-governance-check.ps1 +864 -366
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/HOW_TO_USE_SKILLS.md +79 -79
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/academic-mermaid-diagrams/SKILL.md +172 -172
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/ai-config-git-sync/SKILL.md +152 -152
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/ai-config-git-sync/references/command-recipes.md +92 -92
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/auto-commit/SKILL.md +324 -322
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/better-icons/SKILL.md +3 -3
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/claude-openrouter-clash-debug/SKILL.md +100 -100
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/claude-openrouter-clash-debug/references/windows-openrouter-clash-playbook.md +94 -94
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/claude-openrouter-clash-debug/scripts/diagnose-openrouter-route.ps1 +282 -282
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/claude-openrouter-clash-debug/scripts/ensure-openrouter-rule.ps1 +101 -101
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/fixing-metadata/SKILL.md +6 -6
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/frontend-design/SKILL.md +37 -37
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/git-xianyu-analyzer/SKILL.md +3 -3
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/harness-surface-sync/SKILL.md +204 -188
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/harness-surface-sync/references/current-repo-sync-matrix.md +150 -110
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/harness-surface-sync/references/stale-patterns.md +65 -65
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/init-autopilot/SKILL.md +17 -15
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/log-analysis-optimization/SKILL.md +5 -5
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/prd-writer-skill/SKILL.md +28 -28
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qa-e2e-planner/SKILL.md +11 -11
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qa-e2e-runner/SKILL.md +6 -6
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qa-mock-cleaner/SKILL.md +4 -4
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qoder-codex-api-config/SKILL.md +67 -67
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qoder-codex-api-config/agents/openai.yaml +7 -7
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qoder-codex-api-config/scripts/configure-qoder-codex-api.ps1 +278 -278
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/requirements-design-template/SKILL.md +87 -87
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/skills-index.md +12 -12
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-analyze/SKILL.md +34 -34
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-checklist/SKILL.md +8 -8
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-clarify/SKILL.md +28 -28
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-e2e-tasks/SKILL.md +12 -12
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-implement/SKILL.md +37 -37
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-plan/SKILL.md +140 -138
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-specify/SKILL.md +100 -100
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-tasks/SKILL.md +86 -86
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-verify/SKILL.md +144 -142
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/sync-project-root-docs/SKILL.md +145 -143
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/sync-project-root-docs/references/current-repo-notes.md +42 -41
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/sync-project-root-docs/references/github-samples.md +33 -33
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/sync-project-root-docs/scripts/collect-root-doc-facts.ps1 +174 -145
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/ai-integrity-and-originality.md +191 -191
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/citation-templates.md +99 -99
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/final-checklist.md +60 -60
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/photographer-booking-paper.md +85 -85
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/test-result-templates.md +22 -22
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/thesis-analysis-template.md +63 -63
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/update-codemaps/SKILL.md +31 -31
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/README.md +15 -15
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.analyze.md +60 -60
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.checklist.md +8 -8
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.clarify.md +28 -28
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.e2e-testing.md +10 -10
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.implement.md +56 -56
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.plan.md +137 -134
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.specify.md +100 -100
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.tasks.md +86 -86
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.verify.md +130 -130
- package/package-source/docs/codex-harness-engineering/templates/product/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/product/acceptance-criteria.md +47 -47
- package/package-source/docs/codex-harness-engineering/templates/product/difficulty-research.md +47 -47
- package/package-source/docs/codex-harness-engineering/templates/product/page-inventory.md +21 -21
- package/package-source/docs/codex-harness-engineering/templates/product/prd-lite.md +166 -158
- package/package-source/docs/codex-harness-engineering/templates/product/requirement-interface-matrix.md +37 -37
- package/package-source/docs/codex-harness-engineering/templates/product/state-matrix.yaml +116 -105
- package/package-source/docs/codex-harness-engineering/templates/prompts/AGENTS.md +15 -0
- package/package-source/docs/codex-harness-engineering/templates/prompts/controller-loop.md +88 -88
- package/package-source/docs/codex-harness-engineering/templates/prompts/failure-triage.md +71 -69
- package/package-source/docs/codex-harness-engineering/templates/prompts/harness-audit.md +54 -52
- package/package-source/docs/codex-harness-engineering/templates/prompts/implement-one-task.md +150 -148
- package/package-source/docs/codex-harness-engineering/templates/prompts/repair-one-finding.md +70 -67
- package/package-source/docs/codex-harness-engineering/templates/prompts/review-one-task.md +45 -43
- package/package-source/docs/codex-harness-engineering/templates/prompts/review-stage1-spec.md +111 -109
- package/package-source/docs/codex-harness-engineering/templates/prompts/review-stage2-quality.md +82 -80
- package/package-source/docs/codex-harness-engineering/templates/prompts/visual-evaluator.md +80 -78
- package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/backend-worker.md +41 -41
- package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/docs-worker.md +28 -28
- package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/frontend-worker.md +46 -46
- package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/harness-writer.md +40 -40
- package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/test-runner.md +27 -27
- package/package-source/docs/codex-harness-engineering/templates/runtime/AGENTS.md +66 -50
- package/package-source/docs/codex-harness-engineering/templates/runtime/codex-loop.ps1 +2129 -231
- package/package-source/docs/codex-harness-engineering/templates/runtime/doctor.ps1 +224 -224
- package/package-source/docs/codex-harness-engineering/templates/runtime/project-task-template.json +42 -39
- package/package-source/docs/codex-harness-engineering/templates/runtime/scripts/test-install-modes.ps1 +2 -2
- package/package-source/docs/codex-harness-engineering/templates/runtime/smoke-task.json +52 -52
- package/package-source/docs/codex-harness-engineering/templates/runtime/task-run-profile.json +86 -86
- package/package-source/docs/codex-harness-engineering/templates/runtime/task.json +11 -8
- package/package-source/docs/codex-harness-engineering/templates/runtime/verify.ps1 +21 -21
- package/package-source/docs/codex-harness-engineering/templates/scripts/AGENTS.md +15 -0
- package/package-source/docs/codex-harness-engineering/templates/scripts/ai-workflow/check-ai-sync-drift.ps1 +205 -205
- package/package-source/docs/codex-harness-engineering/templates/scripts/harness/harness-governance-check.ps1 +864 -366
- package/package-source/docs/codex-harness-engineering/templates/spec/10-data-model.md +23 -7
- package/package-source/docs/codex-harness-engineering/templates/spec/11-security-design.md +30 -13
- package/package-source/docs/codex-harness-engineering/templates/spec/AGENTS.md +15 -0
- package/package-source/docs/codex-harness-engineering/templates/testing/ACCEPTANCE_CRITERIA.md +39 -39
- package/package-source/docs/codex-harness-engineering/templates/testing/ACCEPTANCE_EXAMPLES.md +37 -37
- package/package-source/docs/codex-harness-engineering/templates/testing/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/testing/EVIDENCE_PROTOCOL.md +54 -48
- package/package-source/docs/codex-harness-engineering/templates/testing/NATURAL_LANGUAGE_TEST_CASES.md +5 -4
- package/package-source/docs/codex-harness-engineering/templates/testing/REGRESSION_PLAN.md +28 -20
- package/package-source/docs/codex-harness-engineering/templates/testing/RISK_BASED_TEST_PLAN.md +16 -16
- package/package-source/docs/codex-harness-engineering/templates/testing/TEST_STRATEGY.md +98 -97
- package/package-source/docs/codex-harness-engineering/templates/testing/TRACEABILITY_MATRIX.md +6 -5
- package/package-source/docs/codex-harness-engineering/templates/testing/coverage-policy.md +25 -25
- package/package-source/docs/codex-harness-engineering/templates/testing/e2e-plan.md +139 -139
- package/package-source/docs/codex-harness-engineering/templates/testing/failure-findings.example.json +3 -3
- package/package-source/docs/codex-harness-engineering/templates/testing/failure-triage.md +62 -62
- package/package-source/docs/codex-harness-engineering/templates/testing/test-data-plan.md +36 -36
- package/package-source/docs/codex-harness-engineering/templates/testing/test-report.md +85 -41
- package/package-source/docs/codex-harness-engineering/templates/testing/verify-matrix.md +15 -5
- package/package-source/docs/codex-harness-engineering/templates/tools/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/acceptance-lint.ps1 +37 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/architecture-lint.ps1 +150 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/backend-lint.ps1 +137 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/business-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/component-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/config-lint.ps1 +159 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/context-lint.ps1 +187 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/contract-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/data-lint.ps1 +37 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/directory-lint.ps1 +152 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/docs-lint.ps1 +40 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/impact-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/integration-lint.ps1 +37 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/mobile-lint.ps1 +37 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/observability-lint.ps1 +137 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/performance-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/refactor-lint.ps1 +137 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/security-lint.ps1 +159 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/session-lint.ps1 +126 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/spec-lint.ps1 +285 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/state-lint.ps1 +137 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/style-lint.ps1 +155 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/testing-lint.ps1 +192 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/ui-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/trace/AGENTS.md +16 -0
- package/package-source/docs/codex-harness-engineering/templates/trace/eval-case.yaml +24 -24
- package/package-source/docs/codex-harness-engineering/templates/trace/trace.schema.json +101 -101
- package/package-source/install-manifest.json +149 -79
- package/package-source/tools/install/ai-workflow/check-ai-sync-drift.ps1 +205 -205
- package/package-source/tools/install/ai-workflow/sync-ai-config-to-targets.ps1 +826 -826
- package/package-source/tools/install/ai-workflow/sync-targets.example.json +35 -35
- package/package-source/tools/install/bootstrap-codex-harness.ps1 +145 -129
- package/package-source/tools/install/env-check.ps1 +40 -40
- package/package-source/tools/install/init-project.ps1 +1 -1
- package/package-source/tools/install/install-agent-here.ps1 +57 -57
- package/package-source/tools/install/install-agent.ps1 +33 -31
- package/package.json +23 -23
|
@@ -13,30 +13,30 @@
|
|
|
13
13
|
|
|
14
14
|
| Source | Path | Status | Notes |
|
|
15
15
|
| --- | --- | --- | --- |
|
|
16
|
-
| Product Spec | `specs/[###-feature-name]/spec.md` | Draft / Approved | |
|
|
17
|
-
| Architecture | `specs/[###-feature-name]/architecture.md` | Draft / Approved | |
|
|
16
|
+
| Product Spec | `specs/[###-feature-name]/spec.md` | Draft / Approved | |
|
|
17
|
+
| Architecture | `specs/[###-feature-name]/architecture.md` | Draft / Approved | |
|
|
18
18
|
| PRD-Lite | `docs/product/prd-lite.md` | Draft / Approved / N/A | |
|
|
19
19
|
| Page Inventory | `docs/product/page-inventory.md` | Draft / Approved / N/A | |
|
|
20
20
|
| State Matrix | `docs/product/state-matrix.yaml` | Draft / Approved / N/A | |
|
|
21
|
-
| Acceptance Criteria | `docs/product/acceptance-criteria.md` | Draft / Approved / N/A | |
|
|
22
|
-
| Requirement Interface Matrix | `docs/product/requirement-interface-matrix.md` | Draft / Approved / N/A | |
|
|
23
|
-
| Difficulty Research | `docs/product/difficulty-research.md` | Draft / Approved / N/A | |
|
|
24
|
-
| Acceptance Examples | `specs/[###-feature-name]/acceptance-examples.md` | Draft / Approved | |
|
|
25
|
-
| Requirements Testability Review | `specs/[###-feature-name]/requirements-testability-review.md` | Draft / Approved | |
|
|
26
|
-
| Verify Matrix | `specs/[###-feature-name]/verify-matrix.md` | Draft / Approved | |
|
|
27
|
-
| Test Strategy | `specs/[###-feature-name]/test-strategy.md` | Draft / Approved | |
|
|
28
|
-
| Test Manifest | `specs/[###-feature-name]/test-manifest.json` | Draft / Approved | Machine-readable mirror for hooks and verify workflows |
|
|
29
|
-
| Design Brief | `docs/design/design-brief.md` | Draft / Approved / N/A | |
|
|
21
|
+
| Acceptance Criteria | `docs/product/acceptance-criteria.md` | Draft / Approved / N/A | |
|
|
22
|
+
| Requirement Interface Matrix | `docs/product/requirement-interface-matrix.md` | Draft / Approved / N/A | |
|
|
23
|
+
| Difficulty Research | `docs/product/difficulty-research.md` | Draft / Approved / N/A | |
|
|
24
|
+
| Acceptance Examples | `specs/[###-feature-name]/acceptance-examples.md` | Draft / Approved | |
|
|
25
|
+
| Requirements Testability Review | `specs/[###-feature-name]/requirements-testability-review.md` | Draft / Approved | |
|
|
26
|
+
| Verify Matrix | `specs/[###-feature-name]/verify-matrix.md` | Draft / Approved | |
|
|
27
|
+
| Test Strategy | `specs/[###-feature-name]/test-strategy.md` | Draft / Approved | |
|
|
28
|
+
| Test Manifest | `specs/[###-feature-name]/test-manifest.json` | Draft / Approved | Machine-readable mirror for hooks and verify workflows |
|
|
29
|
+
| Design Brief | `docs/design/design-brief.md` | Draft / Approved / N/A | |
|
|
30
30
|
| Component Map | `docs/design/component-map.md` | Draft / Approved / N/A | |
|
|
31
31
|
| Screen States | `docs/design/screen-states.md` | Draft / Approved / N/A | |
|
|
32
32
|
| Design Tokens | `docs/design/design-tokens.json` | Draft / Approved / N/A | |
|
|
33
33
|
| AI Image Brief | `docs/design/ai-image-brief.md` | Draft / Approved / N/A | |
|
|
34
34
|
| UI Image Review | `docs/design/ui-image-review.md` | Draft / Approved / N/A | |
|
|
35
|
-
| Image To Frontend Spec | `docs/design/image-to-frontend-spec.md` | Draft / Approved / N/A | |
|
|
36
|
-
| Contract | `contracts/openapi.yaml` | Draft / Approved / N/A | |
|
|
37
|
-
| Project Rules Sync | `AGENTS.md`, `docs/harness/*`, `docs/context/*` | Draft / Approved / N/A | |
|
|
35
|
+
| Image To Frontend Spec | `docs/design/image-to-frontend-spec.md` | Draft / Approved / N/A | |
|
|
36
|
+
| Contract | `contracts/openapi.yaml` | Draft / Approved / N/A | |
|
|
37
|
+
| Project Rules Sync | `AGENTS.md`, `docs/harness/*`, `docs/context/*` | Draft / Approved / N/A | |
|
|
38
38
|
|
|
39
|
-
## Technical Context
|
|
39
|
+
## Technical Context
|
|
40
40
|
|
|
41
41
|
<!--
|
|
42
42
|
ACTION REQUIRED: Replace the content in this section with the technical details
|
|
@@ -51,178 +51,178 @@
|
|
|
51
51
|
**Target Platform**: [e.g., Linux server, iOS 15+, WASM or NEEDS CLARIFICATION]
|
|
52
52
|
**Project Type**: [single/web/mobile - determines source structure]
|
|
53
53
|
**Performance Goals**: [domain-specific, e.g., 1000 req/s, 10k lines/sec, 60 fps or NEEDS CLARIFICATION]
|
|
54
|
-
**Constraints**: [domain-specific, e.g., <200ms p95, <100MB memory, offline-capable or NEEDS CLARIFICATION]
|
|
55
|
-
**Scale/Scope**: [domain-specific, e.g., 10k users, 1M LOC, 50 screens or NEEDS CLARIFICATION]
|
|
56
|
-
|
|
57
|
-
## Delivery Mode Gate
|
|
58
|
-
|
|
59
|
-
> Fill this before implementation planning. If the delivery mode is not locked, mark the plan BLOCKED and return to clarification.
|
|
60
|
-
|
|
61
|
-
| Field | Value | Notes |
|
|
62
|
-
| --- | --- | --- |
|
|
63
|
-
| Delivery Mode | `prototype` / `spike` / `integration` / `production` | Must match `spec.md` |
|
|
64
|
-
| Local mock/sample may close acceptance? | Yes / No | |
|
|
65
|
-
| Formal FRs allowed to close in this mode? | Yes / No | `prototype` / `spike` defaults to No |
|
|
66
|
-
| User-approved downgrade note | | Required when not `integration` / `production` |
|
|
67
|
-
|
|
68
|
-
## OSS Reuse Matrix
|
|
69
|
-
|
|
70
|
-
> For any feature that depends on a predefined open-source stack, existing platform, or third-party system, this matrix is mandatory. If a row is blank, implementation must not start.
|
|
71
|
-
|
|
72
|
-
| Capability / Requirement | Target Ability | Reused OSS / Existing System | Reason Not Reused (if blank) | Integration Layer / Path | Verification / Evidence | Status |
|
|
73
|
-
| --- | --- | --- | --- | --- | --- | --- |
|
|
74
|
-
| FR-001 | | | | | | Planned / Blocked / Ready |
|
|
75
|
-
|
|
76
|
-
## Integration Blockers & Evidence
|
|
77
|
-
|
|
78
|
-
> `TBD-*` items are hard blockers for `integration` / `production` work. A related FR cannot be treated as complete while any linked blocker remains `Open`.
|
|
79
|
-
|
|
80
|
-
| Blocker ID | Related Requirements | Required Dependency / Environment / RBAC / Endpoint | Evidence Path | Owner | Status |
|
|
81
|
-
| --- | --- | --- | --- | --- | --- |
|
|
82
|
-
| TBD-001 | FR-001 | | `docs/evidence/<feature>/tbd-001.md` | | Open / Resolved / N/A |
|
|
83
|
-
|
|
84
|
-
## Connector & Adapter Strategy
|
|
85
|
-
|
|
86
|
-
> Use this section whenever the feature depends on external systems, dashboards, metrics, webhooks, storage, or other runtime integrations.
|
|
87
|
-
|
|
88
|
-
### Connector Boundary
|
|
89
|
-
|
|
90
|
-
- Real integrations go through a connector / interface layer such as `lib/connectors/*`.
|
|
91
|
-
- Separate `sample` / `mock` adapters from `real` adapters; do not let pages, API handlers, or BFF code depend directly on sample JSON or placeholder repositories.
|
|
92
|
-
- UI and API layers should call connector interfaces, not reach into fake repositories as if they were the final implementation.
|
|
93
|
-
|
|
94
|
-
### Planned Structure
|
|
95
|
-
|
|
96
|
-
```text
|
|
97
|
-
lib/
|
|
98
|
-
└── connectors/
|
|
99
|
-
├── interfaces/
|
|
100
|
-
├── sample/
|
|
101
|
-
└── real/
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
## Requirement Completion Gates
|
|
105
|
-
|
|
106
|
-
| Requirement Class | Minimum Completion Gate | Not Enough |
|
|
107
|
-
| --- | --- | --- |
|
|
108
|
-
| `prototype` / `spike` | Local flow works, downgrade recorded, evidence shows demo-only boundary | Claiming formal `FR-*` completion |
|
|
109
|
-
| `integration` | Real dependency connected, real request path proven, success + failure evidence recorded | UI visible, local mock works, unit tests only |
|
|
110
|
-
| `production` | Integration gate passes plus regression, permissions/RBAC, rollout/ops evidence as needed | “Almost real”, ad-hoc manual checks |
|
|
111
|
-
|
|
112
|
-
## Verification Layers
|
|
113
|
-
|
|
114
|
-
| Requirement / Slice | Unit | Integration | Smoke | E2E | Downstream Connectivity | Evidence Note |
|
|
115
|
-
| --- | --- | --- | --- | --- | --- | --- |
|
|
116
|
-
| FR-001 / INT-001 | Required / N/A | Required / N/A | Required / N/A | Required / N/A | Required / N/A | `docs/evidence/<feature>/fr-001.md` |
|
|
117
|
-
|
|
118
|
-
## Testing Left-Shift Truth Sources
|
|
119
|
-
|
|
120
|
-
> Generate these files during `/speckit.plan`. They are feature-local truth sources used by `/speckit.tasks`, `/speckit.analyze`, `/speckit.implement`, `/speckit.verify`, and stop hooks. Do not wait until implementation is complete to define them.
|
|
121
|
-
|
|
122
|
-
### Acceptance Examples
|
|
123
|
-
|
|
124
|
-
Target file: `specs/[###-feature-name]/acceptance-examples.md`
|
|
125
|
-
|
|
126
|
-
| Requirement ID | Scenario ID | Priority | Given | When | Then | Negative / Edge Case | Observable Oracle | Evidence Path |
|
|
127
|
-
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
128
|
-
| FR-001 | AE-001 | P0 | | | | | | `docs/evidence/<feature>/fr-001.md` |
|
|
129
|
-
|
|
130
|
-
### Requirements Testability Review
|
|
131
|
-
|
|
132
|
-
Target file: `specs/[###-feature-name]/requirements-testability-review.md`
|
|
133
|
-
|
|
134
|
-
| Requirement ID | Testability | Missing Input | Required Test Data | Required Environment | Risk | Blocker ID | Decision |
|
|
135
|
-
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
136
|
-
| FR-001 | Ready / Blocked / Needs Clarification / Prototype Only | | | | | TBD-001 / none | Continue / Downgrade / Block |
|
|
137
|
-
|
|
138
|
-
Rules:
|
|
139
|
-
|
|
140
|
-
- If `Testability` is `Blocked`, linked implementation tasks cannot close the related formal `FR-*`.
|
|
141
|
-
- If `Testability` is `Prototype Only`, tasks may close `PROTO-*` / `SPIKE-*` scope, but not formal production/integration requirements.
|
|
142
|
-
|
|
143
|
-
### Verify Matrix
|
|
144
|
-
|
|
145
|
-
Target file: `specs/[###-feature-name]/verify-matrix.md`
|
|
146
|
-
|
|
147
|
-
| Requirement ID | Acceptance Example IDs | Test Layers | Test Files | Required Commands | Evidence Path | Status |
|
|
148
|
-
| --- | --- | --- | --- | --- | --- | --- |
|
|
149
|
-
| FR-001 | AE-001 | unit / integration / e2e / downstream | `TEST-GAP` | `TEST-GAP` | `docs/evidence/<feature>/fr-001.md` | Planned / Ready / Blocked / Verified |
|
|
150
|
-
|
|
151
|
-
Rules:
|
|
152
|
-
|
|
153
|
-
- `integration` / `production` requirements cannot rely on `unit` alone.
|
|
154
|
-
- If a test file or command does not exist yet, write `TEST-GAP` explicitly and explain the gap in the testability review.
|
|
155
|
-
|
|
156
|
-
### Test Strategy
|
|
157
|
-
|
|
158
|
-
Target file: `specs/[###-feature-name]/test-strategy.md`
|
|
159
|
-
|
|
160
|
-
| Field | Value |
|
|
161
|
-
| --- | --- |
|
|
162
|
-
| Detected Stack | |
|
|
163
|
-
| Baseline Commands | |
|
|
164
|
-
| Required Layers | unit / component / contract / integration / e2e / visual / downstream |
|
|
165
|
-
| Affected Test Strategy | |
|
|
166
|
-
| Evidence Directory | `docs/evidence/<feature>/` |
|
|
167
|
-
| Blocking Failures | |
|
|
168
|
-
| Known Gaps | |
|
|
169
|
-
|
|
170
|
-
### Test Manifest
|
|
171
|
-
|
|
172
|
-
Target file: `specs/[###-feature-name]/test-manifest.json`
|
|
173
|
-
|
|
174
|
-
Minimum structure:
|
|
175
|
-
|
|
176
|
-
```json
|
|
177
|
-
{
|
|
178
|
-
"schemaVersion": 1,
|
|
179
|
-
"feature": "[###-feature-name]",
|
|
180
|
-
"deliveryMode": "integration",
|
|
181
|
-
"generatedAt": "YYYY-MM-DDTHH:mm:ssZ",
|
|
182
|
-
"baseline": {
|
|
183
|
-
"commands": [],
|
|
184
|
-
"status": "unknown",
|
|
185
|
-
"evidencePath": "docs/evidence/[###-feature-name]/baseline.md"
|
|
186
|
-
},
|
|
187
|
-
"requirements": [
|
|
188
|
-
{
|
|
189
|
-
"id": "FR-001",
|
|
190
|
-
"testability": "Ready",
|
|
191
|
-
"acceptanceExamples": ["AE-001"],
|
|
192
|
-
"testLayers": ["integration"],
|
|
193
|
-
"testFiles": [],
|
|
194
|
-
"requiredCommands": [],
|
|
195
|
-
"evidencePath": "docs/evidence/[###-feature-name]/fr-001.md",
|
|
196
|
-
"blockers": []
|
|
197
|
-
}
|
|
198
|
-
],
|
|
199
|
-
"gaps": []
|
|
200
|
-
}
|
|
201
|
-
```
|
|
202
|
-
|
|
203
|
-
## Task Decomposition Guide
|
|
204
|
-
|
|
205
|
-
> Fill this before `/speckit.tasks` when the feature includes real integrations, predefined OSS stacks, or external systems.
|
|
206
|
-
|
|
207
|
-
- `integration` / `production` stories should expose progress at blocker/evidence, connector, upper-layer, and final verification boundaries.
|
|
208
|
-
- Do not plan a single task that simultaneously closes blockers, implements real connectors, builds BFF/API/UI, and writes final evidence.
|
|
209
|
-
- Prefer 4-6 acceptance-sized tasks for an integration-heavy story:
|
|
210
|
-
1. readiness / blocker evidence
|
|
211
|
-
2. contract projection / schema mapping
|
|
212
|
-
3. real connector / read-write path skeleton
|
|
213
|
-
4. bridge / policy / metadata / RBAC
|
|
214
|
-
5. BFF / API / UI consumption plus failure states
|
|
215
|
-
6. integration transcript / evidence / regression
|
|
216
|
-
- If the planned story truly remains a single task, record the reason explicitly, such as `prototype-only visual spike` or `single-file blocker note`.
|
|
217
|
-
|
|
218
|
-
## Product & Design Readiness
|
|
54
|
+
**Constraints**: [domain-specific, e.g., <200ms p95, <100MB memory, offline-capable or NEEDS CLARIFICATION]
|
|
55
|
+
**Scale/Scope**: [domain-specific, e.g., 10k users, 1M LOC, 50 screens or NEEDS CLARIFICATION]
|
|
56
|
+
|
|
57
|
+
## Delivery Mode Gate
|
|
58
|
+
|
|
59
|
+
> Fill this before implementation planning. If the delivery mode is not locked, mark the plan BLOCKED and return to clarification.
|
|
60
|
+
|
|
61
|
+
| Field | Value | Notes |
|
|
62
|
+
| --- | --- | --- |
|
|
63
|
+
| Delivery Mode | `prototype` / `spike` / `integration` / `production` | Must match `spec.md` |
|
|
64
|
+
| Local mock/sample may close acceptance? | Yes / No | |
|
|
65
|
+
| Formal FRs allowed to close in this mode? | Yes / No | `prototype` / `spike` defaults to No |
|
|
66
|
+
| User-approved downgrade note | | Required when not `integration` / `production` |
|
|
67
|
+
|
|
68
|
+
## OSS Reuse Matrix
|
|
69
|
+
|
|
70
|
+
> For any feature that depends on a predefined open-source stack, existing platform, or third-party system, this matrix is mandatory. If a row is blank, implementation must not start.
|
|
71
|
+
|
|
72
|
+
| Capability / Requirement | Target Ability | Reused OSS / Existing System | Reason Not Reused (if blank) | Integration Layer / Path | Verification / Evidence | Status |
|
|
73
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
74
|
+
| FR-001 | | | | | | Planned / Blocked / Ready |
|
|
75
|
+
|
|
76
|
+
## Integration Blockers & Evidence
|
|
77
|
+
|
|
78
|
+
> `TBD-*` items are hard blockers for `integration` / `production` work. A related FR cannot be treated as complete while any linked blocker remains `Open`.
|
|
79
|
+
|
|
80
|
+
| Blocker ID | Related Requirements | Required Dependency / Environment / RBAC / Endpoint | Evidence Path | Owner | Status |
|
|
81
|
+
| --- | --- | --- | --- | --- | --- |
|
|
82
|
+
| TBD-001 | FR-001 | | `docs/evidence/<feature>/tbd-001.md` | | Open / Resolved / N/A |
|
|
83
|
+
|
|
84
|
+
## Connector & Adapter Strategy
|
|
85
|
+
|
|
86
|
+
> Use this section whenever the feature depends on external systems, dashboards, metrics, webhooks, storage, or other runtime integrations.
|
|
87
|
+
|
|
88
|
+
### Connector Boundary
|
|
89
|
+
|
|
90
|
+
- Real integrations go through a connector / interface layer such as `lib/connectors/*`.
|
|
91
|
+
- Separate `sample` / `mock` adapters from `real` adapters; do not let pages, API handlers, or BFF code depend directly on sample JSON or placeholder repositories.
|
|
92
|
+
- UI and API layers should call connector interfaces, not reach into fake repositories as if they were the final implementation.
|
|
93
|
+
|
|
94
|
+
### Planned Structure
|
|
95
|
+
|
|
96
|
+
```text
|
|
97
|
+
lib/
|
|
98
|
+
└── connectors/
|
|
99
|
+
├── interfaces/
|
|
100
|
+
├── sample/
|
|
101
|
+
└── real/
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## Requirement Completion Gates
|
|
105
|
+
|
|
106
|
+
| Requirement Class | Minimum Completion Gate | Not Enough |
|
|
107
|
+
| --- | --- | --- |
|
|
108
|
+
| `prototype` / `spike` | Local flow works, downgrade recorded, evidence shows demo-only boundary | Claiming formal `FR-*` completion |
|
|
109
|
+
| `integration` | Real dependency connected, real request path proven, success + failure evidence recorded | UI visible, local mock works, unit tests only |
|
|
110
|
+
| `production` | Integration gate passes plus regression, permissions/RBAC, rollout/ops evidence as needed | “Almost real”, ad-hoc manual checks |
|
|
111
|
+
|
|
112
|
+
## Verification Layers
|
|
113
|
+
|
|
114
|
+
| Requirement / Slice | Unit | Integration | Smoke | E2E | Downstream Connectivity | Evidence Note |
|
|
115
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
116
|
+
| FR-001 / INT-001 | Required / N/A | Required / N/A | Required / N/A | Required / N/A | Required / N/A | `docs/evidence/<feature>/fr-001.md` |
|
|
117
|
+
|
|
118
|
+
## Testing Left-Shift Truth Sources
|
|
119
|
+
|
|
120
|
+
> Generate these files during `/speckit.plan`. They are feature-local truth sources used by `/speckit.tasks`, `/speckit.analyze`, `/speckit.implement`, `/speckit.verify`, and stop hooks. Do not wait until implementation is complete to define them.
|
|
121
|
+
|
|
122
|
+
### Acceptance Examples
|
|
123
|
+
|
|
124
|
+
Target file: `specs/[###-feature-name]/acceptance-examples.md`
|
|
125
|
+
|
|
126
|
+
| Requirement ID | Scenario ID | Priority | Given | When | Then | Negative / Edge Case | Observable Oracle | Evidence Path |
|
|
127
|
+
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
128
|
+
| FR-001 | AE-001 | P0 | | | | | | `docs/evidence/<feature>/fr-001.md` |
|
|
129
|
+
|
|
130
|
+
### Requirements Testability Review
|
|
131
|
+
|
|
132
|
+
Target file: `specs/[###-feature-name]/requirements-testability-review.md`
|
|
133
|
+
|
|
134
|
+
| Requirement ID | Testability | Missing Input | Required Test Data | Required Environment | Risk | Blocker ID | Decision |
|
|
135
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
136
|
+
| FR-001 | Ready / Blocked / Needs Clarification / Prototype Only | | | | | TBD-001 / none | Continue / Downgrade / Block |
|
|
137
|
+
|
|
138
|
+
Rules:
|
|
139
|
+
|
|
140
|
+
- If `Testability` is `Blocked`, linked implementation tasks cannot close the related formal `FR-*`.
|
|
141
|
+
- If `Testability` is `Prototype Only`, tasks may close `PROTO-*` / `SPIKE-*` scope, but not formal production/integration requirements.
|
|
142
|
+
|
|
143
|
+
### Verify Matrix
|
|
144
|
+
|
|
145
|
+
Target file: `specs/[###-feature-name]/verify-matrix.md`
|
|
146
|
+
|
|
147
|
+
| Requirement ID | Acceptance Example IDs | Test Layers | Test Files | Required Commands | Evidence Path | Status |
|
|
148
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
149
|
+
| FR-001 | AE-001 | unit / integration / e2e / downstream | `TEST-GAP` | `TEST-GAP` | `docs/evidence/<feature>/fr-001.md` | Planned / Ready / Blocked / Verified |
|
|
150
|
+
|
|
151
|
+
Rules:
|
|
152
|
+
|
|
153
|
+
- `integration` / `production` requirements cannot rely on `unit` alone.
|
|
154
|
+
- If a test file or command does not exist yet, write `TEST-GAP` explicitly and explain the gap in the testability review.
|
|
155
|
+
|
|
156
|
+
### Test Strategy
|
|
157
|
+
|
|
158
|
+
Target file: `specs/[###-feature-name]/test-strategy.md`
|
|
159
|
+
|
|
160
|
+
| Field | Value |
|
|
161
|
+
| --- | --- |
|
|
162
|
+
| Detected Stack | |
|
|
163
|
+
| Baseline Commands | |
|
|
164
|
+
| Required Layers | unit / component / contract / integration / e2e / visual / downstream |
|
|
165
|
+
| Affected Test Strategy | |
|
|
166
|
+
| Evidence Directory | `docs/evidence/<feature>/` |
|
|
167
|
+
| Blocking Failures | |
|
|
168
|
+
| Known Gaps | |
|
|
169
|
+
|
|
170
|
+
### Test Manifest
|
|
171
|
+
|
|
172
|
+
Target file: `specs/[###-feature-name]/test-manifest.json`
|
|
173
|
+
|
|
174
|
+
Minimum structure:
|
|
175
|
+
|
|
176
|
+
```json
|
|
177
|
+
{
|
|
178
|
+
"schemaVersion": 1,
|
|
179
|
+
"feature": "[###-feature-name]",
|
|
180
|
+
"deliveryMode": "integration",
|
|
181
|
+
"generatedAt": "YYYY-MM-DDTHH:mm:ssZ",
|
|
182
|
+
"baseline": {
|
|
183
|
+
"commands": [],
|
|
184
|
+
"status": "unknown",
|
|
185
|
+
"evidencePath": "docs/evidence/[###-feature-name]/baseline.md"
|
|
186
|
+
},
|
|
187
|
+
"requirements": [
|
|
188
|
+
{
|
|
189
|
+
"id": "FR-001",
|
|
190
|
+
"testability": "Ready",
|
|
191
|
+
"acceptanceExamples": ["AE-001"],
|
|
192
|
+
"testLayers": ["integration"],
|
|
193
|
+
"testFiles": [],
|
|
194
|
+
"requiredCommands": [],
|
|
195
|
+
"evidencePath": "docs/evidence/[###-feature-name]/fr-001.md",
|
|
196
|
+
"blockers": []
|
|
197
|
+
}
|
|
198
|
+
],
|
|
199
|
+
"gaps": []
|
|
200
|
+
}
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
## Task Decomposition Guide
|
|
204
|
+
|
|
205
|
+
> Fill this before `/speckit.tasks` when the feature includes real integrations, predefined OSS stacks, or external systems.
|
|
206
|
+
|
|
207
|
+
- `integration` / `production` stories should expose progress at blocker/evidence, connector, upper-layer, and final verification boundaries.
|
|
208
|
+
- Do not plan a single task that simultaneously closes blockers, implements real connectors, builds BFF/API/UI, and writes final evidence.
|
|
209
|
+
- Prefer 4-6 acceptance-sized tasks for an integration-heavy story:
|
|
210
|
+
1. readiness / blocker evidence
|
|
211
|
+
2. contract projection / schema mapping
|
|
212
|
+
3. real connector / read-write path skeleton
|
|
213
|
+
4. bridge / policy / metadata / RBAC
|
|
214
|
+
5. BFF / API / UI consumption plus failure states
|
|
215
|
+
6. integration transcript / evidence / regression
|
|
216
|
+
- If the planned story truly remains a single task, record the reason explicitly, such as `prototype-only visual spike` or `single-file blocker note`.
|
|
217
|
+
|
|
218
|
+
## Product & Design Readiness
|
|
219
219
|
|
|
220
220
|
> Fill this before implementation planning. If a required artifact is missing, mark the plan BLOCKED instead of letting implementation guess.
|
|
221
221
|
|
|
222
222
|
| Gate | Required Evidence | Status | Blocker / Follow-up |
|
|
223
223
|
| --- | --- | --- | --- |
|
|
224
|
-
| Scope boundary | Goals, non-goals, in-scope, out-of-scope documented | Pass / Fail | |
|
|
225
|
-
| Architecture decision | Module boundaries, data flow, irreversible decisions, and main risks documented | Pass / Fail | |
|
|
224
|
+
| Scope boundary | Goals, non-goals, in-scope, out-of-scope documented | Pass / Fail | |
|
|
225
|
+
| Architecture decision | Module boundaries, data flow, irreversible decisions, and main risks documented | Pass / Fail | |
|
|
226
226
|
| Roles and permissions | Role table and permission matrix documented | Pass / Fail / N/A | |
|
|
227
227
|
| Page inventory | Each page/view/modal/drawer has Page ID | Pass / Fail / N/A | |
|
|
228
228
|
| Requirement-interface mapping | Every P0/P1 requirement maps to pages, states, UI elements, APIs, and acceptance evidence | Pass / Fail / N/A | |
|
|
@@ -234,9 +234,9 @@ Minimum structure:
|
|
|
234
234
|
| Screen states | Each UI state maps to stories/e2e/visual checks | Pass / Fail / N/A | |
|
|
235
235
|
| AI image generation | AI Image Brief covers CSS/tokens and required states | Pass / Fail / N/A | |
|
|
236
236
|
| UI image review | Generated UI images have passed requirement/state/style review | Pass / Fail / N/A | |
|
|
237
|
-
| Image-to-frontend spec | Approved images have been translated into implementable frontend specs | Pass / Fail / N/A | |
|
|
238
|
-
| Contract | API/data contract exists or is explicitly out of scope | Pass / Fail / N/A | |
|
|
239
|
-
| Project rules sync | Long-lived project rule files reflect the confirmed spec and architecture | Pass / Fail / N/A | |
|
|
237
|
+
| Image-to-frontend spec | Approved images have been translated into implementable frontend specs | Pass / Fail / N/A | |
|
|
238
|
+
| Contract | API/data contract exists or is explicitly out of scope | Pass / Fail / N/A | |
|
|
239
|
+
| Project rules sync | Long-lived project rule files reflect the confirmed spec and architecture | Pass / Fail / N/A | |
|
|
240
240
|
|
|
241
241
|
## Constitution Check
|
|
242
242
|
|
|
@@ -249,18 +249,18 @@ Minimum structure:
|
|
|
249
249
|
### Documentation (this feature)
|
|
250
250
|
|
|
251
251
|
```text
|
|
252
|
-
specs/[###-feature]/
|
|
253
|
-
├── plan.md # This file (/speckit.plan command output)
|
|
254
|
-
├── research.md # Phase 0 output (/speckit.plan command)
|
|
255
|
-
├── architecture.md # Phase 1 output (/speckit.plan command)
|
|
256
|
-
├── acceptance-examples.md
|
|
257
|
-
├── requirements-testability-review.md
|
|
258
|
-
├── verify-matrix.md
|
|
259
|
-
├── test-strategy.md
|
|
260
|
-
├── test-manifest.json
|
|
261
|
-
├── data-model.md # Phase 5 output (/speckit.plan command)
|
|
262
|
-
├── quickstart.md # Phase 5 output (/speckit.plan command)
|
|
263
|
-
├── contracts/ # Phase 5 output (/speckit.plan command)
|
|
252
|
+
specs/[###-feature]/
|
|
253
|
+
├── plan.md # This file (/speckit.plan command output)
|
|
254
|
+
├── research.md # Phase 0 output (/speckit.plan command)
|
|
255
|
+
├── architecture.md # Phase 1 output (/speckit.plan command)
|
|
256
|
+
├── acceptance-examples.md
|
|
257
|
+
├── requirements-testability-review.md
|
|
258
|
+
├── verify-matrix.md
|
|
259
|
+
├── test-strategy.md
|
|
260
|
+
├── test-manifest.json
|
|
261
|
+
├── data-model.md # Phase 5 output (/speckit.plan command)
|
|
262
|
+
├── quickstart.md # Phase 5 output (/speckit.plan command)
|
|
263
|
+
├── contracts/ # Phase 5 output (/speckit.plan command)
|
|
264
264
|
├── product-readiness.md # Product truth source gate notes
|
|
265
265
|
├── design-readiness.md # Design to code gate notes
|
|
266
266
|
└── tasks.md # Phase 2 output (/speckit.tasks command - NOT created by /speckit.plan)
|
|
@@ -324,25 +324,25 @@ directories captured above]
|
|
|
324
324
|
|
|
325
325
|
## Phase Plan
|
|
326
326
|
|
|
327
|
-
### Phase 0: Research & Clarification
|
|
328
|
-
|
|
329
|
-
- Resolve open questions:
|
|
330
|
-
- Confirm non-goals:
|
|
331
|
-
- Confirm external dependencies:
|
|
332
|
-
- Lock delivery mode (`prototype` / `spike` / `integration` / `production`)
|
|
333
|
-
- Fill OSS reuse matrix and list all `TBD-*` blockers
|
|
334
|
-
- Output: `research.md`
|
|
335
|
-
|
|
336
|
-
### Phase 1: Architecture
|
|
337
|
-
|
|
338
|
-
- Generate / verify `specs/[###-feature]/architecture.md`
|
|
339
|
-
- Lock module boundaries, data flow, integration points, and key trade-offs
|
|
340
|
-
- Define connector boundaries, sample-vs-real adapter separation, and where the real dependency enters the codebase
|
|
341
|
-
- Identify coupling, migration, concurrency, and contract risks
|
|
342
|
-
- Mark project rule files that must change after architecture is approved
|
|
343
|
-
- Output: `architecture.md`
|
|
344
|
-
|
|
345
|
-
### Phase 2: Product Readiness
|
|
327
|
+
### Phase 0: Research & Clarification
|
|
328
|
+
|
|
329
|
+
- Resolve open questions:
|
|
330
|
+
- Confirm non-goals:
|
|
331
|
+
- Confirm external dependencies:
|
|
332
|
+
- Lock delivery mode (`prototype` / `spike` / `integration` / `production`)
|
|
333
|
+
- Fill OSS reuse matrix and list all `TBD-*` blockers
|
|
334
|
+
- Output: `research.md`
|
|
335
|
+
|
|
336
|
+
### Phase 1: Architecture
|
|
337
|
+
|
|
338
|
+
- Generate / verify `specs/[###-feature]/architecture.md`
|
|
339
|
+
- Lock module boundaries, data flow, integration points, and key trade-offs
|
|
340
|
+
- Define connector boundaries, sample-vs-real adapter separation, and where the real dependency enters the codebase
|
|
341
|
+
- Identify coupling, migration, concurrency, and contract risks
|
|
342
|
+
- Mark project rule files that must change after architecture is approved
|
|
343
|
+
- Output: `architecture.md`
|
|
344
|
+
|
|
345
|
+
### Phase 2: Product Readiness
|
|
346
346
|
|
|
347
347
|
- Update / verify `docs/product/prd-lite.md`
|
|
348
348
|
- Update / verify `docs/product/page-inventory.md`
|
|
@@ -352,42 +352,42 @@ directories captured above]
|
|
|
352
352
|
- Update / verify `docs/product/difficulty-research.md`
|
|
353
353
|
- Output: `product-readiness.md`
|
|
354
354
|
|
|
355
|
-
### Phase 3: Design Readiness
|
|
356
|
-
|
|
357
|
-
- Generate / verify testing truth sources before design/code work proceeds:
|
|
358
|
-
- `acceptance-examples.md`
|
|
359
|
-
- `requirements-testability-review.md`
|
|
360
|
-
- `verify-matrix.md`
|
|
361
|
-
- `test-strategy.md`
|
|
362
|
-
- `test-manifest.json`
|
|
363
|
-
- Mark every P0/P1 requirement as `Ready`, `Blocked`, `Needs Clarification`, or `Prototype Only`.
|
|
364
|
-
- If an `integration` / `production` requirement lacks data, endpoint, RBAC, environment, or evidence path, keep it blocked rather than allowing implementation to guess.
|
|
365
|
-
- Output: testing truth sources and machine-readable `test-manifest.json`
|
|
366
|
-
|
|
367
|
-
### Phase 4: Design Readiness
|
|
368
|
-
|
|
369
|
-
- Update / verify `docs/design/design-brief.md`
|
|
370
|
-
- Update / verify `docs/design/component-map.md`
|
|
371
|
-
- Update / verify `docs/design/screen-states.md`
|
|
355
|
+
### Phase 3: Design Readiness
|
|
356
|
+
|
|
357
|
+
- Generate / verify testing truth sources before design/code work proceeds:
|
|
358
|
+
- `acceptance-examples.md`
|
|
359
|
+
- `requirements-testability-review.md`
|
|
360
|
+
- `verify-matrix.md`
|
|
361
|
+
- `test-strategy.md`
|
|
362
|
+
- `test-manifest.json`
|
|
363
|
+
- Mark every P0/P1 requirement as `Ready`, `Blocked`, `Needs Clarification`, or `Prototype Only`.
|
|
364
|
+
- If an `integration` / `production` requirement lacks data, endpoint, RBAC, environment, or evidence path, keep it blocked rather than allowing implementation to guess.
|
|
365
|
+
- Output: testing truth sources and machine-readable `test-manifest.json`
|
|
366
|
+
|
|
367
|
+
### Phase 4: Design Readiness
|
|
368
|
+
|
|
369
|
+
- Update / verify `docs/design/design-brief.md`
|
|
370
|
+
- Update / verify `docs/design/component-map.md`
|
|
371
|
+
- Update / verify `docs/design/screen-states.md`
|
|
372
372
|
- Update / verify `docs/design/design-tokens.json`
|
|
373
373
|
- Generate / verify `docs/design/ai-image-brief.md`
|
|
374
374
|
- Review generated UI images with `docs/design/ui-image-review.md`
|
|
375
|
-
- Translate approved images to `docs/design/image-to-frontend-spec.md`
|
|
376
|
-
- Output: `design-readiness.md`
|
|
377
|
-
|
|
378
|
-
### Phase 5: Contracts & Data
|
|
379
|
-
|
|
380
|
-
- Generate / update data model
|
|
381
|
-
- Generate / update API contracts
|
|
382
|
-
- Confirm error, enum, pagination and permission semantics
|
|
383
|
-
- Resolve or explicitly document every `TBD-*` blocker that gates real integration
|
|
384
|
-
- Attach evidence paths for environments, endpoints, RBAC, dashboards, metrics, or webhook contracts
|
|
385
|
-
- Output: `data-model.md`, `contracts/`, `quickstart.md`
|
|
386
|
-
|
|
387
|
-
### Phase 6: Rules & Context Sync
|
|
388
|
-
|
|
389
|
-
- Update project root `AGENTS.md` when the feature introduces new stable rules
|
|
390
|
-
- Update `docs/harness/*` when workflow, gate, verification, or collaboration rules changed
|
|
391
|
-
- Update `docs/context/*` when architecture/dev-plan context changed
|
|
392
|
-
- Run agent context update script after rule sync
|
|
393
|
-
- Output: updated project rules and agent context
|
|
375
|
+
- Translate approved images to `docs/design/image-to-frontend-spec.md`
|
|
376
|
+
- Output: `design-readiness.md`
|
|
377
|
+
|
|
378
|
+
### Phase 5: Contracts & Data
|
|
379
|
+
|
|
380
|
+
- Generate / update data model
|
|
381
|
+
- Generate / update API contracts
|
|
382
|
+
- Confirm error, enum, pagination and permission semantics
|
|
383
|
+
- Resolve or explicitly document every `TBD-*` blocker that gates real integration
|
|
384
|
+
- Attach evidence paths for environments, endpoints, RBAC, dashboards, metrics, or webhook contracts
|
|
385
|
+
- Output: `data-model.md`, `contracts/`, `quickstart.md`
|
|
386
|
+
|
|
387
|
+
### Phase 6: Rules & Context Sync
|
|
388
|
+
|
|
389
|
+
- Update project root `AGENTS.md` when the feature introduces new stable rules
|
|
390
|
+
- Update `docs/harness/*` when workflow, gate, verification, or collaboration rules changed
|
|
391
|
+
- Update `docs/context/*` when architecture/dev-plan context changed
|
|
392
|
+
- Run agent context update script after rule sync
|
|
393
|
+
- Output: updated project rules and agent context
|