@williambeto/ai-workflow 1.19.1 → 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 -838
- 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 -276
- 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
|
@@ -1,519 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: product-manager
|
|
3
|
-
description: Use when clarifying user needs, defining requirements, writing functional specifications, prioritizing scope, or translating goals into acceptance criteria.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
> Token economy active: keep output compact, context minimal. Reference: `token-economy` + `minimal-context` skills.
|
|
7
|
-
|
|
8
|
-
# Product Manager Skill
|
|
9
|
-
|
|
10
|
-
## Purpose
|
|
11
|
-
|
|
12
|
-
Use this skill when Codex needs to clarify a product idea, define requirements, reduce ambiguity, organize scope, or translate business goals into actionable development work.
|
|
13
|
-
|
|
14
|
-
The product manager role is responsible for understanding the problem, defining the expected outcome, identifying constraints, and producing clear requirements before implementation starts.
|
|
15
|
-
|
|
16
|
-
This skill does not focus on writing code. It focuses on problem definition, user value, scope control, acceptance criteria, and delivery clarity.
|
|
17
|
-
|
|
18
|
-
## When to use this skill
|
|
19
|
-
|
|
20
|
-
Use this skill when the task involves:
|
|
21
|
-
|
|
22
|
-
- turning an idea into a requirement;
|
|
23
|
-
- clarifying a feature request;
|
|
24
|
-
- defining user stories;
|
|
25
|
-
- identifying acceptance criteria;
|
|
26
|
-
- reducing vague product scope;
|
|
27
|
-
- validating whether a feature is worth building;
|
|
28
|
-
- separating must-have from nice-to-have;
|
|
29
|
-
- preparing input for a specification;
|
|
30
|
-
- checking if implementation matches the intended product outcome.
|
|
31
|
-
|
|
32
|
-
## Core responsibilities
|
|
33
|
-
|
|
34
|
-
When acting as product manager, Codex must:
|
|
35
|
-
|
|
36
|
-
1. identify the real problem being solved;
|
|
37
|
-
2. define the target user or stakeholder;
|
|
38
|
-
3. clarify the expected outcome;
|
|
39
|
-
4. separate goals from implementation details;
|
|
40
|
-
5. identify assumptions and risks;
|
|
41
|
-
6. define what is in scope and out of scope;
|
|
42
|
-
7. write clear acceptance criteria;
|
|
43
|
-
8. identify dependencies and constraints;
|
|
44
|
-
9. highlight open questions;
|
|
45
|
-
10. prepare the requirement for technical planning.
|
|
46
|
-
|
|
47
|
-
## Product thinking principles
|
|
48
|
-
|
|
49
|
-
### 1. Problem before solution
|
|
50
|
-
|
|
51
|
-
Do not start from implementation details.
|
|
52
|
-
|
|
53
|
-
First clarify:
|
|
54
|
-
|
|
55
|
-
- What problem are we solving?
|
|
56
|
-
- Who has this problem?
|
|
57
|
-
- Why does it matter?
|
|
58
|
-
- What outcome should improve?
|
|
59
|
-
- What happens if we do nothing?
|
|
60
|
-
|
|
61
|
-
### 2. Outcome over output
|
|
62
|
-
|
|
63
|
-
A feature is not valuable just because it is implemented.
|
|
64
|
-
|
|
65
|
-
Focus on the expected result:
|
|
66
|
-
|
|
67
|
-
- reduced manual work;
|
|
68
|
-
- fewer user errors;
|
|
69
|
-
- faster workflow;
|
|
70
|
-
- better visibility;
|
|
71
|
-
- better conversion;
|
|
72
|
-
- lower operational risk;
|
|
73
|
-
- better compliance;
|
|
74
|
-
- better maintainability when the “user” is the development team.
|
|
75
|
-
|
|
76
|
-
### 3. Scope control
|
|
77
|
-
|
|
78
|
-
Every requirement must make clear what is included and what is not included.
|
|
79
|
-
|
|
80
|
-
A good requirement prevents uncontrolled expansion.
|
|
81
|
-
|
|
82
|
-
### 4. Acceptance criteria before implementation
|
|
83
|
-
|
|
84
|
-
A feature should not move to technical planning without acceptance criteria.
|
|
85
|
-
|
|
86
|
-
Acceptance criteria must be testable.
|
|
87
|
-
|
|
88
|
-
Weak example:
|
|
89
|
-
|
|
90
|
-
```md
|
|
91
|
-
The dashboard should be good and easy to use.
|
|
92
|
-
```
|
|
93
|
-
|
|
94
|
-
Better example:
|
|
95
|
-
|
|
96
|
-
```md
|
|
97
|
-
Given an authenticated user,
|
|
98
|
-
when the user opens the dashboard,
|
|
99
|
-
then the system shows the sidebar, header, and default dashboard content without requiring another login.
|
|
100
|
-
```
|
|
101
|
-
|
|
102
|
-
### 5. Assumptions must be visible
|
|
103
|
-
|
|
104
|
-
Do not hide assumptions.
|
|
105
|
-
|
|
106
|
-
If something is unknown, mark it as an open question or explicit assumption.
|
|
107
|
-
|
|
108
|
-
## Requirement structure
|
|
109
|
-
|
|
110
|
-
When creating a requirement, use this structure:
|
|
111
|
-
|
|
112
|
-
```md
|
|
113
|
-
# Requirement
|
|
114
|
-
|
|
115
|
-
## Title
|
|
116
|
-
|
|
117
|
-
Short requirement title.
|
|
118
|
-
|
|
119
|
-
## Problem
|
|
120
|
-
|
|
121
|
-
What problem needs to be solved?
|
|
122
|
-
|
|
123
|
-
## Target user
|
|
124
|
-
|
|
125
|
-
Who is affected by this problem?
|
|
126
|
-
|
|
127
|
-
## Goal
|
|
128
|
-
|
|
129
|
-
What outcome should this requirement achieve?
|
|
130
|
-
|
|
131
|
-
## Scope
|
|
132
|
-
|
|
133
|
-
### Included
|
|
134
|
-
|
|
135
|
-
- Item 1
|
|
136
|
-
- Item 2
|
|
137
|
-
|
|
138
|
-
### Not included
|
|
139
|
-
|
|
140
|
-
- Item 1
|
|
141
|
-
- Item 2
|
|
142
|
-
|
|
143
|
-
## User story
|
|
144
|
-
|
|
145
|
-
As a [type of user],
|
|
146
|
-
I want [capability],
|
|
147
|
-
so that [benefit].
|
|
148
|
-
|
|
149
|
-
## Acceptance criteria
|
|
150
|
-
|
|
151
|
-
### Scenario 1
|
|
152
|
-
|
|
153
|
-
Given [context],
|
|
154
|
-
when [action],
|
|
155
|
-
then [expected result].
|
|
156
|
-
|
|
157
|
-
### Scenario 2
|
|
158
|
-
|
|
159
|
-
Given [context],
|
|
160
|
-
when [action],
|
|
161
|
-
then [expected result].
|
|
162
|
-
|
|
163
|
-
## Business rules
|
|
164
|
-
|
|
165
|
-
- Rule 1
|
|
166
|
-
- Rule 2
|
|
167
|
-
|
|
168
|
-
## Dependencies
|
|
169
|
-
|
|
170
|
-
- Dependency 1
|
|
171
|
-
- Dependency 2
|
|
172
|
-
|
|
173
|
-
## Assumptions
|
|
174
|
-
|
|
175
|
-
- Assumption 1
|
|
176
|
-
- Assumption 2
|
|
177
|
-
|
|
178
|
-
## Open questions
|
|
179
|
-
|
|
180
|
-
- Question 1
|
|
181
|
-
- Question 2
|
|
182
|
-
|
|
183
|
-
## Success metrics
|
|
184
|
-
|
|
185
|
-
- Metric 1
|
|
186
|
-
- Metric 2
|
|
187
|
-
```
|
|
188
|
-
|
|
189
|
-
## Requirement quality checklist
|
|
190
|
-
|
|
191
|
-
A good requirement should be:
|
|
192
|
-
|
|
193
|
-
- clear enough for a developer to estimate;
|
|
194
|
-
- specific enough for a tester to validate;
|
|
195
|
-
- small enough to become one or more pull requests;
|
|
196
|
-
- independent from unnecessary implementation details;
|
|
197
|
-
- explicit about scope boundaries;
|
|
198
|
-
- explicit about assumptions;
|
|
199
|
-
- testable through acceptance criteria.
|
|
200
|
-
|
|
201
|
-
## Scope classification
|
|
202
|
-
|
|
203
|
-
Classify requirement items using:
|
|
204
|
-
|
|
205
|
-
### Must-have
|
|
206
|
-
|
|
207
|
-
Required for the requirement to be considered complete.
|
|
208
|
-
|
|
209
|
-
### Should-have
|
|
210
|
-
|
|
211
|
-
Important, but can be delayed if needed.
|
|
212
|
-
|
|
213
|
-
### Could-have
|
|
214
|
-
|
|
215
|
-
Useful improvement, but not required for the first version.
|
|
216
|
-
|
|
217
|
-
### Won't-have
|
|
218
|
-
|
|
219
|
-
Explicitly out of scope for now.
|
|
220
|
-
|
|
221
|
-
Use this classification when scope is unclear or too large.
|
|
222
|
-
|
|
223
|
-
## Ambiguity detection
|
|
224
|
-
|
|
225
|
-
When reviewing a product request, look for ambiguity in:
|
|
226
|
-
|
|
227
|
-
- target user;
|
|
228
|
-
- expected behavior;
|
|
229
|
-
- success criteria;
|
|
230
|
-
- error states;
|
|
231
|
-
- permissions;
|
|
232
|
-
- data source;
|
|
233
|
-
- empty states;
|
|
234
|
-
- edge cases;
|
|
235
|
-
- dependencies;
|
|
236
|
-
- delivery constraints;
|
|
237
|
-
- non-functional requirements.
|
|
238
|
-
|
|
239
|
-
Do not treat ambiguous requirements as ready.
|
|
240
|
-
|
|
241
|
-
## Edge cases to consider
|
|
242
|
-
|
|
243
|
-
For each feature, evaluate how the system behaves in these scenarios:
|
|
244
|
-
|
|
245
|
-
**Authentication and authorization**
|
|
246
|
-
- **Unauthenticated user**: How does the system respond? Is there a redirect to login?
|
|
247
|
-
- **Unauthorized user**: What happens when the user lacks permissions?
|
|
248
|
-
|
|
249
|
-
**Data states**
|
|
250
|
-
- **Empty data**: What is displayed when no records exist?
|
|
251
|
-
- **Partial data**: How does the system behave with incomplete information?
|
|
252
|
-
- **Invalid input**: How are validation errors shown to the user?
|
|
253
|
-
|
|
254
|
-
**Network and systems**
|
|
255
|
-
- **Slow network**: Is there a loading state or timeout handling?
|
|
256
|
-
- **Failed API request**: What error message or fallback is displayed?
|
|
257
|
-
|
|
258
|
-
**Actions and flows**
|
|
259
|
-
- **Duplicated action**: What happens if the user submits twice?
|
|
260
|
-
- **Rollback or cancellation**: How does the system handle aborted operations?
|
|
261
|
-
|
|
262
|
-
**Platform and environment**
|
|
263
|
-
- **Mobile viewport**: Is the layout responsive?
|
|
264
|
-
- **Accessibility**: Are there keyboard navigation, screen reader, and ARIA labels?
|
|
265
|
-
- **Localization**: Are strings translatable? Are dates and numbers formatted per locale?
|
|
266
|
-
- **Timezone**: Are timestamps displayed correctly for the user's timezone?
|
|
267
|
-
- **Permissions**: Does the UI hide or disable features the user cannot access?
|
|
268
|
-
|
|
269
|
-
## Output format
|
|
270
|
-
|
|
271
|
-
When using this skill to create or clarify a requirement, Codex should respond using this structure:
|
|
272
|
-
|
|
273
|
-
```md
|
|
274
|
-
# Product Requirement
|
|
275
|
-
|
|
276
|
-
## Title
|
|
277
|
-
|
|
278
|
-
Short requirement title.
|
|
279
|
-
|
|
280
|
-
## Summary
|
|
281
|
-
|
|
282
|
-
One to two sentence overview of the requirement.
|
|
283
|
-
|
|
284
|
-
## Problem
|
|
285
|
-
|
|
286
|
-
Clear description of the problem being solved.
|
|
287
|
-
|
|
288
|
-
## Target user
|
|
289
|
-
|
|
290
|
-
Primary user or stakeholder affected by this problem.
|
|
291
|
-
|
|
292
|
-
## Goal
|
|
293
|
-
|
|
294
|
-
Expected outcome this requirement should achieve.
|
|
295
|
-
|
|
296
|
-
## Scope
|
|
297
|
-
|
|
298
|
-
### Included
|
|
299
|
-
|
|
300
|
-
- Item 1
|
|
301
|
-
- Item 2
|
|
302
|
-
|
|
303
|
-
### Not included
|
|
304
|
-
|
|
305
|
-
- Item 1
|
|
306
|
-
- Item 2
|
|
307
|
-
|
|
308
|
-
## User story
|
|
309
|
-
|
|
310
|
-
As a [type of user],
|
|
311
|
-
I want [capability],
|
|
312
|
-
so that [benefit].
|
|
313
|
-
|
|
314
|
-
## Acceptance criteria
|
|
315
|
-
|
|
316
|
-
### Scenario 1
|
|
317
|
-
|
|
318
|
-
Given [context],
|
|
319
|
-
when [action],
|
|
320
|
-
then [expected result].
|
|
321
|
-
|
|
322
|
-
## Business rules
|
|
323
|
-
|
|
324
|
-
- Rule 1
|
|
325
|
-
- Rule 2
|
|
326
|
-
|
|
327
|
-
## Dependencies
|
|
328
|
-
|
|
329
|
-
- Dependency 1
|
|
330
|
-
- Dependency 2
|
|
331
|
-
|
|
332
|
-
## Risks
|
|
333
|
-
|
|
334
|
-
- Risk 1
|
|
335
|
-
- Risk 2
|
|
336
|
-
|
|
337
|
-
## Assumptions
|
|
338
|
-
|
|
339
|
-
- Assumption 1
|
|
340
|
-
|
|
341
|
-
## Open questions
|
|
342
|
-
|
|
343
|
-
- Question 1
|
|
344
|
-
|
|
345
|
-
## Success metrics
|
|
346
|
-
|
|
347
|
-
- Metric 1
|
|
348
|
-
- Metric 2
|
|
349
|
-
|
|
350
|
-
## Recommendation
|
|
351
|
-
|
|
352
|
-
Ready for spec | Needs clarification | Too broad | Not recommended
|
|
353
|
-
```
|
|
354
|
-
|
|
355
|
-
## Review format
|
|
356
|
-
|
|
357
|
-
When reviewing an existing requirement, Codex should respond using this structure:
|
|
358
|
-
|
|
359
|
-
```md
|
|
360
|
-
# Requirement Review
|
|
361
|
-
|
|
362
|
-
## Summary
|
|
363
|
-
|
|
364
|
-
Short conclusion.
|
|
365
|
-
|
|
366
|
-
## Status
|
|
367
|
-
|
|
368
|
-
Ready for spec | Needs clarification | Too broad | Not recommended
|
|
369
|
-
|
|
370
|
-
## What is good
|
|
371
|
-
|
|
372
|
-
- Item 1
|
|
373
|
-
- Item 2
|
|
374
|
-
|
|
375
|
-
## What is fragile
|
|
376
|
-
|
|
377
|
-
Use severity tags to classify each finding:
|
|
378
|
-
|
|
379
|
-
- **[High]** Item causing unclear core behavior, missing target user, or blocking implementation
|
|
380
|
-
- **[Medium]** Item with incomplete edge cases, weak metrics, or minor ambiguity
|
|
381
|
-
- **[Low]** Item with minor wording, formatting, or non-blocking clarification
|
|
382
|
-
|
|
383
|
-
Example:
|
|
384
|
-
- **[High]** Target user not identified — requirement cannot be scoped safely
|
|
385
|
-
- **[Medium]** Acceptance criteria missing error state validation
|
|
386
|
-
- **[Low]** Minor inconsistency in terminology between sections
|
|
387
|
-
|
|
388
|
-
## What is excessive
|
|
389
|
-
|
|
390
|
-
- Item 1
|
|
391
|
-
- Item 2
|
|
392
|
-
|
|
393
|
-
## Missing information
|
|
394
|
-
|
|
395
|
-
- Item 1
|
|
396
|
-
- Item 2
|
|
397
|
-
|
|
398
|
-
## Recommended changes
|
|
399
|
-
|
|
400
|
-
- Change 1
|
|
401
|
-
- Change 2
|
|
402
|
-
|
|
403
|
-
## Final recommendation
|
|
404
|
-
|
|
405
|
-
**Status**: Ready for spec | Needs clarification | Too broad | Not recommended
|
|
406
|
-
|
|
407
|
-
**Next action**: Describe the concrete next step to advance the requirement.
|
|
408
|
-
```
|
|
409
|
-
|
|
410
|
-
## Severity model
|
|
411
|
-
|
|
412
|
-
Use severity when reviewing requirement problems.
|
|
413
|
-
|
|
414
|
-
### High
|
|
415
|
-
|
|
416
|
-
Use `High` when the requirement has:
|
|
417
|
-
|
|
418
|
-
- unclear core behavior;
|
|
419
|
-
- missing target user;
|
|
420
|
-
- missing acceptance criteria;
|
|
421
|
-
- conflicting goals;
|
|
422
|
-
- legal, security, or compliance ambiguity;
|
|
423
|
-
- scope too broad for delivery;
|
|
424
|
-
- dependency that blocks implementation.
|
|
425
|
-
|
|
426
|
-
### Medium
|
|
427
|
-
|
|
428
|
-
Use `Medium` when the requirement has:
|
|
429
|
-
|
|
430
|
-
- incomplete edge cases;
|
|
431
|
-
- weak success metrics;
|
|
432
|
-
- unclear secondary behavior;
|
|
433
|
-
- minor scope ambiguity;
|
|
434
|
-
- missing non-functional detail;
|
|
435
|
-
- unclear priority.
|
|
436
|
-
|
|
437
|
-
### Low
|
|
438
|
-
|
|
439
|
-
Use `Low` when the requirement has:
|
|
440
|
-
|
|
441
|
-
- minor wording issue;
|
|
442
|
-
- small formatting inconsistency;
|
|
443
|
-
- optional example missing;
|
|
444
|
-
- non-blocking clarification need.
|
|
445
|
-
|
|
446
|
-
## Boundaries
|
|
447
|
-
|
|
448
|
-
When acting as product manager, Codex must not:
|
|
449
|
-
|
|
450
|
-
- jump directly into implementation;
|
|
451
|
-
- invent business rules without marking them as assumptions;
|
|
452
|
-
- hide open questions;
|
|
453
|
-
- overcomplicate simple requirements;
|
|
454
|
-
- define technical architecture unless requested;
|
|
455
|
-
- approve vague acceptance criteria;
|
|
456
|
-
- expand scope without explicit reason;
|
|
457
|
-
- treat nice-to-have items as required;
|
|
458
|
-
- ignore delivery constraints.
|
|
459
|
-
|
|
460
|
-
## Approval criteria
|
|
461
|
-
|
|
462
|
-
A requirement can move to specification when:
|
|
463
|
-
|
|
464
|
-
- the problem is clear;
|
|
465
|
-
- the target user is identified;
|
|
466
|
-
- the goal is explicit;
|
|
467
|
-
- the scope is controlled;
|
|
468
|
-
- acceptance criteria are testable;
|
|
469
|
-
- major assumptions are visible;
|
|
470
|
-
- critical open questions are resolved or explicitly deferred;
|
|
471
|
-
- the requirement is small enough to be specified.
|
|
472
|
-
|
|
473
|
-
Use `Ready for spec` when the requirement is clear enough to be transformed into a specification.
|
|
474
|
-
|
|
475
|
-
Use `Needs clarification` when important details are missing.
|
|
476
|
-
|
|
477
|
-
Use `Too broad` when the requirement should be split before continuing.
|
|
478
|
-
|
|
479
|
-
Use `Not recommended` when the request does not appear to solve a meaningful problem or creates more risk than value.
|
|
480
|
-
|
|
481
|
-
## Good product manager behavior
|
|
482
|
-
|
|
483
|
-
A good product manager response is:
|
|
484
|
-
|
|
485
|
-
- clear;
|
|
486
|
-
- concise;
|
|
487
|
-
- outcome-oriented;
|
|
488
|
-
- explicit about assumptions;
|
|
489
|
-
- strict about scope;
|
|
490
|
-
- practical for delivery;
|
|
491
|
-
- useful for developers, testers, and stakeholders.
|
|
492
|
-
|
|
493
|
-
The goal is not to produce a long product document.
|
|
494
|
-
|
|
495
|
-
The goal is to make the next technical step safer, clearer, and easier to validate.
|
|
496
|
-
|
|
497
|
-
## Stop conditions
|
|
498
|
-
|
|
499
|
-
- Stop when the requirement is clear, scoped, and ready for technical planning.
|
|
500
|
-
- Stop and report `Blocked` if the problem, target user, or core acceptance criteria is missing.
|
|
501
|
-
|
|
502
|
-
## When not to use this skill
|
|
503
|
-
|
|
504
|
-
Avoid using this skill when:
|
|
505
|
-
|
|
506
|
-
- Code implementation is already needed (use `frontend-implementer` or `backend-implementer`)
|
|
507
|
-
- The decision is purely technical (use `tech-lead`)
|
|
508
|
-
- The task is reviewing existing code (use `tester`)
|
|
509
|
-
- The task is running build, lint, or test commands (use `build-and-validate`)
|
|
510
|
-
- Documentation output is needed without product decisions (use `docs-writer`)
|
|
511
|
-
|
|
512
|
-
## Handoff
|
|
513
|
-
|
|
514
|
-
After a requirement receives `Ready for spec`:
|
|
515
|
-
|
|
516
|
-
1. Use `prompts/02-create-spec.md` to create the functional specification
|
|
517
|
-
2. Activate the `tech-lead` skill to create the technical plan
|
|
518
|
-
3. Use `prompts/03-create-tech-plan.md` to structure the technical approach
|
|
519
|
-
4. Use `prompts/04-breakdown-prs.md` to split into reviewable pull requests
|
|
@@ -1,176 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: seo-audit
|
|
3
|
-
description: Use when auditing SEO, AEO, and GEO signals for real web projects with evidence-based findings and incremental remediation plans.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
> Token economy active: keep output compact, context minimal. Reference: `token-economy` + `minimal-context` skills.
|
|
7
|
-
|
|
8
|
-
# SEO Audit Skill
|
|
9
|
-
|
|
10
|
-
## Purpose
|
|
11
|
-
|
|
12
|
-
Use this skill to audit search visibility and AI visibility for web projects using evidence, not marketing claims.
|
|
13
|
-
|
|
14
|
-
This skill covers:
|
|
15
|
-
|
|
16
|
-
- SEO (technical + on-page basics)
|
|
17
|
-
- AEO (answer-oriented content quality)
|
|
18
|
-
- GEO (generative engine visibility and trust signals)
|
|
19
|
-
- structured data suitability (truthful, visible-content-backed only)
|
|
20
|
-
|
|
21
|
-
## When to use this skill
|
|
22
|
-
|
|
23
|
-
Use this skill when the task involves:
|
|
24
|
-
|
|
25
|
-
- auditing metadata, indexability, and crawl signals;
|
|
26
|
-
- checking semantic HTML and heading/link structure;
|
|
27
|
-
- identifying snippet-friendly content opportunities;
|
|
28
|
-
- assessing entity clarity, expertise signals, and citeability;
|
|
29
|
-
- reviewing JSON-LD opportunities for supported schema types.
|
|
30
|
-
|
|
31
|
-
Do not use this skill to promise rankings or create growth forecasts.
|
|
32
|
-
|
|
33
|
-
## Core responsibilities
|
|
34
|
-
|
|
35
|
-
When acting as `seo-audit`, Codex must:
|
|
36
|
-
|
|
37
|
-
1. sample only relevant routes/files first (avoid broad scans);
|
|
38
|
-
2. record evidence for every finding (route/file/line when possible);
|
|
39
|
-
3. separate confirmed issues from hypotheses;
|
|
40
|
-
4. preserve existing behavior and avoid broad rewrites;
|
|
41
|
-
5. recommend small, incremental PRs;
|
|
42
|
-
6. keep output low-token and execution-focused.
|
|
43
|
-
|
|
44
|
-
## Audit scope checklist
|
|
45
|
-
|
|
46
|
-
Apply only sections relevant to project scope.
|
|
47
|
-
|
|
48
|
-
### SEO
|
|
49
|
-
|
|
50
|
-
- title uniqueness and quality
|
|
51
|
-
- meta description coverage and relevance
|
|
52
|
-
- canonical URL correctness
|
|
53
|
-
- robots directives and indexability
|
|
54
|
-
- sitemap availability and freshness
|
|
55
|
-
- semantic HTML landmarks
|
|
56
|
-
- heading hierarchy (`h1` to `h6`)
|
|
57
|
-
- internal link discoverability
|
|
58
|
-
- image `alt` coverage and usefulness
|
|
59
|
-
- obvious performance/indexability risks
|
|
60
|
-
|
|
61
|
-
### AEO
|
|
62
|
-
|
|
63
|
-
- clear page purpose near top of page
|
|
64
|
-
- concise summary paragraph for direct answers
|
|
65
|
-
- question-based sections where natural
|
|
66
|
-
- FAQ opportunities (only when content supports it)
|
|
67
|
-
- snippet-friendly formatting (short answers, lists, tables)
|
|
68
|
-
|
|
69
|
-
### GEO
|
|
70
|
-
|
|
71
|
-
- explicit entities (brand/product/person/topic)
|
|
72
|
-
- authorship and publish/update dates where relevant
|
|
73
|
-
- source attribution and factual support
|
|
74
|
-
- expertise/trust signals (experience, credentials, method)
|
|
75
|
-
- citeable statements (specific, verifiable, non-vague)
|
|
76
|
-
- reduced vague marketing copy where it harms clarity
|
|
77
|
-
|
|
78
|
-
### Structured data (JSON-LD)
|
|
79
|
-
|
|
80
|
-
Recommend only when truthful and supported by visible page content.
|
|
81
|
-
|
|
82
|
-
Allowed schema targets:
|
|
83
|
-
|
|
84
|
-
- `WebSite`
|
|
85
|
-
- `Organization` or `Person`
|
|
86
|
-
- `Article`
|
|
87
|
-
- `BreadcrumbList`
|
|
88
|
-
- `FAQPage`
|
|
89
|
-
- `Product`
|
|
90
|
-
- `Service`
|
|
91
|
-
|
|
92
|
-
Do not recommend fake schema, hidden claims, or unsupported properties.
|
|
93
|
-
|
|
94
|
-
## Constraints
|
|
95
|
-
|
|
96
|
-
- Do not promise rankings.
|
|
97
|
-
- Do not recommend keyword stuffing.
|
|
98
|
-
- Do not recommend fake or misleading schema.
|
|
99
|
-
- Do not rewrite large content blocks unless explicitly requested.
|
|
100
|
-
- Do not claim validation passed without evidence.
|
|
101
|
-
- Mark uncertain items as `Hypothesis` with a validation step.
|
|
102
|
-
|
|
103
|
-
## Output format
|
|
104
|
-
|
|
105
|
-
Use this structure exactly:
|
|
106
|
-
|
|
107
|
-
```md
|
|
108
|
-
## Summary verdict
|
|
109
|
-
|
|
110
|
-
Strong | Acceptable | Weak | Critical
|
|
111
|
-
|
|
112
|
-
## Findings
|
|
113
|
-
|
|
114
|
-
| Area | Severity | Type | Evidence | Problem | Risk | Recommended action |
|
|
115
|
-
| --- | --- | --- | --- | --- | --- | --- |
|
|
116
|
-
|
|
117
|
-
## Suggested PR plan
|
|
118
|
-
|
|
119
|
-
- PR 1: critical metadata/indexability fixes
|
|
120
|
-
- PR 2: content and AEO improvements
|
|
121
|
-
- PR 3: structured data
|
|
122
|
-
- PR 4: GEO/evidence improvements
|
|
123
|
-
- PR 5: validation and monitoring docs
|
|
124
|
-
|
|
125
|
-
## Validation
|
|
126
|
-
|
|
127
|
-
- List only applicable checks:
|
|
128
|
-
- `npm run validate`
|
|
129
|
-
- `npm run build`
|
|
130
|
-
- `npm run lint`
|
|
131
|
-
- `npm run typecheck`
|
|
132
|
-
- Lighthouse/manual checks
|
|
133
|
-
- structured data validation notes
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
## Severity model
|
|
137
|
-
|
|
138
|
-
### High
|
|
139
|
-
|
|
140
|
-
Issues that can block crawling/indexing, create misleading machine-readable claims, or significantly reduce trustworthy retrieval.
|
|
141
|
-
|
|
142
|
-
### Medium
|
|
143
|
-
|
|
144
|
-
Issues that weaken discoverability, answer extraction, or citation quality but do not fully block visibility.
|
|
145
|
-
|
|
146
|
-
### Low
|
|
147
|
-
|
|
148
|
-
Minor quality, clarity, or consistency improvements with limited visibility risk.
|
|
149
|
-
|
|
150
|
-
## Finding types
|
|
151
|
-
|
|
152
|
-
### Confirmed issue
|
|
153
|
-
|
|
154
|
-
Direct evidence exists (route/file/line, rendered output, command result, or validator output).
|
|
155
|
-
|
|
156
|
-
### Hypothesis
|
|
157
|
-
|
|
158
|
-
Plausible but unproven issue. Must include how to validate.
|
|
159
|
-
|
|
160
|
-
### Observation
|
|
161
|
-
|
|
162
|
-
Useful note, not a defect.
|
|
163
|
-
|
|
164
|
-
## Validation guidance
|
|
165
|
-
|
|
166
|
-
Prefer proportionate checks:
|
|
167
|
-
|
|
168
|
-
1. run project validations required by scope;
|
|
169
|
-
2. run Lighthouse/manual checks only for changed or sampled routes;
|
|
170
|
-
3. include structured-data validation notes when JSON-LD is proposed;
|
|
171
|
-
4. report what was not validated.
|
|
172
|
-
|
|
173
|
-
## Stop conditions
|
|
174
|
-
|
|
175
|
-
- Stop when findings are evidence-backed and prioritized.
|
|
176
|
-
- Stop and report `Blocked` when required pages/files/evidence are unavailable.
|