@williambeto/ai-workflow 1.19.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +56 -837
- package/PUBLISH_MANIFEST.json +34 -0
- package/README.md +70 -149
- package/{packages/ai-workflow/bin → bin}/ai-workflow.js +0 -0
- package/dist-assets/AGENTS.md +27 -0
- package/dist-assets/agents/astra.md +63 -0
- package/dist-assets/agents/atlas.md +169 -0
- package/dist-assets/agents/nexus.md +42 -0
- package/dist-assets/agents/orion.md +44 -0
- package/dist-assets/agents/phoenix.md +42 -0
- package/dist-assets/agents/sage.md +54 -0
- package/dist-assets/commands/README.md +14 -0
- package/dist-assets/commands/atlas.md +12 -0
- package/dist-assets/commands/audit.md +10 -0
- package/dist-assets/commands/deploy.md +12 -0
- package/dist-assets/commands/discover.md +10 -0
- package/dist-assets/commands/implement.md +28 -0
- package/dist-assets/commands/optimize-tokens.md +10 -0
- package/dist-assets/commands/plan.md +10 -0
- package/dist-assets/commands/release.md +12 -0
- package/dist-assets/commands/run.md +26 -0
- package/dist-assets/commands/spec-create.md +10 -0
- package/dist-assets/commands/spec-implement.md +10 -0
- package/dist-assets/commands/spec-review.md +10 -0
- package/dist-assets/commands/update-memory.md +10 -0
- package/dist-assets/commands/validate.md +12 -0
- package/dist-assets/docs/INDEX.md +21 -0
- package/dist-assets/docs/QUICKSTART.md +23 -0
- package/dist-assets/docs/adr/ADR-0000.md +19 -0
- package/dist-assets/docs/adr/ADR-0001.md +45 -0
- package/dist-assets/docs/adr/ADR-0002.md +62 -0
- package/dist-assets/docs/adr/ADR-0003.md +60 -0
- package/dist-assets/docs/adr/ADR-0004.md +71 -0
- package/dist-assets/docs/adr/ADR-0005.md +22 -0
- package/dist-assets/docs/adr/ADR-0006.md +82 -0
- package/dist-assets/docs/adr/ADR-0007.md +78 -0
- package/dist-assets/docs/api-engine-reference.md +7 -0
- package/{docs → dist-assets/docs}/architecture-policy.md +1 -1
- package/dist-assets/docs/cli-reference.md +27 -0
- package/dist-assets/docs/compatibility/provider-usage.md +38 -0
- package/dist-assets/docs/compatibility/runtime-matrix.md +30 -0
- package/dist-assets/docs/consumer-onboarding.md +17 -0
- package/dist-assets/docs/contributing-guide.md +11 -0
- package/{docs → dist-assets/docs}/design-patterns-policy.md +2 -2
- package/dist-assets/docs/full-documentation.md +113 -0
- package/{docs → dist-assets/docs}/npm-consumer-quickstart.md +18 -46
- package/dist-assets/docs/opencode-readme.md +8 -0
- package/dist-assets/docs/policies/01-BRANCH_GATE.md +63 -0
- package/dist-assets/docs/policies/02-SDD_METHODOLOGY.md +95 -0
- package/dist-assets/docs/policies/03-QUALITY_GATE.md +22 -0
- package/dist-assets/docs/policies/05-AGENT_CONTRACT.md +7 -0
- package/dist-assets/docs/policies/06-FINAL_EVIDENCE_CONTRACT.md +31 -0
- package/dist-assets/docs/policies/07-RELEASE_GATE.md +47 -0
- package/dist-assets/docs/policies/08-PRODUCT_TRUTHFULNESS_AND_PROJECT_DOCS.md +18 -0
- package/dist-assets/docs/policies/09-SPEC_VISIBILITY_AND_PUBLICATION.md +28 -0
- package/dist-assets/docs/policies/10-BEHAVIORAL_CONTRACT_HARDENING.md +9 -0
- package/dist-assets/docs/policies/11-EXECUTABLE_DELEGATION_AND_TRUTHFULNESS.md +7 -0
- package/dist-assets/docs/policies/ORCHESTRATION_PROTOCOL.md +15 -0
- package/dist-assets/docs/policies/PROCEDURE_DELIVERY_ARTIFACTS.md +21 -0
- package/dist-assets/docs/policies/PROCEDURE_DOCUMENTATION_CHECKLIST.md +24 -0
- package/dist-assets/docs/policies/PROCEDURE_UI_CHECKLIST.md +54 -0
- package/dist-assets/docs/profiles/README.md +19 -0
- package/dist-assets/docs/profiles/backend-api.md +5 -0
- package/dist-assets/docs/profiles/documentation.md +3 -0
- package/dist-assets/docs/profiles/frontend-product.md +19 -0
- package/dist-assets/docs/profiles/frontend-utility.md +19 -0
- package/dist-assets/docs/profiles/refactor.md +3 -0
- package/dist-assets/docs/profiles/security-review.md +3 -0
- package/dist-assets/docs/references/frontend-quality/landing-page-quality-checklist.md +11 -0
- package/dist-assets/docs/references/frontend-quality/product-copy-truthfulness.md +7 -0
- package/dist-assets/docs/references/frontend-quality/quality-failure-examples.md +20 -0
- package/dist-assets/docs/references/frontend-quality/visual-composition-patterns.md +10 -0
- package/dist-assets/docs/specs/runtime-operational-contract.md +39 -0
- package/dist-assets/docs/troubleshooting-guide.md +21 -0
- package/dist-assets/examples/README.md +10 -0
- package/dist-assets/examples/autopilot-cycle/00-CONTEXT.md +3 -0
- package/dist-assets/examples/autopilot-cycle/01-requirement.md +16 -0
- package/dist-assets/examples/autopilot-cycle/02-gate-a-check.md +23 -0
- package/dist-assets/examples/autopilot-cycle/03-orion-planning.md +20 -0
- package/dist-assets/examples/autopilot-cycle/04-astra-implementation.md +17 -0
- package/dist-assets/examples/autopilot-cycle/05-sage-validation.md +15 -0
- package/dist-assets/examples/autopilot-cycle/06-phoenix-healing.md +12 -0
- package/dist-assets/examples/autopilot-cycle/07-orchestration-report.md +18 -0
- package/dist-assets/examples/backend-api/00-CONTEXT.md +12 -0
- package/dist-assets/examples/backend-api/01-requirement.md +19 -0
- package/dist-assets/examples/backend-api/02-functional-spec.md +20 -0
- package/dist-assets/examples/backend-api/03-technical-plan.md +15 -0
- package/dist-assets/examples/backend-api/04-pr-breakdown.md +10 -0
- package/dist-assets/examples/backend-api/05-execution-handoff.md +13 -0
- package/dist-assets/examples/backend-api/06-validation-report.md +11 -0
- package/dist-assets/examples/backend-api/07-orchestration-report.md +7 -0
- package/dist-assets/examples/blocked-scenarios/00-CONTEXT.md +9 -0
- package/dist-assets/examples/blocked-scenarios/01-branch-gate-block.md +12 -0
- package/dist-assets/examples/blocked-scenarios/02-quality-gate-block.md +13 -0
- package/dist-assets/examples/blocked-scenarios/03-scope-creep-block.md +13 -0
- package/dist-assets/examples/blocked-scenarios/04-unblock-resolution.md +9 -0
- package/dist-assets/examples/blocked-scenarios/05-orchestration-decision-log.md +11 -0
- package/dist-assets/examples/bugfix-critical/00-CONTEXT.md +12 -0
- package/dist-assets/examples/bugfix-critical/01-bug-report.md +11 -0
- package/dist-assets/examples/bugfix-critical/02-diagnosis-hypothesis.md +11 -0
- package/dist-assets/examples/bugfix-critical/03-technical-plan.md +12 -0
- package/dist-assets/examples/bugfix-critical/04-implementation-handoff.md +8 -0
- package/dist-assets/examples/bugfix-critical/05-validation-report.md +10 -0
- package/dist-assets/examples/bugfix-critical/06-orchestration-report.md +7 -0
- package/dist-assets/examples/cli-package/00-CONTEXT.md +9 -0
- package/dist-assets/examples/cli-package/01-requirement.md +14 -0
- package/dist-assets/examples/cli-package/02-technical-spec.md +16 -0
- package/dist-assets/examples/cli-package/03-technical-plan.md +12 -0
- package/dist-assets/examples/cli-package/04-pr-breakdown.md +9 -0
- package/dist-assets/examples/cli-package/05-release-report.md +15 -0
- package/dist-assets/examples/docs-only-repo/01-requirement.md +31 -0
- package/dist-assets/examples/docs-only-repo/02-functional-spec.md +25 -0
- package/dist-assets/examples/docs-only-repo/03-technical-plan.md +21 -0
- package/dist-assets/examples/docs-only-repo/04-pr-breakdown.md +13 -0
- package/dist-assets/examples/docs-only-repo/05-execution-handoff.md +17 -0
- package/dist-assets/examples/docs-only-repo/06-validation-report.md +16 -0
- package/dist-assets/examples/docs-only-repo/README.md +26 -0
- package/dist-assets/examples/full-stack-checkout/00-CONTEXT.md +9 -0
- package/dist-assets/examples/full-stack-checkout/01-requirement.md +12 -0
- package/dist-assets/examples/full-stack-checkout/02-functional-spec.md +15 -0
- package/dist-assets/examples/full-stack-checkout/03-technical-plan.md +15 -0
- package/dist-assets/examples/full-stack-checkout/04-pr-breakdown.md +8 -0
- package/dist-assets/examples/full-stack-checkout/05-execution-handoff.md +14 -0
- package/dist-assets/examples/full-stack-checkout/06-validation-report.md +12 -0
- package/dist-assets/examples/healing-cycle/00-CONTEXT.md +15 -0
- package/dist-assets/examples/healing-cycle/01-broken-implementation.md +10 -0
- package/dist-assets/examples/healing-cycle/02-sage-fails.md +14 -0
- package/dist-assets/examples/healing-cycle/03-phoenix-diagnosis.md +17 -0
- package/dist-assets/examples/healing-cycle/04-phoenix-fix.md +18 -0
- package/dist-assets/examples/healing-cycle/05-sage-revalidation.md +12 -0
- package/dist-assets/examples/healing-cycle/06-orchestration-log.md +14 -0
- package/dist-assets/examples/infra-deploy/00-CONTEXT.md +9 -0
- package/dist-assets/examples/infra-deploy/01-operational-goal.md +12 -0
- package/dist-assets/examples/infra-deploy/02-architecture-specs.md +15 -0
- package/dist-assets/examples/infra-deploy/03-implementation-plan.md +14 -0
- package/dist-assets/examples/infra-deploy/04-step-breakdown.md +9 -0
- package/dist-assets/examples/infra-deploy/05-execution-handoff.md +13 -0
- package/dist-assets/examples/infra-deploy/06-operational-report.md +11 -0
- package/dist-assets/examples/multi-pr-release/00-CONTEXT.md +9 -0
- package/dist-assets/examples/multi-pr-release/01-requirement.md +13 -0
- package/dist-assets/examples/multi-pr-release/02-strategic-plan.md +13 -0
- package/dist-assets/examples/multi-pr-release/03-pr-breakdown.md +14 -0
- package/dist-assets/examples/multi-pr-release/04-release-plan.md +12 -0
- package/dist-assets/examples/multi-pr-release/05-orchestration-report.md +7 -0
- package/dist-assets/examples/nuxt-dashboard/01-requirement.md +81 -0
- package/dist-assets/examples/nuxt-dashboard/02-functional-spec.md +88 -0
- package/dist-assets/examples/nuxt-dashboard/03-technical-plan.md +76 -0
- package/dist-assets/examples/nuxt-dashboard/04-pr-breakdown.md +219 -0
- package/dist-assets/examples/nuxt-dashboard/05-execution-handoff.md +88 -0
- package/dist-assets/examples/nuxt-dashboard/06-validation-report.md +56 -0
- package/dist-assets/examples/nuxt-dashboard/07-orchestration-report.md +79 -0
- package/dist-assets/examples/nuxt-dashboard/README.md +52 -0
- package/dist-assets/examples/react-dashboard/01-requirement.md +84 -0
- package/dist-assets/examples/react-dashboard/02-functional-spec.md +88 -0
- package/dist-assets/examples/react-dashboard/03-technical-plan.md +76 -0
- package/dist-assets/examples/react-dashboard/04-pr-breakdown.md +218 -0
- package/dist-assets/examples/react-dashboard/05-execution-handoff.md +13 -0
- package/dist-assets/examples/react-dashboard/06-validation-report.md +12 -0
- package/dist-assets/examples/react-dashboard/07-orchestration-report.md +7 -0
- package/dist-assets/examples/react-dashboard/README.md +70 -0
- package/dist-assets/examples/refactoring-service/00-CONTEXT.md +9 -0
- package/dist-assets/examples/refactoring-service/01-debt-report.md +12 -0
- package/dist-assets/examples/refactoring-service/02-behavior-spec.md +11 -0
- package/dist-assets/examples/refactoring-service/03-technical-plan.md +13 -0
- package/dist-assets/examples/refactoring-service/04-pr-breakdown.md +9 -0
- package/dist-assets/examples/refactoring-service/05-execution-handoff.md +14 -0
- package/dist-assets/examples/refactoring-service/06-stability-report.md +12 -0
- package/dist-assets/examples/sdd-cycle/00-CONTEXT.md +12 -0
- package/dist-assets/examples/sdd-cycle/01-raw-request.md +13 -0
- package/dist-assets/examples/sdd-cycle/02-spec-creation.md +18 -0
- package/dist-assets/examples/sdd-cycle/03-spec-review.md +12 -0
- package/dist-assets/examples/sdd-cycle/04-technical-plan.md +16 -0
- package/dist-assets/examples/sdd-cycle/05-pr-breakdown.md +9 -0
- package/dist-assets/examples/sdd-cycle/06-spec-implement.md +13 -0
- package/dist-assets/examples/sdd-cycle/07-validation-against-spec.md +13 -0
- package/dist-assets/examples/wordpress-theme/01-requirement.md +29 -0
- package/dist-assets/examples/wordpress-theme/02-functional-spec.md +22 -0
- package/dist-assets/examples/wordpress-theme/03-technical-plan.md +22 -0
- package/dist-assets/examples/wordpress-theme/04-pr-breakdown.md +14 -0
- package/dist-assets/examples/wordpress-theme/05-execution-handoff.md +17 -0
- package/dist-assets/examples/wordpress-theme/06-validation-report.md +16 -0
- package/dist-assets/examples/wordpress-theme/README.md +32 -0
- package/{harness → dist-assets/harness}/handoffs/HANDOFF.template.md +2 -2
- package/{harness → dist-assets/harness}/workflows/agent-evaluation-checklist.md +5 -5
- package/{harness → dist-assets/harness}/workflows/implement-review-validate.md +24 -0
- package/{harness → dist-assets/harness}/workflows/multi-agent-handoff.md +4 -4
- package/{harness → dist-assets/harness}/workflows/planner-executor-workflow.md +5 -5
- package/{harness → dist-assets/harness}/workflows/requirement-to-pr.md +1 -1
- package/dist-assets/runbooks/agent-delegation-workflow.md +50 -0
- package/dist-assets/runbooks/apply-starter-to-real-project.md +45 -0
- package/dist-assets/runbooks/commands-cheatsheet.md +44 -0
- package/dist-assets/runbooks/how-to-use-skills.md +44 -0
- package/dist-assets/runbooks/private-spec-publication-safety.md +35 -0
- package/{runbooks → dist-assets/runbooks}/spec-driven-development.md +3 -6
- package/dist-assets/runbooks/tutorial-walkthroughs.md +23 -0
- package/dist-assets/runbooks/use-linear-for-operational-planning.md +45 -0
- package/dist-assets/runbooks/use-napkin-project-memory.md +33 -0
- package/dist-assets/skills/architecture/SKILL.md +166 -0
- package/dist-assets/skills/backend-development/SKILL.md +166 -0
- package/dist-assets/skills/deployment/SKILL.md +166 -0
- package/dist-assets/skills/design-principles/SKILL.md +166 -0
- package/dist-assets/skills/documentation/SKILL.md +171 -0
- package/dist-assets/skills/frontend-development/SKILL.md +225 -0
- package/dist-assets/skills/full-stack-development/SKILL.md +166 -0
- package/dist-assets/skills/optimize-tokens/SKILL.md +166 -0
- package/dist-assets/skills/pr-workflow/SKILL.md +166 -0
- package/dist-assets/skills/product-discovery/SKILL.md +166 -0
- package/dist-assets/skills/product-planning/SKILL.md +166 -0
- package/dist-assets/skills/project-memory/SKILL.md +166 -0
- package/dist-assets/skills/prompt-engineer/SKILL.md +166 -0
- package/dist-assets/skills/qa-workflow/SKILL.md +186 -0
- package/dist-assets/skills/refactoring/SKILL.md +166 -0
- package/dist-assets/skills/release-workflow/SKILL.md +166 -0
- package/dist-assets/skills/spec-driven-development/SKILL.md +166 -0
- package/dist-assets/skills/technical-leadership/SKILL.md +166 -0
- package/dist-assets/skills/ui-ux-design/SKILL.md +202 -0
- package/dist-assets/templates/.geminiignore.template +8 -0
- package/dist-assets/templates/CLAUDE.md.template +20 -0
- package/dist-assets/templates/CODEX.md.template +20 -0
- package/dist-assets/templates/GEMINI.md.template +20 -0
- package/dist-assets/templates/HANDOFF.template.md +45 -0
- package/dist-assets/templates/SPEC.template.md +38 -0
- package/dist-assets/templates/change-proposal.template.md +14 -0
- package/dist-assets/templates/owner-evidence/astra-implementation.json +10 -0
- package/dist-assets/templates/owner-evidence/phoenix-remediation.json +8 -0
- package/dist-assets/templates/owner-evidence/sage-revalidation.json +8 -0
- package/dist-assets/templates/owner-evidence/sage-validation.json +8 -0
- package/dist-assets/templates/specs/deep.md +48 -0
- package/dist-assets/templates/specs/standard.md +38 -0
- package/dist-assets/templates/specs/tiny.md +19 -0
- package/package.json +42 -47
- package/src/adapters/index.js +3 -0
- package/src/adapters/platforms/claude.js +126 -0
- package/src/adapters/platforms/codex.js +100 -0
- package/src/adapters/platforms/gemini.js +232 -0
- package/src/cli.js +96 -0
- package/src/commands/collect-evidence.js +61 -0
- package/src/commands/doctor.js +186 -0
- package/{packages/ai-workflow/src → src}/commands/init.js +119 -20
- package/src/commands/run.js +111 -0
- package/src/core/completion-contract.js +35 -0
- package/src/core/gates/branch-gate.js +113 -0
- package/src/core/handoff/handoff-engine.js +78 -0
- package/src/core/healing/cli-remediation-executor.js +151 -0
- package/src/core/healing/healer-engine.js +179 -0
- package/src/core/identity.js +43 -0
- package/{packages/ai-workflow/src → src}/core/install-plan.js +3 -3
- package/src/core/opencode-merge.js +149 -0
- package/{packages/ai-workflow/src → src}/core/package-assets.js +29 -10
- package/src/core/sdd/validator.js +67 -0
- package/src/core/statuses.js +29 -0
- package/src/core/symlink-layout.js +93 -0
- package/src/core/templates.js +218 -0
- package/src/core/validation/canonical-finalization.js +43 -0
- package/src/core/validation/evidence-collector.js +109 -0
- package/src/core/validation/quality-guard.js +243 -0
- package/src/core/workflow-profiles.js +107 -0
- package/.agents/napkin.md +0 -89
- package/.agents/skills/backend-implementer/SKILL.md +0 -490
- package/.agents/skills/build-and-validate/SKILL.md +0 -442
- package/.agents/skills/deploy-engineer/SKILL.md +0 -541
- package/.agents/skills/docs-writer/SKILL.md +0 -430
- package/.agents/skills/frontend-implementer/SKILL.md +0 -488
- package/.agents/skills/interface-design/SKILL.md +0 -428
- package/.agents/skills/interface-design/references/critique.md +0 -67
- package/.agents/skills/interface-design/references/example.md +0 -86
- package/.agents/skills/interface-design/references/principles.md +0 -235
- package/.agents/skills/interface-design/references/validation.md +0 -48
- package/.agents/skills/minimal-context/SKILL.md +0 -177
- package/.agents/skills/napkin/SKILL.md +0 -84
- package/.agents/skills/opencode-agent-design/SKILL.md +0 -77
- package/.agents/skills/playwright-cli/SKILL.md +0 -62
- package/.agents/skills/pr-orchestrator/SKILL.md +0 -366
- package/.agents/skills/product-manager/SKILL.md +0 -519
- package/.agents/skills/seo-audit/SKILL.md +0 -176
- package/.agents/skills/stack-variant-creator/SKILL.md +0 -265
- package/.agents/skills/tech-lead/SKILL.md +0 -453
- package/.agents/skills/tester/SKILL.md +0 -399
- package/.agents/skills/token-economy/SKILL.md +0 -137
- package/.agents/skills/vue-nuxt/SKILL.md +0 -102
- package/.agents/skills/wordpress-engineer/SKILL.md +0 -75
- package/.codex/prompts/README.md +0 -44
- package/.codex/prompts/autopilot.md +0 -50
- package/.codex/prompts/deploy.md +0 -33
- package/.codex/prompts/execute-selected-pr.md +0 -35
- package/.codex/prompts/fix-issue.md +0 -34
- package/.codex/prompts/minimal-context-mode.md +0 -55
- package/.codex/prompts/orchestrate-next.md +0 -33
- package/.codex/prompts/plan-from-requirement.md +0 -37
- package/.codex/prompts/review-implementation.md +0 -33
- package/.codex/prompts/roadmap-audit.md +0 -22
- package/.codex/prompts/specs/create-spec-from-requirement.md +0 -26
- package/.codex/prompts/specs/review-spec.md +0 -29
- package/.codex/prompts/specs/spec-to-pr-breakdown.md +0 -23
- package/.codex/prompts/specs/spec-to-technical-plan.md +0 -28
- package/.codex/prompts/start-project.md +0 -29
- package/.codex/prompts/token-economy-mode.md +0 -48
- package/.codex/prompts/validate-work.md +0 -28
- package/checklists/change-spec-readiness-checklist.md +0 -34
- package/docs/full-documentation.md +0 -661
- package/docs/setup-codex-opencode.md +0 -313
- package/harness/README.md +0 -106
- package/opencode/README.md +0 -84
- package/opencode/agents/README.md +0 -113
- package/opencode/agents/atlas.md +0 -127
- package/opencode/agents/discovery.md +0 -61
- package/opencode/agents/fixer.md +0 -51
- package/opencode/agents/implementer.md +0 -61
- package/opencode/agents/orchestrator.md +0 -145
- package/opencode/agents/planner.md +0 -60
- package/opencode/agents/prompt-engineer.md +0 -50
- package/opencode/agents/release-manager.md +0 -50
- package/opencode/agents/reviewer.md +0 -51
- package/opencode/agents/spec-engineer.md +0 -85
- package/opencode/agents/validator.md +0 -50
- package/opencode/agents/wordpress-engineer.md +0 -49
- package/opencode/commands/README.md +0 -48
- package/opencode/commands/autopilot.md +0 -50
- package/opencode/commands/deploy.md +0 -35
- package/opencode/commands/execute.md +0 -47
- package/opencode/commands/orchestrate.md +0 -37
- package/opencode/commands/plan.md +0 -39
- package/opencode/commands/review.md +0 -33
- package/opencode/commands/roadmap-audit.md +0 -30
- package/opencode/commands/ship.md +0 -48
- package/opencode/commands/specs/create-spec-from-request.md +0 -27
- package/opencode/commands/specs/create-spec-from-requirement.md +0 -25
- package/opencode/commands/specs/review-spec.md +0 -26
- package/opencode/commands/specs/spec-to-pr-breakdown.md +0 -19
- package/opencode/commands/specs/spec-to-tasks.md +0 -26
- package/opencode/commands/specs/spec-to-technical-plan.md +0 -27
- package/opencode/commands/start.md +0 -45
- package/opencode/commands/token-economy.md +0 -29
- package/opencode/commands/validate.md +0 -33
- package/opencode.jsonc +0 -235
- package/packages/ai-workflow/README.md +0 -82
- package/packages/ai-workflow/src/cli.js +0 -70
- package/packages/ai-workflow/src/commands/codex.js +0 -37
- package/packages/ai-workflow/src/commands/doctor.js +0 -168
- package/packages/ai-workflow/src/commands/guide.js +0 -194
- package/packages/ai-workflow/src/core/opencode-merge.js +0 -172
- package/packages/ai-workflow/src/core/symlink-layout.js +0 -54
- package/packages/ai-workflow/src/core/templates.js +0 -275
- package/runbooks/agent-delegation-workflow.md +0 -111
- package/runbooks/apply-starter-to-real-project.md +0 -445
- package/runbooks/commands-cheatsheet.md +0 -71
- package/runbooks/how-to-use-skills.md +0 -713
- package/runbooks/quick-start-guide.md +0 -213
- package/runbooks/tutorial-walkthroughs.md +0 -416
- package/runbooks/use-linear-for-operational-planning.md +0 -185
- package/runbooks/use-napkin-project-memory.md +0 -77
- package/templates/AGENTS.template.md +0 -397
- package/templates/DESIGN.template.md +0 -484
- package/templates/PR-PLAN.template.md +0 -172
- package/templates/README.template.md +0 -293
- package/templates/REQUIREMENT.template.md +0 -165
- package/templates/SPEC.template.md +0 -397
- package/templates/TECH-PLAN.template.md +0 -244
- package/templates/change-proposal.template.md +0 -97
- /package/{checklists/spec-readiness-checklist.md → dist-assets/docs/policies/SPEC_READINESS.md} +0 -0
- /package/{prompts → dist-assets/prompts}/00-bootstrap-project.md +0 -0
- /package/{prompts → dist-assets/prompts}/01-create-requirement.md +0 -0
- /package/{prompts → dist-assets/prompts}/02-create-spec.md +0 -0
- /package/{prompts → dist-assets/prompts}/03-create-tech-plan.md +0 -0
- /package/{prompts → dist-assets/prompts}/04-breakdown-prs.md +0 -0
- /package/{prompts → dist-assets/prompts}/05-implement-pr.md +0 -0
- /package/{prompts → dist-assets/prompts}/06-review-and-fix.md +0 -0
- /package/{prompts → dist-assets/prompts}/07-apply-design.md +0 -0
- /package/{prompts → dist-assets/prompts}/08-validate.md +0 -0
- /package/{prompts → dist-assets/prompts}/09-deploy.md +0 -0
- /package/{prompts → dist-assets/prompts}/commands/implement.md +0 -0
- /package/{prompts → dist-assets/prompts}/commands/requirement.md +0 -0
- /package/{prompts → dist-assets/prompts}/commands/spec.md +0 -0
- /package/{prompts → dist-assets/prompts}/commands/tech-plan.md +0 -0
- /package/{prompts → dist-assets/prompts}/commands/validate.md +0 -0
- /package/{runbooks → dist-assets/runbooks}/branch-cleanup.md +0 -0
- /package/{runbooks → dist-assets/runbooks}/deploy-checklist.md +0 -0
- /package/{runbooks → dist-assets/runbooks}/publication-readiness-checklist.md +0 -0
- /package/{runbooks → dist-assets/runbooks}/publish-package-checklist.md +0 -0
- /package/{runbooks → dist-assets/runbooks}/team-governance-pr-readiness.md +0 -0
- /package/{runbooks → dist-assets/runbooks}/validate-starter-in-real-project.md +0 -0
- /package/{runbooks → dist-assets/runbooks}/validation-checklist.md +0 -0
- /package/{schemas → dist-assets/schemas}/README.md +0 -0
- /package/{schemas → dist-assets/schemas}/functional-spec.schema.json +0 -0
- /package/{schemas → dist-assets/schemas}/handoff.schema.json +0 -0
- /package/{schemas → dist-assets/schemas}/pr-breakdown.schema.json +0 -0
- /package/{schemas → dist-assets/schemas}/requirement.schema.json +0 -0
- /package/{schemas → dist-assets/schemas}/technical-plan.schema.json +0 -0
- /package/{schemas → dist-assets/schemas}/validation-report.schema.json +0 -0
- /package/{packages/ai-workflow/src → src}/core/backup.js +0 -0
- /package/{packages/ai-workflow/src → src}/core/filesystem.js +0 -0
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Technical Plan
|
|
2
|
+
|
|
3
|
+
## Current state
|
|
4
|
+
Theme uses inline markup in archive templates, making reuse and review difficult.
|
|
5
|
+
|
|
6
|
+
## Proposed approach
|
|
7
|
+
- Create `template-parts/product-card.php`.
|
|
8
|
+
- Update archive template to call template part.
|
|
9
|
+
- Add safe fallback for empty query.
|
|
10
|
+
|
|
11
|
+
## Files likely to change
|
|
12
|
+
- `archive-product.php`
|
|
13
|
+
- `template-parts/product-card.php`
|
|
14
|
+
|
|
15
|
+
## Validation
|
|
16
|
+
- PHP syntax check
|
|
17
|
+
- Manual render check in shop archive
|
|
18
|
+
- Empty query render check
|
|
19
|
+
|
|
20
|
+
## Risks
|
|
21
|
+
- WooCommerce hook context mismatch.
|
|
22
|
+
- Escaping omissions in template part.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# PR Breakdown
|
|
2
|
+
|
|
3
|
+
## PR 1 — Extract product-card template part
|
|
4
|
+
- Create template part file
|
|
5
|
+
- Replace inline card markup
|
|
6
|
+
- Validate render output
|
|
7
|
+
|
|
8
|
+
## PR 2 — Add empty-state and accessibility polish
|
|
9
|
+
- Add empty-state branch
|
|
10
|
+
- Refine heading/link semantics
|
|
11
|
+
- Validate no regression
|
|
12
|
+
|
|
13
|
+
## Recommended first PR
|
|
14
|
+
PR 1 (core extraction, low risk, easy review).
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Execution Handoff
|
|
2
|
+
|
|
3
|
+
## Objective
|
|
4
|
+
Implement PR 1 to extract a reusable product-card template part.
|
|
5
|
+
|
|
6
|
+
## Scope
|
|
7
|
+
- Create template part
|
|
8
|
+
- Wire archive template to template part
|
|
9
|
+
- Preserve visual behavior
|
|
10
|
+
|
|
11
|
+
## Validation required
|
|
12
|
+
- PHP syntax check
|
|
13
|
+
- Archive renders with product list
|
|
14
|
+
- No warnings in empty-state condition
|
|
15
|
+
|
|
16
|
+
## Out-of-scope follow-up
|
|
17
|
+
If pagination behavior is affected, open a separate PR.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Validation Report
|
|
2
|
+
|
|
3
|
+
## Summary
|
|
4
|
+
Template extraction validated with no functional regressions.
|
|
5
|
+
|
|
6
|
+
## Checks
|
|
7
|
+
- PHP syntax: PASS
|
|
8
|
+
- Archive rendering: PASS
|
|
9
|
+
- Empty-state rendering: PASS
|
|
10
|
+
|
|
11
|
+
## Findings
|
|
12
|
+
- No high-severity issues.
|
|
13
|
+
- Minor semantic naming improvement deferred.
|
|
14
|
+
|
|
15
|
+
## Final recommendation
|
|
16
|
+
Approved.
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# WordPress Theme Example
|
|
2
|
+
|
|
3
|
+
This example demonstrates a WordPress/PHP workflow using `ai-workflow`.
|
|
4
|
+
|
|
5
|
+
**Context**: Creating a custom WordPress theme with hooks and templates.
|
|
6
|
+
|
|
7
|
+
## Workflow Summary
|
|
8
|
+
|
|
9
|
+
| Step | File | Purpose |
|
|
10
|
+
|------|------|---------|
|
|
11
|
+
| Requirement | `01-requirement.md` | Define theme requirements |
|
|
12
|
+
| Specification | `02-functional-spec.md` | Define theme structure and features |
|
|
13
|
+
| Tech Plan | `03-technical-plan.md` | Define WordPress patterns and files |
|
|
14
|
+
| PR Breakdown | `04-pr-breakdown.md` | Split into reviewable PRs |
|
|
15
|
+
| Handoff | `05-execution-handoff.md` | Implementation context |
|
|
16
|
+
| Validation | `06-validation-report.md` | Evidence of completion |
|
|
17
|
+
|
|
18
|
+
## When to use this example
|
|
19
|
+
|
|
20
|
+
Use this when working with:
|
|
21
|
+
- WordPress themes
|
|
22
|
+
- PHP 7 compatible code
|
|
23
|
+
- WordPress hooks and filters
|
|
24
|
+
- WooCommerce customization
|
|
25
|
+
- ACF integration
|
|
26
|
+
|
|
27
|
+
## Stack
|
|
28
|
+
|
|
29
|
+
- WordPress 6.x
|
|
30
|
+
- PHP 7.4+
|
|
31
|
+
- ACF Pro
|
|
32
|
+
- WooCommerce (optional)
|
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
## Source Agent
|
|
4
4
|
|
|
5
|
-
[Planner, implementer, reviewer, validator,
|
|
5
|
+
[Planner, implementer, reviewer, validator, Orion, or named agent]
|
|
6
6
|
|
|
7
7
|
## Target Agent
|
|
8
8
|
|
|
9
|
-
[Planner, implementer, reviewer, validator,
|
|
9
|
+
[Planner, implementer, reviewer, validator, Orion, or named agent]
|
|
10
10
|
|
|
11
11
|
## Objective
|
|
12
12
|
|
|
@@ -95,17 +95,17 @@ This checklist complements but does not replace:
|
|
|
95
95
|
|
|
96
96
|
| Criterion | Check | Result |
|
|
97
97
|
|-----------|-------|--------|
|
|
98
|
-
| Useful | Has PR breakdown with scope? |
|
|
99
|
-
| Safe | Any high-risk architectural decisions? |
|
|
100
|
-
| Scoped | All 3 PRs are related to the feature? |
|
|
101
|
-
| Validated | Has validation expectations? |
|
|
98
|
+
| Useful | Has PR breakdown with scope? | Yes, 3 PRs defined |
|
|
99
|
+
| Safe | Any high-risk architectural decisions? | Yes, one DB schema change - flagged in notes |
|
|
100
|
+
| Scoped | All 3 PRs are related to the feature? | Yes |
|
|
101
|
+
| Validated | Has validation expectations? | Partially, PR #2 needs more details |
|
|
102
102
|
|
|
103
103
|
**Final recommendation**: Approved with notes — PR #2 scope needs refinement before implementation.
|
|
104
104
|
|
|
105
105
|
## Exit Criteria
|
|
106
106
|
|
|
107
107
|
- [ ] Evaluation criteria are clear and actionable
|
|
108
|
-
- [ ] Severity assignment is consistent with AGENTS.md
|
|
108
|
+
- [ ] Severity assignment is consistent with [[`AGENTS.md`](../../AGENTS.md)](../../AGENTS.md)
|
|
109
109
|
- [ ] Final recommendations align with existing skill definitions
|
|
110
110
|
- [ ] Examples demonstrate real workflow usage
|
|
111
111
|
- [ ] Does not conflict with `runbooks/validation-checklist.md`
|
|
@@ -81,3 +81,27 @@ Report:
|
|
|
81
81
|
- regression risks;
|
|
82
82
|
- out-of-scope follow-ups;
|
|
83
83
|
- final recommendation: commit, fix first, or blocked.
|
|
84
|
+
|
|
85
|
+
## UI Evidence Gate (when applicable)
|
|
86
|
+
|
|
87
|
+
If the selected PR changes user-facing UI files or claims frontend/UI output quality, include this block in the final evidence:
|
|
88
|
+
|
|
89
|
+
```md
|
|
90
|
+
## UI Evidence Gate
|
|
91
|
+
|
|
92
|
+
Desktop screenshot: <path> or NOT_RUN: <reason>
|
|
93
|
+
Mobile screenshot: <path> or NOT_RUN: <reason>
|
|
94
|
+
Checklist result:
|
|
95
|
+
- layout
|
|
96
|
+
- typography
|
|
97
|
+
- spacing
|
|
98
|
+
- controls
|
|
99
|
+
- visible states
|
|
100
|
+
- responsiveness
|
|
101
|
+
- accessibility basics
|
|
102
|
+
UI gate status: PASS | PASS_WITH_NOTES | FAIL | NOT_RUN
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
If screenshots are unavailable, use `NOT_RUN: <reason>` and do not mark UI gate as `PASS` without acceptable justification.
|
|
106
|
+
|
|
107
|
+
For non-UI PRs, this block may be omitted or reported as `NOT_RUN` with reason.
|
|
@@ -9,7 +9,7 @@ This orchestration layer is contract-driven: each step advances only when the pr
|
|
|
9
9
|
## Default chain
|
|
10
10
|
|
|
11
11
|
```txt
|
|
12
|
-
planner -> implementer -> reviewer -> validator ->
|
|
12
|
+
planner -> implementer -> reviewer -> validator -> Orion
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
For minimal local flow, `implementer/reviewer/validator` can be mapped to OpenCode agent equivalents.
|
|
@@ -69,7 +69,7 @@ Block when:
|
|
|
69
69
|
- any unresolved `High` finding exists;
|
|
70
70
|
- unresolved `Medium` finding affects correctness/scope safety.
|
|
71
71
|
|
|
72
|
-
### Gate D — validator ->
|
|
72
|
+
### Gate D — validator -> Orion
|
|
73
73
|
|
|
74
74
|
Entry criteria:
|
|
75
75
|
|
|
@@ -86,11 +86,11 @@ Block when:
|
|
|
86
86
|
## Automatic routing rules
|
|
87
87
|
|
|
88
88
|
- Do not skip gate order unless user explicitly requests a proportional flow for trivial changes.
|
|
89
|
-
- Never route directly from planner to
|
|
89
|
+
- Never route directly from planner to Orion.
|
|
90
90
|
- If a gate blocks, return to the previous owner with a focused fix request.
|
|
91
91
|
- Preserve one active primary agent per step.
|
|
92
92
|
|
|
93
|
-
## Output required from
|
|
93
|
+
## Output required from Atlas
|
|
94
94
|
|
|
95
95
|
- current step owner;
|
|
96
96
|
- gate status (`Pass`/`Blocked`);
|
|
@@ -140,12 +140,12 @@ In OpenCode, these roles map to:
|
|
|
140
140
|
|
|
141
141
|
| Role | OpenCode Agent |
|
|
142
142
|
| ---- | -------------- |
|
|
143
|
-
| Planner | `
|
|
144
|
-
| Executor | `
|
|
145
|
-
| Review | `
|
|
146
|
-
| Validator | `
|
|
143
|
+
| Planner | `Orion` |
|
|
144
|
+
| Executor | `Astra` |
|
|
145
|
+
| Review | `Sage` |
|
|
146
|
+
| Validator | `Sage` |
|
|
147
147
|
|
|
148
|
-
For simple workflows, the `
|
|
148
|
+
For simple workflows, the `Astra` can handle execution and lightweight self-review. For complex workflows, separate owners using the handoff model.
|
|
149
149
|
|
|
150
150
|
## Trade-offs
|
|
151
151
|
|
|
@@ -10,7 +10,7 @@ This workflow produces a requirement, functional specification, technical plan,
|
|
|
10
10
|
|
|
11
11
|
- User idea, request, issue, or product goal.
|
|
12
12
|
- Current project context.
|
|
13
|
-
- Relevant constraints from `AGENTS.md
|
|
13
|
+
- Relevant constraints from [`AGENTS.md`](../../AGENTS.md).
|
|
14
14
|
- Existing prompts, templates, runbooks, and skills.
|
|
15
15
|
- Known validation expectations.
|
|
16
16
|
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# Agent Delegation Workflow
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
Define how work is routed from `Atlas` to manager agents and specialists with explicit ownership and validation evidence.
|
|
6
|
+
|
|
7
|
+
## Delegation matrix
|
|
8
|
+
|
|
9
|
+
| Task type | Primary owner |
|
|
10
|
+
| --- | --- |
|
|
11
|
+
| Discovery/context | `Nexus` |
|
|
12
|
+
| Requirements/spec clarity | `Nexus` |
|
|
13
|
+
| Technical planning/PR breakdown | `Orion` |
|
|
14
|
+
| Implementation/fixes | `Astra` |
|
|
15
|
+
| Validation and evidence | `Sage` |
|
|
16
|
+
| Workflow quality audit | `Sage` |
|
|
17
|
+
| Release readiness | `Orion` |
|
|
18
|
+
| Deployment planning | `Orion` |
|
|
19
|
+
|
|
20
|
+
## Specialist escalation
|
|
21
|
+
|
|
22
|
+
- Architecture changes -> `architecture-engineer`
|
|
23
|
+
- User-facing behavior risk -> `qa-engineer`
|
|
24
|
+
- Build/CI/command issues -> `Sage`
|
|
25
|
+
- Docs/runbooks/prompts -> `docs-engineer`
|
|
26
|
+
- Durable decisions -> `project-memory`
|
|
27
|
+
|
|
28
|
+
## Delegation contract (required)
|
|
29
|
+
|
|
30
|
+
Every handoff packet must include:
|
|
31
|
+
|
|
32
|
+
- task summary;
|
|
33
|
+
- relevant files;
|
|
34
|
+
- constraints and do-not-change list;
|
|
35
|
+
- expected output;
|
|
36
|
+
- validation required;
|
|
37
|
+
- risk (`Low`/`Medium`/`High`);
|
|
38
|
+
- evidence required.
|
|
39
|
+
|
|
40
|
+
## Anti-overdelegation
|
|
41
|
+
|
|
42
|
+
- Do not delegate trivial one-file edits.
|
|
43
|
+
- Prefer one owner plus one reviewer for risky tasks.
|
|
44
|
+
- Keep delegation chain minimal and explicit.
|
|
45
|
+
|
|
46
|
+
## Example routes
|
|
47
|
+
|
|
48
|
+
- Feature delivery: `Atlas -> Nexus -> Orion -> Astra -> Sage`
|
|
49
|
+
- Bug fix: `Atlas -> Astra -> Sage`
|
|
50
|
+
- Docs rewrite: `Atlas -> docs-engineer -> Sage`
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Apply Starter to a Real Project
|
|
2
|
+
|
|
3
|
+
## Goal
|
|
4
|
+
|
|
5
|
+
Adopt AI Workflow Kit in an existing repository using the v2 OpenCode-first workflow.
|
|
6
|
+
|
|
7
|
+
## 1) Install and inspect
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx @williambeto/ai-workflow init --dry-run
|
|
11
|
+
npx @williambeto/ai-workflow init --yes
|
|
12
|
+
npx @williambeto/ai-workflow doctor
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Assets are installed under `.ai-workflow/` with managed links for expected paths.
|
|
16
|
+
|
|
17
|
+
## 2) Choose adoption level
|
|
18
|
+
|
|
19
|
+
| Level | Use when | Core assets |
|
|
20
|
+
| --- | --- | --- |
|
|
21
|
+
| Minimal | Small trials/docs updates | `README.workflow.md`, `AGENTS.md`, base prompts/templates |
|
|
22
|
+
| Operational | Recurring feature delivery | `opencode/commands/`, `opencode/agents/`, `harness/`, selected skills |
|
|
23
|
+
| Full | Team workflow system | Operational set + examples/runbooks/schemas |
|
|
24
|
+
|
|
25
|
+
## 3) Start workflow routing
|
|
26
|
+
|
|
27
|
+
- Default: `Atlas`
|
|
28
|
+
- Discovery-first: `discover`
|
|
29
|
+
- Spec-first: `spec-create` -> `spec-review` -> `spec-implement`
|
|
30
|
+
- Delivery path: `plan` -> `implement` -> `validate`
|
|
31
|
+
|
|
32
|
+
## 4) Recommended capability set
|
|
33
|
+
|
|
34
|
+
- Planning: `product-discovery`, `technical-leadership`, `pr-workflow`
|
|
35
|
+
- Implementation: `frontend-development` or `backend-development`
|
|
36
|
+
- Validation: `qa-workflow`
|
|
37
|
+
- Docs: `documentation`
|
|
38
|
+
- Memory/token controls: `project-memory`, `optimize-tokens`
|
|
39
|
+
|
|
40
|
+
## 5) Guardrails
|
|
41
|
+
|
|
42
|
+
- Keep changes scoped to one PR objective.
|
|
43
|
+
- Preserve existing behavior unless change is explicit.
|
|
44
|
+
- Record evidence for validation commands.
|
|
45
|
+
- Treat unresolved assumptions as blockers.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Command Cheat Sheet
|
|
2
|
+
|
|
3
|
+
## OpenCode Commands (`opencode/commands/`)
|
|
4
|
+
|
|
5
|
+
| Command | When to Use |
|
|
6
|
+
|---------|-------------|
|
|
7
|
+
| `Atlas.md` | Default routing entrypoint for multi-step work. |
|
|
8
|
+
| `discover.md` | Create discovery output from vague requests. |
|
|
9
|
+
| `spec-create.md` | Draft a functional specification. |
|
|
10
|
+
| `spec-review.md` | Review spec quality/readiness before planning. |
|
|
11
|
+
| `spec-implement.md` | Convert approved spec to implementation handoff. |
|
|
12
|
+
| `plan.md` | Turn scoped work into technical plan and PR breakdown. |
|
|
13
|
+
| `implement.md` | Implement one selected PR from a plan or handoff. |
|
|
14
|
+
| `validate.md` | Validate the current repository or PR before commit or merge. |
|
|
15
|
+
| `audit.md` | Audit workflow/repo consistency and quality. |
|
|
16
|
+
| `optimize-tokens.md` | Apply compact context/output strategy. |
|
|
17
|
+
| `update-memory.md` | Curate durable project memory entries. |
|
|
18
|
+
| `release.md` | Prepare release readiness and release checklist evidence. |
|
|
19
|
+
| `deploy.md` | Prepare deployment readiness, rollout steps, and rollback plan. |
|
|
20
|
+
|
|
21
|
+
## Usage Examples
|
|
22
|
+
|
|
23
|
+
### OpenCode
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
# Default routing
|
|
27
|
+
opencode Atlas
|
|
28
|
+
|
|
29
|
+
# Plan work
|
|
30
|
+
opencode plan
|
|
31
|
+
|
|
32
|
+
# Implement selected PR
|
|
33
|
+
opencode implement
|
|
34
|
+
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Safety Rules
|
|
38
|
+
|
|
39
|
+
- Always check branch status before making changes (`git status -sb`)
|
|
40
|
+
- Never implement directly on `main`; use scoped branches
|
|
41
|
+
- Validate changes before committing (`npm run validate`)
|
|
42
|
+
- Keep PRs small, reviewable, and independently useful
|
|
43
|
+
- Do not introduce unrelated refactors or dependency changes
|
|
44
|
+
- Preserve existing behavior unless explicitly changed
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# How to Use Skills
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
Use this runbook to choose the right capability skill for each workflow step in the OpenCode-first v2 workflow.
|
|
6
|
+
|
|
7
|
+
## Core rules
|
|
8
|
+
|
|
9
|
+
- Use one **primary** skill per task.
|
|
10
|
+
- Add a supporting skill only when it closes a concrete gap.
|
|
11
|
+
- Prefer capability skills (for example `documentation`, `qa-workflow`) over role-like naming.
|
|
12
|
+
|
|
13
|
+
## Default skill routing
|
|
14
|
+
|
|
15
|
+
| Task type | Primary skill | Supporting skills |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| Clarify request and scope | `product-discovery` | `documentation` |
|
|
18
|
+
| Create requirement/spec | `product-planning` | `qa-workflow`, `documentation` |
|
|
19
|
+
| Create technical plan | `technical-leadership` | `architecture`, `qa-workflow` |
|
|
20
|
+
| Break into PRs | `pr-workflow` | `technical-leadership` |
|
|
21
|
+
| Implement frontend | `frontend-development` | `qa-workflow` |
|
|
22
|
+
| Implement backend | `backend-development` | `qa-workflow` |
|
|
23
|
+
| Validate commands/evidence | `qa-workflow` | `deployment` |
|
|
24
|
+
| Update docs/runbooks/prompts | `documentation` | `qa-workflow` |
|
|
25
|
+
| Prepare release/deploy | `deployment` | `qa-workflow` |
|
|
26
|
+
| Preserve durable decisions | `project-memory` | `optimize-tokens` |
|
|
27
|
+
|
|
28
|
+
## Agent-to-skill baseline
|
|
29
|
+
|
|
30
|
+
| Agent owner | Primary skill set |
|
|
31
|
+
| --- | --- |
|
|
32
|
+
| `Orion` | `product-discovery`, `technical-leadership`, `pr-workflow` |
|
|
33
|
+
| `Astra` | `pr-workflow`, `qa-workflow`, plus implementation skill |
|
|
34
|
+
| `Sage` | `qa-workflow`, `deployment` |
|
|
35
|
+
| `Orion` | `deployment`, `qa-workflow` |
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
## Validation reminder
|
|
39
|
+
|
|
40
|
+
Before handoff or completion:
|
|
41
|
+
|
|
42
|
+
- list validation commands executed;
|
|
43
|
+
- include result summary;
|
|
44
|
+
- mark untested areas explicitly.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Private Spec Publication Safety Runbook
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
Protect private specification content from leaking into the public npm package.
|
|
6
|
+
|
|
7
|
+
## Rules
|
|
8
|
+
|
|
9
|
+
1. Canonical specs (REQ/TECH, remediation, roadmap strategy) live in the private `/specs` workspace repository.
|
|
10
|
+
2. `packages/ai-workflow/docs/**` must stay public-safe.
|
|
11
|
+
3. Never publish internal risk notes, customer-sensitive details, or private planning in package docs.
|
|
12
|
+
|
|
13
|
+
## Pre-release checklist
|
|
14
|
+
|
|
15
|
+
- [ ] `npm run validate:privacy-gate` passes
|
|
16
|
+
- [ ] `npm run validate:refs` passes
|
|
17
|
+
- [ ] Public docs do not link to private `/specs` files
|
|
18
|
+
- [ ] Any spec-like content in package docs is sanitized summary only
|
|
19
|
+
|
|
20
|
+
## If privacy gate fails
|
|
21
|
+
|
|
22
|
+
1. Open `core/package.json` and inspect `files` allowlist.
|
|
23
|
+
2. Remove any private path from publish allowlist.
|
|
24
|
+
3. Move sensitive docs out of package paths.
|
|
25
|
+
4. Re-run:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
npm run validate:privacy-gate
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Evidence to capture
|
|
32
|
+
|
|
33
|
+
- command output for `validate:privacy-gate`
|
|
34
|
+
- `git diff -- package.json packages/ai-workflow/docs packages/ai-workflow/runbooks`
|
|
35
|
+
- reviewer confirmation that no private paths are publishable
|
|
@@ -33,15 +33,12 @@ For tiny docs-only edits, use proportional workflow.
|
|
|
33
33
|
|
|
34
34
|
- Lightweight change template: `templates/change-proposal.template.md`
|
|
35
35
|
- Lightweight readiness checklist: `checklists/change-spec-readiness-checklist.md`
|
|
36
|
-
- Request-to-spec command: `opencode/commands/
|
|
37
|
-
- Spec
|
|
36
|
+
- Request-to-spec command: `opencode/commands/spec-create.md`
|
|
37
|
+
- Spec review command: `opencode/commands/spec-review.md`
|
|
38
|
+
- Spec-to-implementation command: `opencode/commands/spec-implement.md`
|
|
38
39
|
- Spec-first owner: `opencode/agents/spec-engineer.md`
|
|
39
40
|
- Spec template: `templates/SPEC.template.md`
|
|
40
41
|
- Readiness checklist: `checklists/spec-readiness-checklist.md`
|
|
41
|
-
- Draft prompt: `.codex/prompts/specs/create-spec-from-requirement.md`
|
|
42
|
-
- Review prompt: `.codex/prompts/specs/review-spec.md`
|
|
43
|
-
- Plan prompt: `.codex/prompts/specs/spec-to-technical-plan.md`
|
|
44
|
-
- PR prompt: `.codex/prompts/specs/spec-to-pr-breakdown.md`
|
|
45
42
|
|
|
46
43
|
## Artifact location convention (consumer project)
|
|
47
44
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Tutorial Walkthroughs
|
|
2
|
+
|
|
3
|
+
## Available walkthroughs
|
|
4
|
+
|
|
5
|
+
| Track | Flow | Duration |
|
|
6
|
+
| --- | --- | --- |
|
|
7
|
+
| From zero to first PR | Bootstrap -> Requirement -> Spec -> Plan -> PR breakdown -> Implement -> Validate | ~30 min |
|
|
8
|
+
| Docs-only update | Requirement -> Spec (tiny) -> Implement -> Validate | ~15 min |
|
|
9
|
+
| Validation-first rescue | Discover -> Plan -> Implement fix -> Validate evidence | ~20 min |
|
|
10
|
+
|
|
11
|
+
## Recommended owners/skills
|
|
12
|
+
|
|
13
|
+
| Step | Owner | Primary skill |
|
|
14
|
+
| --- | --- | --- |
|
|
15
|
+
| Discovery | `Nexus` | `product-discovery` |
|
|
16
|
+
| Spec | `Nexus` | `product-planning` |
|
|
17
|
+
| Plan | `Orion` | `technical-leadership` |
|
|
18
|
+
| Implement | `Astra` | `frontend-development` or `backend-development` |
|
|
19
|
+
| Validate | `Sage` | `qa-workflow` |
|
|
20
|
+
|
|
21
|
+
## Command path
|
|
22
|
+
|
|
23
|
+
`Atlas` -> `discover` -> `spec-create` -> `spec-review` -> `plan` -> `implement` -> `validate`
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Use an Issue Tracker for Operational Planning
|
|
2
|
+
|
|
3
|
+
Use this runbook when a team wants issue-tracker discipline around AI Workflow Kit delivery.
|
|
4
|
+
|
|
5
|
+
## Purpose
|
|
6
|
+
|
|
7
|
+
Keep day-to-day execution small, current, and auditable without relying on historical roadmap or backlog documents.
|
|
8
|
+
|
|
9
|
+
## Rule
|
|
10
|
+
|
|
11
|
+
The source of truth for active work is the current request, current spec, current plan, current PR breakdown, and current evidence report.
|
|
12
|
+
|
|
13
|
+
Historical planning artifacts must not override the current v2 operational contract.
|
|
14
|
+
|
|
15
|
+
## Recommended issue fields
|
|
16
|
+
|
|
17
|
+
- Title
|
|
18
|
+
- Goal
|
|
19
|
+
- Owner
|
|
20
|
+
- Execution mode: readonly, quick, standard, full, restricted
|
|
21
|
+
- Scope
|
|
22
|
+
- Acceptance criteria
|
|
23
|
+
- Validation commands
|
|
24
|
+
- Evidence link
|
|
25
|
+
- Status
|
|
26
|
+
|
|
27
|
+
## Workflow
|
|
28
|
+
|
|
29
|
+
1. Create or update the active spec.
|
|
30
|
+
2. Review scope and readiness.
|
|
31
|
+
3. Create a technical plan.
|
|
32
|
+
4. Break work into small PRs.
|
|
33
|
+
5. Implement with branch recovery.
|
|
34
|
+
6. Document the change.
|
|
35
|
+
7. Add automated tests when viable.
|
|
36
|
+
8. Validate.
|
|
37
|
+
9. Attach evidence.
|
|
38
|
+
|
|
39
|
+
## Done means
|
|
40
|
+
|
|
41
|
+
- Scope completed.
|
|
42
|
+
- Documentation exists or has a concrete `NOT_APPLICABLE` reason.
|
|
43
|
+
- Automated tests pass when viable.
|
|
44
|
+
- Validation commands pass.
|
|
45
|
+
- Evidence report is complete.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Use Project Memory
|
|
2
|
+
|
|
3
|
+
This runbook explains how to keep durable project decisions available without creating excessive context noise.
|
|
4
|
+
|
|
5
|
+
## Current name
|
|
6
|
+
|
|
7
|
+
Use **Project Memory**. Older names are historical and must not be used in active runtime instructions.
|
|
8
|
+
|
|
9
|
+
## What to store
|
|
10
|
+
|
|
11
|
+
Store only durable information:
|
|
12
|
+
|
|
13
|
+
- architectural decisions;
|
|
14
|
+
- approved workflow contracts;
|
|
15
|
+
- package/release constraints;
|
|
16
|
+
- known runtime behavior;
|
|
17
|
+
- validated project conventions;
|
|
18
|
+
- important user decisions.
|
|
19
|
+
|
|
20
|
+
Do not store temporary notes, scratch work, obsolete roadmaps, or completed backlog items.
|
|
21
|
+
|
|
22
|
+
## When to update
|
|
23
|
+
|
|
24
|
+
Update Project Memory when a task creates or changes a durable decision. Do not update it for ordinary implementation details unless they become project rules.
|
|
25
|
+
|
|
26
|
+
## Evidence
|
|
27
|
+
|
|
28
|
+
If Project Memory is updated, include it in the evidence report:
|
|
29
|
+
|
|
30
|
+
- what changed;
|
|
31
|
+
- why it is durable;
|
|
32
|
+
- where it was stored;
|
|
33
|
+
- validation performed.
|