@pennyfarthing/core 9.0.0 → 9.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -7
- package/package.json +1 -1
- package/packages/core/dist/cli/commands/doctor.d.ts +5 -2
- package/packages/core/dist/cli/commands/doctor.d.ts.map +1 -1
- package/packages/core/dist/cli/commands/doctor.js +225 -17
- package/packages/core/dist/cli/commands/doctor.js.map +1 -1
- package/packages/core/dist/cli/commands/init.d.ts.map +1 -1
- package/packages/core/dist/cli/commands/init.js +3 -246
- package/packages/core/dist/cli/commands/init.js.map +1 -1
- package/packages/core/dist/cli/commands/update.d.ts.map +1 -1
- package/packages/core/dist/cli/commands/update.js +4 -140
- package/packages/core/dist/cli/commands/update.js.map +1 -1
- package/packages/core/dist/cli/utils/constants.d.ts +7 -1
- package/packages/core/dist/cli/utils/constants.d.ts.map +1 -1
- package/packages/core/dist/cli/utils/constants.js +2 -0
- package/packages/core/dist/cli/utils/constants.js.map +1 -1
- package/packages/core/dist/cli/utils/settings.d.ts +22 -0
- package/packages/core/dist/cli/utils/settings.d.ts.map +1 -0
- package/packages/core/dist/cli/utils/settings.js +300 -0
- package/packages/core/dist/cli/utils/settings.js.map +1 -0
- package/pennyfarthing-dist/commands/chore.md +18 -17
- package/pennyfarthing-dist/commands/continue-session.md +41 -7
- package/pennyfarthing-dist/commands/fix-blocker.md +22 -0
- package/pennyfarthing-dist/commands/git-cleanup.md +25 -19
- package/pennyfarthing-dist/commands/patch.md +210 -0
- package/pennyfarthing-dist/guides/session-schema.md +346 -0
- package/pennyfarthing-dist/guides/skill-schema.md +412 -0
- package/pennyfarthing-dist/guides/workflow-step-schema.md +512 -0
- package/pennyfarthing-dist/guides/xml-tags.md +292 -0
- package/pennyfarthing-dist/scripts/hooks/context-circuit-breaker.sh +43 -8
- package/pennyfarthing-dist/scripts/hooks/schema-validation.sh +30 -0
- package/pennyfarthing-dist/scripts/lib/find-root.sh +32 -7
- package/pennyfarthing-dist/skills/agentic-patterns/SKILL.md +4 -0
- package/pennyfarthing-dist/skills/changelog/SKILL.md +18 -0
- package/pennyfarthing-dist/skills/code-review/SKILL.md +5 -1
- package/pennyfarthing-dist/skills/context-engineering/SKILL.md +3 -0
- package/pennyfarthing-dist/skills/cyclist/SKILL.md +2 -2
- package/pennyfarthing-dist/skills/dev-patterns/SKILL.md +24 -0
- package/pennyfarthing-dist/skills/finalize-run/SKILL.md +3 -0
- package/pennyfarthing-dist/skills/judge/SKILL.md +8 -0
- package/pennyfarthing-dist/skills/just/SKILL.md +11 -0
- package/pennyfarthing-dist/skills/mermaid/SKILL.md +16 -0
- package/pennyfarthing-dist/skills/otel/skill.md +4 -0
- package/pennyfarthing-dist/skills/permissions/skill.md +3 -0
- package/pennyfarthing-dist/skills/persona-benchmark/SKILL.md +9 -0
- package/pennyfarthing-dist/skills/story/skill.md +16 -16
- package/pennyfarthing-dist/skills/systematic-debugging/SKILL.md +56 -0
- package/pennyfarthing-dist/skills/testing/SKILL.md +22 -0
- package/pennyfarthing-dist/skills/theme/skill.md +12 -0
- package/pennyfarthing-dist/skills/theme-creation/SKILL.md +4 -0
- package/pennyfarthing-dist/skills/workflow/skill.md +22 -14
- package/pennyfarthing-dist/skills/yq/SKILL.md +8 -0
- package/pennyfarthing-dist/templates/settings.local.json.template +9 -0
- package/pennyfarthing-dist/workflows/architecture/steps/step-01-initialize.md +12 -0
- package/pennyfarthing-dist/workflows/architecture/steps/step-01b-continue.md +12 -0
- package/pennyfarthing-dist/workflows/architecture/steps/step-02-context.md +12 -0
- package/pennyfarthing-dist/workflows/architecture/steps/step-03-patterns.md +12 -0
- package/pennyfarthing-dist/workflows/architecture/steps/step-04-components.md +12 -0
- package/pennyfarthing-dist/workflows/architecture/steps/step-05-interfaces.md +12 -0
- package/pennyfarthing-dist/workflows/architecture/steps/step-06-risks.md +12 -0
- package/pennyfarthing-dist/workflows/architecture/steps/step-07-document.md +12 -0
- package/pennyfarthing-dist/workflows/epics-and-stories/steps/step-01-validate-prerequisites.md +25 -0
- package/pennyfarthing-dist/workflows/epics-and-stories/steps/step-02-design-epics.md +23 -0
- package/pennyfarthing-dist/workflows/epics-and-stories/steps/step-03-create-stories.md +26 -0
- package/pennyfarthing-dist/workflows/epics-and-stories/steps/step-04-final-validation.md +24 -0
- package/pennyfarthing-dist/workflows/epics-and-stories/steps/step-05-import-to-future.md +23 -0
- package/pennyfarthing-dist/workflows/git-cleanup/steps/step-01-analyze.md +43 -41
- package/pennyfarthing-dist/workflows/git-cleanup/steps/step-02-categorize.md +50 -19
- package/pennyfarthing-dist/workflows/git-cleanup/steps/step-03-execute.md +102 -111
- package/pennyfarthing-dist/workflows/git-cleanup/steps/step-04-verify.md +48 -39
- package/pennyfarthing-dist/workflows/git-cleanup/steps/step-05-complete.md +30 -31
- package/pennyfarthing-dist/workflows/implementation-readiness/steps/step-01-document-discovery.md +21 -0
- package/pennyfarthing-dist/workflows/implementation-readiness/steps/step-02-prd-analysis.md +21 -0
- package/pennyfarthing-dist/workflows/implementation-readiness/steps/step-03-epic-coverage-validation.md +23 -0
- package/pennyfarthing-dist/workflows/implementation-readiness/steps/step-04-ux-alignment.md +23 -0
- package/pennyfarthing-dist/workflows/implementation-readiness/steps/step-05-epic-quality-review.md +28 -0
- package/pennyfarthing-dist/workflows/implementation-readiness/steps/step-06-final-assessment.md +25 -0
- package/pennyfarthing-dist/workflows/interactive-debug/steps/step-01-connect.md +257 -0
- package/pennyfarthing-dist/workflows/interactive-debug/steps/step-02-explore.md +107 -0
- package/pennyfarthing-dist/workflows/interactive-debug/steps/step-03-fix.md +127 -0
- package/pennyfarthing-dist/workflows/interactive-debug/steps/step-04-commit.md +122 -0
- package/pennyfarthing-dist/workflows/interactive-debug/workflow.yaml +51 -0
- package/pennyfarthing-dist/workflows/prd/steps-c/step-01-init.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-c/step-01b-continue.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-c/step-02-discovery.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-c/step-03-success.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-c/step-04-journeys.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-c/step-05-domain.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-c/step-06-innovation.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-c/step-07-project-type.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-c/step-08-scoping.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-c/step-09-functional.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-c/step-10-nonfunctional.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-c/step-11-polish.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-c/step-12-complete.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-e/step-e-01-discovery.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-e/step-e-01b-legacy-conversion.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-e/step-e-02-review.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-e/step-e-03-edit.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-e/step-e-04-complete.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-v/step-v-01-discovery.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-v/step-v-02-format-detection.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-v/step-v-02b-parity-check.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-v/step-v-03-density-validation.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-v/step-v-04-brief-coverage-validation.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-v/step-v-05-measurability-validation.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-v/step-v-06-traceability-validation.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-v/step-v-07-implementation-leakage-validation.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-v/step-v-08-domain-compliance-validation.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-v/step-v-09-project-type-validation.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-v/step-v-10-smart-validation.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-v/step-v-11-holistic-quality-validation.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-v/step-v-12-completeness-validation.md +6 -0
- package/pennyfarthing-dist/workflows/prd/steps-v/step-v-13-report-complete.md +6 -0
- package/pennyfarthing-dist/workflows/product-brief/steps/step-01-init.md +18 -0
- package/pennyfarthing-dist/workflows/product-brief/steps/step-01b-continue.md +19 -0
- package/pennyfarthing-dist/workflows/product-brief/steps/step-02-vision.md +22 -0
- package/pennyfarthing-dist/workflows/product-brief/steps/step-03-users.md +22 -0
- package/pennyfarthing-dist/workflows/product-brief/steps/step-04-metrics.md +23 -0
- package/pennyfarthing-dist/workflows/product-brief/steps/step-05-scope.md +24 -0
- package/pennyfarthing-dist/workflows/product-brief/steps/step-06-complete.md +22 -0
- package/pennyfarthing-dist/workflows/project-context/steps/step-01-discover.md +22 -0
- package/pennyfarthing-dist/workflows/project-context/steps/step-02-generate.md +31 -0
- package/pennyfarthing-dist/workflows/project-context/steps/step-03-complete.md +28 -0
- package/pennyfarthing-dist/workflows/quick-dev/steps/step-01-mode-detection.md +21 -0
- package/pennyfarthing-dist/workflows/quick-dev/steps/step-02-context-gathering.md +23 -0
- package/pennyfarthing-dist/workflows/quick-dev/steps/step-03-execute.md +25 -0
- package/pennyfarthing-dist/workflows/quick-dev/steps/step-04-self-check.md +22 -0
- package/pennyfarthing-dist/workflows/quick-dev/steps/step-05-adversarial-review.md +23 -0
- package/pennyfarthing-dist/workflows/quick-dev/steps/step-06-resolve-findings.md +23 -0
- package/pennyfarthing-dist/workflows/quick-spec/steps/step-01-understand.md +12 -0
- package/pennyfarthing-dist/workflows/quick-spec/steps/step-02-investigate.md +12 -0
- package/pennyfarthing-dist/workflows/quick-spec/steps/step-03-generate.md +12 -0
- package/pennyfarthing-dist/workflows/quick-spec/steps/step-04-review.md +12 -0
- package/pennyfarthing-dist/workflows/research/steps-domain/step-01-init.md +22 -0
- package/pennyfarthing-dist/workflows/research/steps-domain/step-02-domain-analysis.md +24 -0
- package/pennyfarthing-dist/workflows/research/steps-domain/step-03-competitive-landscape.md +25 -0
- package/pennyfarthing-dist/workflows/research/steps-domain/step-04-regulatory-focus.md +26 -0
- package/pennyfarthing-dist/workflows/research/steps-domain/step-05-technical-trends.md +26 -0
- package/pennyfarthing-dist/workflows/research/steps-domain/step-06-research-synthesis.md +34 -0
- package/pennyfarthing-dist/workflows/research/steps-market/step-01-init.md +23 -0
- package/pennyfarthing-dist/workflows/research/steps-market/step-02-customer-behavior.md +25 -0
- package/pennyfarthing-dist/workflows/research/steps-market/step-02-customer-insights.md +27 -0
- package/pennyfarthing-dist/workflows/research/steps-market/step-03-customer-pain-points.md +26 -0
- package/pennyfarthing-dist/workflows/research/steps-market/step-04-customer-decisions.md +27 -0
- package/pennyfarthing-dist/workflows/research/steps-market/step-05-competitive-analysis.md +26 -0
- package/pennyfarthing-dist/workflows/research/steps-market/step-06-research-completion.md +35 -0
- package/pennyfarthing-dist/workflows/research/steps-technical/step-01-init.md +22 -0
- package/pennyfarthing-dist/workflows/research/steps-technical/step-02-technical-overview.md +25 -0
- package/pennyfarthing-dist/workflows/research/steps-technical/step-03-integration-patterns.md +26 -0
- package/pennyfarthing-dist/workflows/research/steps-technical/step-04-architectural-patterns.md +26 -0
- package/pennyfarthing-dist/workflows/research/steps-technical/step-05-implementation-research.md +29 -1
- package/pennyfarthing-dist/workflows/research/steps-technical/step-06-research-synthesis.md +37 -1
- package/pennyfarthing-dist/workflows/sprint-planning/steps/step-01-parse-epic-files.md +15 -0
- package/pennyfarthing-dist/workflows/sprint-planning/steps/step-02-build-sprint-status.md +17 -0
- package/pennyfarthing-dist/workflows/sprint-planning/steps/step-03-status-detection.md +16 -0
- package/pennyfarthing-dist/workflows/sprint-planning/steps/step-04-generate-status-file.md +17 -0
- package/pennyfarthing-dist/workflows/sprint-planning/steps/step-05-validate-and-report.md +22 -0
- package/pennyfarthing-dist/workflows/ux-design/steps/step-01-init.md +6 -0
- package/pennyfarthing-dist/workflows/ux-design/steps/step-01b-continue.md +6 -0
- package/pennyfarthing-dist/workflows/ux-design/steps/step-02-discovery.md +6 -0
- package/pennyfarthing-dist/workflows/ux-design/steps/step-03-core-experience.md +6 -0
- package/pennyfarthing-dist/workflows/ux-design/steps/step-04-emotional-response.md +6 -0
- package/pennyfarthing-dist/workflows/ux-design/steps/step-05-inspiration.md +6 -0
- package/pennyfarthing-dist/workflows/ux-design/steps/step-06-design-system.md +6 -0
- package/pennyfarthing-dist/workflows/ux-design/steps/step-07-defining-experience.md +6 -0
- package/pennyfarthing-dist/workflows/ux-design/steps/step-08-visual-foundation.md +6 -0
- package/pennyfarthing-dist/workflows/ux-design/steps/step-09-design-directions.md +6 -0
- package/pennyfarthing-dist/workflows/ux-design/steps/step-10-user-journeys.md +6 -0
- package/pennyfarthing-dist/workflows/ux-design/steps/step-11-component-strategy.md +6 -0
- package/pennyfarthing-dist/workflows/ux-design/steps/step-12-ux-patterns.md +6 -0
- package/pennyfarthing-dist/workflows/ux-design/steps/step-13-responsive-accessibility.md +6 -0
- package/pennyfarthing-dist/workflows/ux-design/steps/step-14-complete.md +6 -0
- package/pennyfarthing_scripts/migration/__init__.py +39 -0
- package/pennyfarthing_scripts/migration/__main__.py +10 -0
- package/pennyfarthing_scripts/migration/cli.py +304 -0
- package/pennyfarthing_scripts/migration/session.py +384 -0
- package/pennyfarthing_scripts/migration/skill.py +188 -0
- package/pennyfarthing_scripts/migration/step.py +229 -0
- package/pennyfarthing_scripts/migration/validate.py +282 -0
- package/pennyfarthing_scripts/schema_validation_hook.py +306 -0
- package/pennyfarthing_scripts/sprint/__pycache__/cli.cpython-314.pyc +0 -0
- package/pennyfarthing_scripts/sprint/archive_epic.py +399 -0
- package/pennyfarthing_scripts/sprint/cli.py +100 -0
- package/pennyfarthing_scripts/sprint/import_epic.py +431 -0
- package/pennyfarthing_scripts/story/__pycache__/__init__.cpython-314.pyc +0 -0
- package/pennyfarthing_scripts/story/__pycache__/__main__.cpython-314.pyc +0 -0
- package/pennyfarthing_scripts/story/__pycache__/cli.cpython-314.pyc +0 -0
- package/pennyfarthing_scripts/story/__pycache__/create.cpython-314.pyc +0 -0
- package/pennyfarthing_scripts/story/__pycache__/size.cpython-314.pyc +0 -0
- package/pennyfarthing_scripts/story/__pycache__/template.cpython-314.pyc +0 -0
- package/pennyfarthing-dist/scripts/sprint/import-epic-to-future.sh +0 -10
- package/pennyfarthing-dist/scripts/sprint/import_epic_to_future.py +0 -270
|
@@ -11,6 +11,12 @@ prdPurpose: '../data/prd-purpose.md'
|
|
|
11
11
|
|
|
12
12
|
# Step 1: Document Discovery & Confirmation
|
|
13
13
|
|
|
14
|
+
<purpose>Handle fresh context validation by confirming PRD path, discovering and loading input documents from frontmatter, and initializing the validation report.</purpose>
|
|
15
|
+
|
|
16
|
+
<instructions>Confirm PRD file path is valid; load complete PRD document and frontmatter; extract and reload input documents from inputDocuments array; create validation report with PRD metadata; confirm readiness to begin validation checks.</instructions>
|
|
17
|
+
|
|
18
|
+
<output>Loaded PRD document with complete context, extracted and verified input documents, initialized validation report with PRD metadata, ready for format detection and validation checks.</output>
|
|
19
|
+
|
|
14
20
|
## STEP GOAL:
|
|
15
21
|
|
|
16
22
|
Handle fresh context validation by confirming PRD path, discovering and loading input documents from frontmatter, and initializing the validation report.
|
|
@@ -11,6 +11,12 @@ validationReportPath: '{validation_report_path}'
|
|
|
11
11
|
|
|
12
12
|
# Step 2: Format Detection & Structure Analysis
|
|
13
13
|
|
|
14
|
+
<purpose>Detect if PRD follows BMAD format and route appropriately - classify as BMAD Standard, BMAD Variant, or Non-Standard format.</purpose>
|
|
15
|
+
|
|
16
|
+
<instructions>Analyze PRD structure to detect format conformance; identify section presence and order; classify format type; for non-standard formats, offer optional parity check; update validation report with format classification; route to appropriate next validation step.</instructions>
|
|
17
|
+
|
|
18
|
+
<output>PRD format classification (BMAD Standard/Variant/Non-Standard), structure analysis summary, validation report updated with format findings, ready for format-specific validation checks.</output>
|
|
19
|
+
|
|
14
20
|
## STEP GOAL:
|
|
15
21
|
|
|
16
22
|
Detect if PRD follows BMAD format and route appropriately - classify as BMAD Standard / BMAD Variant / Non-Standard, with optional parity check for non-standard formats.
|
|
@@ -10,6 +10,12 @@ validationReportPath: '{validation_report_path}'
|
|
|
10
10
|
|
|
11
11
|
# Step 2B: Document Parity Check
|
|
12
12
|
|
|
13
|
+
<purpose>Analyze non-standard PRD and identify gaps to achieve BMAD PRD parity, presenting user with options for how to proceed.</purpose>
|
|
14
|
+
|
|
15
|
+
<instructions>Load and deeply analyze non-standard PRD structure; identify missing sections and gaps relative to BMAD standard; map existing content to BMAD sections; prepare parity analysis with specific recommendations; present user with conversion options (full conversion, selective upgrade, continue as-is).</instructions>
|
|
16
|
+
|
|
17
|
+
<output>Detailed parity analysis documenting gaps between current format and BMAD standard, conversion recommendations with effort estimates, and user-selected approach for proceeding with validation.</output>
|
|
18
|
+
|
|
13
19
|
## STEP GOAL:
|
|
14
20
|
|
|
15
21
|
Analyze non-standard PRD and identify gaps to achieve BMAD PRD parity, presenting user with options for how to proceed.
|
|
@@ -10,6 +10,12 @@ validationReportPath: '{validation_report_path}'
|
|
|
10
10
|
|
|
11
11
|
# Step 3: Information Density Validation
|
|
12
12
|
|
|
13
|
+
<purpose>Validate PRD meets BMAD information density standards by scanning for conversational filler, wordy phrases, and redundant expressions that violate conciseness principles.</purpose>
|
|
14
|
+
|
|
15
|
+
<instructions>Analyze PRD content for information density violations; scan for anti-patterns including conversational filler, wordiness, redundancy, and verbose phrasing; calculate density metrics; document violations with location and severity; update validation report with findings; optionally suggest improvements.</instructions>
|
|
16
|
+
|
|
17
|
+
<output>Density validation report with identified violations, severity classification, specific locations, density metrics, and optional improvement suggestions.</output>
|
|
18
|
+
|
|
13
19
|
## STEP GOAL:
|
|
14
20
|
|
|
15
21
|
Validate PRD meets BMAD information density standards by scanning for conversational filler, wordy phrases, and redundant expressions that violate conciseness principles.
|
|
@@ -11,6 +11,12 @@ validationReportPath: '{validation_report_path}'
|
|
|
11
11
|
|
|
12
12
|
# Step 4: Product Brief Coverage Validation
|
|
13
13
|
|
|
14
|
+
<purpose>Validate that PRD covers all content from Product Brief (if brief was used as input), mapping brief content to PRD sections and identifying gaps.</purpose>
|
|
15
|
+
|
|
16
|
+
<instructions>Check if product brief exists in inputDocuments; if brief available, load it and analyze key content areas; map brief content to PRD sections; identify coverage gaps and unmapped content; calculate coverage percentage; update validation report with coverage findings.</instructions>
|
|
17
|
+
|
|
18
|
+
<output>Coverage validation report with mapped brief content, identified coverage gaps, coverage percentage metric, and recommendations for addressing gaps.</output>
|
|
19
|
+
|
|
14
20
|
## STEP GOAL:
|
|
15
21
|
|
|
16
22
|
Validate that PRD covers all content from Product Brief (if brief was used as input), mapping brief content to PRD sections and identifying gaps.
|
|
@@ -10,6 +10,12 @@ validationReportPath: '{validation_report_path}'
|
|
|
10
10
|
|
|
11
11
|
# Step 5: Measurability Validation
|
|
12
12
|
|
|
13
|
+
<purpose>Validate that all Functional Requirements (FRs) and Non-Functional Requirements (NFRs) are measurable, testable, and follow proper format without implementation details.</purpose>
|
|
14
|
+
|
|
15
|
+
<instructions>Extract all FRs and NFRs from PRD; analyze each requirement for measurability indicators (numeric targets, acceptance criteria, pass/fail conditions); check for implementation leakage; identify non-measurable requirements; classify severity of measurability issues; update validation report.</instructions>
|
|
16
|
+
|
|
17
|
+
<output>Measurability validation report with analysis of each requirement, identification of non-measurable requirements, severity classification, implementation leakage findings, and recommendations for improvement.</output>
|
|
18
|
+
|
|
13
19
|
## STEP GOAL:
|
|
14
20
|
|
|
15
21
|
Validate that all Functional Requirements (FRs) and Non-Functional Requirements (NFRs) are measurable, testable, and follow proper format without implementation details.
|
|
@@ -10,6 +10,12 @@ validationReportPath: '{validation_report_path}'
|
|
|
10
10
|
|
|
11
11
|
# Step 6: Traceability Validation
|
|
12
12
|
|
|
13
|
+
<purpose>Validate the traceability chain from Executive Summary → Success Criteria → User Journeys → Functional Requirements is intact, ensuring every requirement traces back to a user need or business objective.</purpose>
|
|
14
|
+
|
|
15
|
+
<instructions>Extract vision, success criteria, user journeys, and requirements from PRD; map traceability links from requirements back to journeys, success criteria, and vision; identify orphaned requirements without traceability; verify bidirectional traceability; calculate traceability completeness; update validation report.</instructions>
|
|
16
|
+
|
|
17
|
+
<output>Traceability validation report with traceability chain visualization, identified gaps and orphaned requirements, bidirectional traceability verification, traceability coverage metrics.</output>
|
|
18
|
+
|
|
13
19
|
## STEP GOAL:
|
|
14
20
|
|
|
15
21
|
Validate the traceability chain from Executive Summary → Success Criteria → User Journeys → Functional Requirements is intact, ensuring every requirement traces back to a user need or business objective.
|
package/pennyfarthing-dist/workflows/prd/steps-v/step-v-07-implementation-leakage-validation.md
CHANGED
|
@@ -10,6 +10,12 @@ validationReportPath: '{validation_report_path}'
|
|
|
10
10
|
|
|
11
11
|
# Step 7: Implementation Leakage Validation
|
|
12
12
|
|
|
13
|
+
<purpose>Ensure Functional Requirements and Non-Functional Requirements don't include implementation details - they should specify WHAT, not HOW.</purpose>
|
|
14
|
+
|
|
15
|
+
<instructions>Extract all FRs and NFRs from PRD; scan each requirement for implementation keywords and patterns (specific technologies, frameworks, methodologies, HOW details); identify leakage violations; classify by severity; calculate leakage percentage; update validation report with findings and recommendations.</instructions>
|
|
16
|
+
|
|
17
|
+
<output>Implementation leakage validation report with identified violations, severity classification, specific examples of leakage, leakage metrics, and recommendations for abstraction improvements.</output>
|
|
18
|
+
|
|
13
19
|
## STEP GOAL:
|
|
14
20
|
|
|
15
21
|
Ensure Functional Requirements and Non-Functional Requirements don't include implementation details - they should specify WHAT, not HOW.
|
|
@@ -12,6 +12,12 @@ domainComplexityData: '../data/domain-complexity.csv'
|
|
|
12
12
|
|
|
13
13
|
# Step 8: Domain Compliance Validation
|
|
14
14
|
|
|
15
|
+
<purpose>Validate domain-specific requirements are present for high-complexity domains (Healthcare, Fintech, GovTech, etc.), ensuring regulatory and compliance requirements are properly documented.</purpose>
|
|
16
|
+
|
|
17
|
+
<instructions>Determine project domain from PRD frontmatter; check domain complexity level from CSV data; for high-complexity domains, verify domain-specific requirements section exists and covers applicable regulations; analyze compliance coverage; identify compliance gaps; update validation report.</instructions>
|
|
18
|
+
|
|
19
|
+
<output>Domain compliance validation report with complexity assessment, identified compliance requirements, coverage analysis, compliance gaps, and recommendations for domain-specific improvements.</output>
|
|
20
|
+
|
|
15
21
|
## STEP GOAL:
|
|
16
22
|
|
|
17
23
|
Validate domain-specific requirements are present for high-complexity domains (Healthcare, Fintech, GovTech, etc.), ensuring regulatory and compliance requirements are properly documented.
|
|
@@ -12,6 +12,12 @@ projectTypesData: '../data/project-types.csv'
|
|
|
12
12
|
|
|
13
13
|
# Step 9: Project-Type Compliance Validation
|
|
14
14
|
|
|
15
|
+
<purpose>Validate project-type specific requirements are properly documented - different project types (api_backend, web_app, mobile_app, etc.) have different required and excluded sections.</purpose>
|
|
16
|
+
|
|
17
|
+
<instructions>Determine project type from PRD frontmatter; load project-type requirements from CSV data; verify all required sections for project type are present; check for prohibited sections; analyze type-specific requirement coverage; identify gaps; update validation report.</instructions>
|
|
18
|
+
|
|
19
|
+
<output>Project-type compliance validation report with required/optional section verification, identified gaps, type-specific coverage analysis, and recommendations for project-type conformance.</output>
|
|
20
|
+
|
|
15
21
|
## STEP GOAL:
|
|
16
22
|
|
|
17
23
|
Validate project-type specific requirements are properly documented - different project types (api_backend, web_app, mobile_app, etc.) have different required and excluded sections.
|
|
@@ -11,6 +11,12 @@ advancedElicitationTask: '{project_root}/_bmad/core/workflows/advanced-elicitati
|
|
|
11
11
|
|
|
12
12
|
# Step 10: SMART Requirements Validation
|
|
13
13
|
|
|
14
|
+
<purpose>Validate Functional Requirements meet SMART quality criteria (Specific, Measurable, Attainable, Relevant, Traceable), ensuring high-quality requirements that can be implemented and tested.</purpose>
|
|
15
|
+
|
|
16
|
+
<instructions>Extract all functional requirements from PRD; evaluate each requirement against SMART criteria; assess specificity, measurability, attainability, relevance, and traceability; score each requirement on SMART completeness; identify low-scoring requirements; calculate overall quality metrics; update validation report.</instructions>
|
|
17
|
+
|
|
18
|
+
<output>SMART validation report with individual requirement scores, identified low-quality requirements, SMART criteria assessment, quality metrics, and improvement recommendations for each criterion.</output>
|
|
19
|
+
|
|
14
20
|
## STEP GOAL:
|
|
15
21
|
|
|
16
22
|
Validate Functional Requirements meet SMART quality criteria (Specific, Measurable, Attainable, Relevant, Traceable), ensuring high-quality requirements.
|
|
@@ -11,6 +11,12 @@ advancedElicitationTask: '{project_root}/_bmad/core/workflows/advanced-elicitati
|
|
|
11
11
|
|
|
12
12
|
# Step 11: Holistic Quality Assessment
|
|
13
13
|
|
|
14
|
+
<purpose>Assess the PRD as a cohesive, compelling document - evaluating document flow, dual audience effectiveness (humans and LLMs), BMAD PRD principles compliance, and overall quality rating.</purpose>
|
|
15
|
+
|
|
16
|
+
<instructions>Review PRD holistically for flow and coherence; assess readability and clarity for human audience; evaluate machine-readability and AI-assistant usefulness; evaluate alignment with BMAD principles; identify strengths and improvement opportunities; provide overall quality rating and recommendations; update validation report.</instructions>
|
|
17
|
+
|
|
18
|
+
<output>Holistic quality assessment report with document flow analysis, audience effectiveness evaluation, BMAD principles alignment, identified strengths and weaknesses, overall quality rating, and strategic improvement recommendations.</output>
|
|
19
|
+
|
|
14
20
|
## STEP GOAL:
|
|
15
21
|
|
|
16
22
|
Assess the PRD as a cohesive, compelling document - evaluating document flow, dual audience effectiveness (humans and LLMs), BMAD PRD principles compliance, and overall quality rating.
|
|
@@ -11,6 +11,12 @@ validationReportPath: '{validation_report_path}'
|
|
|
11
11
|
|
|
12
12
|
# Step 12: Completeness Validation
|
|
13
13
|
|
|
14
|
+
<purpose>Final comprehensive completeness check - validate no template variables remain, each section has required content, section-specific completeness requirements are met, and frontmatter is properly populated.</purpose>
|
|
15
|
+
|
|
16
|
+
<instructions>Scan PRD for remaining template variables and placeholders; verify all required sections have substantial content; check section-specific completeness requirements; validate frontmatter contains all required metadata; calculate completeness percentage; identify missing elements; update validation report with completeness findings.</instructions>
|
|
17
|
+
|
|
18
|
+
<output>Completeness validation report with template variable scan results, section-by-section completeness assessment, frontmatter validation, completeness percentage metric, and list of outstanding items.</output>
|
|
19
|
+
|
|
14
20
|
## STEP GOAL:
|
|
15
21
|
|
|
16
22
|
Final comprehensive completeness check - validate no template variables remain, each section has required content, section-specific completeness, and frontmatter is properly populated.
|
|
@@ -9,6 +9,12 @@ prdFile: '{prd_file_path}'
|
|
|
9
9
|
|
|
10
10
|
# Step 13: Validation Report Complete
|
|
11
11
|
|
|
12
|
+
<purpose>Finalize validation report, summarize all findings from validation steps, present summary to user conversationally, and offer actionable next steps including editing or publication.</purpose>
|
|
13
|
+
|
|
14
|
+
<instructions>Aggregate all validation step findings into comprehensive report; create executive summary with key metrics and recommendations; prepare conversational presentation for user; identify critical issues, major issues, and minor issues; recommend prioritized remediation path; offer next steps including editing workflow or publication options.</instructions>
|
|
15
|
+
|
|
16
|
+
<output>Complete validation report with executive summary, aggregated findings from all validation checks, severity classification of issues, prioritized remediation recommendations, and options for next workflow steps.</output>
|
|
17
|
+
|
|
12
18
|
## STEP GOAL:
|
|
13
19
|
|
|
14
20
|
Finalize validation report, summarize all findings from steps 1-12, present summary to user conversationally, and offer actionable next steps.
|
|
@@ -10,6 +10,24 @@ outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md'
|
|
|
10
10
|
productBriefTemplate: '../product-brief.template.md'
|
|
11
11
|
---
|
|
12
12
|
|
|
13
|
+
<purpose>
|
|
14
|
+
Initialize the product brief workflow by detecting continuation state and setting up the document structure for collaborative product discovery.
|
|
15
|
+
</purpose>
|
|
16
|
+
|
|
17
|
+
<instructions>
|
|
18
|
+
1. Check for existing workflow state by looking for the output document
|
|
19
|
+
2. If document exists with stepsCompleted, hand off to step-01b for continuation
|
|
20
|
+
3. If fresh workflow, discover input documents and create initial document from template
|
|
21
|
+
4. Update frontmatter with discovered documents
|
|
22
|
+
5. Present results to user and proceed to next step
|
|
23
|
+
</instructions>
|
|
24
|
+
|
|
25
|
+
<output>
|
|
26
|
+
- Initialized product brief document at {outputFile}
|
|
27
|
+
- Frontmatter updated with stepsCompleted: [1] and inputDocuments array
|
|
28
|
+
- User confirmation of document setup and discovered input documents
|
|
29
|
+
</output>
|
|
30
|
+
|
|
13
31
|
# Step 1: Product Brief Initialization
|
|
14
32
|
|
|
15
33
|
## STEP GOAL:
|
|
@@ -6,6 +6,25 @@ description: 'Resume the product brief workflow from where it was left off, ensu
|
|
|
6
6
|
outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md'
|
|
7
7
|
---
|
|
8
8
|
|
|
9
|
+
<purpose>
|
|
10
|
+
Resume the product brief workflow from where it was left off, ensuring smooth continuation with full context restoration.
|
|
11
|
+
</purpose>
|
|
12
|
+
|
|
13
|
+
<instructions>
|
|
14
|
+
1. Analyze current workflow state from document frontmatter
|
|
15
|
+
2. Reload all previously loaded input documents for context
|
|
16
|
+
3. Present progress report and determine next step based on lastStep value
|
|
17
|
+
4. If workflow complete, suggest next workflow options
|
|
18
|
+
5. If workflow incomplete, load appropriate next step file
|
|
19
|
+
</instructions>
|
|
20
|
+
|
|
21
|
+
<output>
|
|
22
|
+
- Current workflow state analyzed and presented to user
|
|
23
|
+
- All input documents reloaded for context continuity
|
|
24
|
+
- Next step identified and ready to load
|
|
25
|
+
- User confirmation before proceeding to next step
|
|
26
|
+
</output>
|
|
27
|
+
|
|
9
28
|
# Step 1B: Product Brief Continuation
|
|
10
29
|
|
|
11
30
|
## STEP GOAL:
|
|
@@ -11,6 +11,28 @@ advancedElicitationTask: '{project_root}/_bmad/core/workflows/advanced-elicitati
|
|
|
11
11
|
partyModeWorkflow: '{project_root}/_bmad/core/workflows/party-mode/workflow.md'
|
|
12
12
|
---
|
|
13
13
|
|
|
14
|
+
<purpose>
|
|
15
|
+
Conduct comprehensive product vision discovery to define the core problem, solution, and unique value proposition through collaborative analysis.
|
|
16
|
+
</purpose>
|
|
17
|
+
|
|
18
|
+
<instructions>
|
|
19
|
+
1. Begin vision discovery conversation exploring the core problem
|
|
20
|
+
2. Explore problem understanding from multiple angles
|
|
21
|
+
3. Analyze existing solutions and gaps
|
|
22
|
+
4. Collaborate on solution vision and differentiators
|
|
23
|
+
5. Generate Executive Summary and Core Vision content
|
|
24
|
+
6. Present A/P/C menu for optional advanced elicitation or party mode
|
|
25
|
+
7. Save content to document when user selects C
|
|
26
|
+
</instructions>
|
|
27
|
+
|
|
28
|
+
<output>
|
|
29
|
+
- Executive Summary capturing product essence
|
|
30
|
+
- Core Vision section with problem statement and solution
|
|
31
|
+
- Unique Differentiators section highlighting competitive advantage
|
|
32
|
+
- Document updated at {outputFile} with stepsCompleted: [1, 2]
|
|
33
|
+
- User ready to proceed to target user discovery
|
|
34
|
+
</output>
|
|
35
|
+
|
|
14
36
|
# Step 2: Product Vision Discovery
|
|
15
37
|
|
|
16
38
|
## STEP GOAL:
|
|
@@ -11,6 +11,28 @@ advancedElicitationTask: '{project_root}/_bmad/core/workflows/advanced-elicitati
|
|
|
11
11
|
partyModeWorkflow: '{project_root}/_bmad/core/workflows/party-mode/workflow.md'
|
|
12
12
|
---
|
|
13
13
|
|
|
14
|
+
<purpose>
|
|
15
|
+
Define target users with rich personas and map their key interactions with the product through collaborative user research and journey mapping.
|
|
16
|
+
</purpose>
|
|
17
|
+
|
|
18
|
+
<instructions>
|
|
19
|
+
1. Begin user discovery conversation identifying who experiences the problem
|
|
20
|
+
2. Develop rich personas for primary user segments
|
|
21
|
+
3. Explore secondary user segments and their roles
|
|
22
|
+
4. Map user journeys through discovery, onboarding, core usage, and success moments
|
|
23
|
+
5. Generate Target Users content with personas and journey maps
|
|
24
|
+
6. Present A/P/C menu for optional advanced elicitation or party mode
|
|
25
|
+
7. Save content to document when user selects C
|
|
26
|
+
</instructions>
|
|
27
|
+
|
|
28
|
+
<output>
|
|
29
|
+
- Target Users section with Primary and Secondary user personas
|
|
30
|
+
- User Journey section mapping key interaction points
|
|
31
|
+
- Rich persona descriptions with motivations and goals
|
|
32
|
+
- Document updated at {outputFile} with stepsCompleted: [1, 2, 3]
|
|
33
|
+
- User ready to proceed to success metrics definition
|
|
34
|
+
</output>
|
|
35
|
+
|
|
14
36
|
# Step 3: Target Users Discovery
|
|
15
37
|
|
|
16
38
|
## STEP GOAL:
|
|
@@ -11,6 +11,29 @@ advancedElicitationTask: '{project_root}/_bmad/core/workflows/advanced-elicitati
|
|
|
11
11
|
partyModeWorkflow: '{project_root}/_bmad/core/workflows/party-mode/workflow.md'
|
|
12
12
|
---
|
|
13
13
|
|
|
14
|
+
<purpose>
|
|
15
|
+
Define comprehensive success metrics that include user success, business objectives, and key performance indicators through collaborative metric definition aligned with product vision and user value.
|
|
16
|
+
</purpose>
|
|
17
|
+
|
|
18
|
+
<instructions>
|
|
19
|
+
1. Begin success metrics discovery from user perspective
|
|
20
|
+
2. Define measurable user success metrics and outcomes
|
|
21
|
+
3. Explore business objectives and success criteria
|
|
22
|
+
4. Develop specific, measurable KPIs with targets and timeframes
|
|
23
|
+
5. Ensure metrics align with product vision and drive decisions
|
|
24
|
+
6. Generate Success Metrics content with user, business, and KPI sections
|
|
25
|
+
7. Present A/P/C menu for optional advanced elicitation or party mode
|
|
26
|
+
8. Save content to document when user selects C
|
|
27
|
+
</instructions>
|
|
28
|
+
|
|
29
|
+
<output>
|
|
30
|
+
- Success Metrics section defining user success outcomes
|
|
31
|
+
- Business Objectives section with strategic goals
|
|
32
|
+
- Key Performance Indicators section with measurable targets
|
|
33
|
+
- Document updated at {outputFile} with stepsCompleted: [1, 2, 3, 4]
|
|
34
|
+
- User ready to proceed to MVP scope definition
|
|
35
|
+
</output>
|
|
36
|
+
|
|
14
37
|
# Step 4: Success Metrics Definition
|
|
15
38
|
|
|
16
39
|
## STEP GOAL:
|
|
@@ -11,6 +11,30 @@ advancedElicitationTask: '{project_root}/_bmad/core/workflows/advanced-elicitati
|
|
|
11
11
|
partyModeWorkflow: '{project_root}/_bmad/core/workflows/party-mode/workflow.md'
|
|
12
12
|
---
|
|
13
13
|
|
|
14
|
+
<purpose>
|
|
15
|
+
Define MVP scope with clear boundaries and outline future vision through collaborative scope negotiation that balances ambition with realism.
|
|
16
|
+
</purpose>
|
|
17
|
+
|
|
18
|
+
<instructions>
|
|
19
|
+
1. Begin scope definition conversation focused on MVP mindset
|
|
20
|
+
2. Define core features essential for solving the problem
|
|
21
|
+
3. Establish out-of-scope boundaries and deferred features
|
|
22
|
+
4. Define MVP success criteria and validation gates
|
|
23
|
+
5. Explore future vision and long-term capabilities
|
|
24
|
+
6. Generate MVP Scope content with core features and future vision
|
|
25
|
+
7. Present A/P/C menu for optional advanced elicitation or party mode
|
|
26
|
+
8. Save content to document when user selects C
|
|
27
|
+
</instructions>
|
|
28
|
+
|
|
29
|
+
<output>
|
|
30
|
+
- MVP Scope section with Core Features defined
|
|
31
|
+
- Out of Scope for MVP section with clear boundaries
|
|
32
|
+
- MVP Success Criteria section with validation gates
|
|
33
|
+
- Future Vision section with long-term capabilities
|
|
34
|
+
- Document updated at {outputFile} with stepsCompleted: [1, 2, 3, 4, 5]
|
|
35
|
+
- User ready to proceed to workflow completion
|
|
36
|
+
</output>
|
|
37
|
+
|
|
14
38
|
# Step 5: MVP Scope Definition
|
|
15
39
|
|
|
16
40
|
## STEP GOAL:
|
|
@@ -6,6 +6,28 @@ description: 'Complete the product brief workflow, update status files, and sugg
|
|
|
6
6
|
outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md'
|
|
7
7
|
---
|
|
8
8
|
|
|
9
|
+
<purpose>
|
|
10
|
+
Complete the product brief workflow, update status files, and provide guidance on logical next steps for continued product development.
|
|
11
|
+
</purpose>
|
|
12
|
+
|
|
13
|
+
<instructions>
|
|
14
|
+
1. Announce workflow completion and summarize accomplishments
|
|
15
|
+
2. Update main workflow status file with completion information
|
|
16
|
+
3. Validate product brief completeness and consistency
|
|
17
|
+
4. Suggest logical next workflow steps (PRD, UX design, etc.)
|
|
18
|
+
5. Present completion menu and provide next step guidance
|
|
19
|
+
6. End workflow session gracefully
|
|
20
|
+
</instructions>
|
|
21
|
+
|
|
22
|
+
<output>
|
|
23
|
+
- Completion announcement with summary of accomplishments
|
|
24
|
+
- Workflow status file updated with completion timestamp
|
|
25
|
+
- Quality validation results confirming completeness and consistency
|
|
26
|
+
- Next step recommendations provided to user
|
|
27
|
+
- Final document location: {outputFile}
|
|
28
|
+
- Workflow marked as complete
|
|
29
|
+
</output>
|
|
30
|
+
|
|
9
31
|
# Step 6: Product Brief Completion
|
|
10
32
|
|
|
11
33
|
## STEP GOAL:
|
|
@@ -1,5 +1,27 @@
|
|
|
1
1
|
# Step 1: Context Discovery & Initialization
|
|
2
2
|
|
|
3
|
+
<purpose>
|
|
4
|
+
Discover the project's technology stack, existing patterns, and critical implementation rules that AI agents must follow when writing code.
|
|
5
|
+
</purpose>
|
|
6
|
+
|
|
7
|
+
<instructions>
|
|
8
|
+
1. Check for existing project context (project-context.md)
|
|
9
|
+
2. Discover project technology stack from package files and config
|
|
10
|
+
3. Identify existing code patterns, naming conventions, and organization
|
|
11
|
+
4. Extract critical implementation rules that AI agents need
|
|
12
|
+
5. Initialize project context document with discovered information
|
|
13
|
+
6. Present discovery summary to user
|
|
14
|
+
</instructions>
|
|
15
|
+
|
|
16
|
+
<output>
|
|
17
|
+
- Existing project context detection status
|
|
18
|
+
- Identified technology stack with versions
|
|
19
|
+
- Found implementation patterns and conventions
|
|
20
|
+
- Initialized project context document
|
|
21
|
+
- Discovery summary presented to user
|
|
22
|
+
- User ready to proceed to step-02
|
|
23
|
+
</output>
|
|
24
|
+
|
|
3
25
|
## MANDATORY EXECUTION RULES (READ FIRST):
|
|
4
26
|
|
|
5
27
|
- 🛑 NEVER generate content without user input
|
|
@@ -1,5 +1,36 @@
|
|
|
1
1
|
# Step 2: Context Rules Generation
|
|
2
2
|
|
|
3
|
+
<purpose>
|
|
4
|
+
Collaboratively generate specific, critical rules that AI agents must follow when implementing code in this project, organized by technology stack, language, framework, testing, code quality, workflow, and anti-patterns.
|
|
5
|
+
</purpose>
|
|
6
|
+
|
|
7
|
+
<instructions>
|
|
8
|
+
1. Document exact technology stack and versions from discovery
|
|
9
|
+
2. Generate language-specific rules for unobvious patterns
|
|
10
|
+
3. Generate framework-specific rules for project conventions
|
|
11
|
+
4. Generate testing rules for consistency
|
|
12
|
+
5. Generate code quality and style rules
|
|
13
|
+
6. Generate development workflow rules
|
|
14
|
+
7. Identify critical don't-miss rules and anti-patterns
|
|
15
|
+
8. Present A/P/C menu after each category for user validation
|
|
16
|
+
9. Append validated rules to project context file
|
|
17
|
+
10. Update frontmatter with completed sections
|
|
18
|
+
</instructions>
|
|
19
|
+
|
|
20
|
+
<output>
|
|
21
|
+
- Technology stack and versions documented
|
|
22
|
+
- Language-specific rules for each category
|
|
23
|
+
- Framework-specific rules for project patterns
|
|
24
|
+
- Testing rules for consistency
|
|
25
|
+
- Code quality and style rules
|
|
26
|
+
- Development workflow rules
|
|
27
|
+
- Critical anti-pattern rules documented
|
|
28
|
+
- A/P/C menu selections processed
|
|
29
|
+
- Rules appended to project context file
|
|
30
|
+
- Frontmatter updated with sections_completed
|
|
31
|
+
- Ready to proceed to step-03
|
|
32
|
+
</output>
|
|
33
|
+
|
|
3
34
|
## MANDATORY EXECUTION RULES (READ FIRST):
|
|
4
35
|
|
|
5
36
|
- 🛑 NEVER generate content without user input
|
|
@@ -1,5 +1,33 @@
|
|
|
1
1
|
# Step 3: Context Completion & Finalization
|
|
2
2
|
|
|
3
|
+
<purpose>
|
|
4
|
+
Complete the project context file, optimize it for LLM efficiency, validate all critical rules are captured and actionable, and provide guidance for usage and maintenance.
|
|
5
|
+
</purpose>
|
|
6
|
+
|
|
7
|
+
<instructions>
|
|
8
|
+
1. Review complete context file for content and structure analysis
|
|
9
|
+
2. Optimize content for LLM context efficiency
|
|
10
|
+
3. Remove redundant or obvious information
|
|
11
|
+
4. Ensure final structure follows optimized format
|
|
12
|
+
5. Present completion summary to user based on skill level
|
|
13
|
+
6. Update frontmatter with completion status
|
|
14
|
+
7. Add usage guidelines section for agents and humans
|
|
15
|
+
8. Validate all critical rules are complete
|
|
16
|
+
9. Provide clear next steps for agent integration and maintenance
|
|
17
|
+
</instructions>
|
|
18
|
+
|
|
19
|
+
<output>
|
|
20
|
+
- Complete context file reviewed and optimized
|
|
21
|
+
- Content optimized for LLM efficiency
|
|
22
|
+
- Final structure validated
|
|
23
|
+
- Completion summary presented to user
|
|
24
|
+
- Frontmatter updated with status: 'complete'
|
|
25
|
+
- Usage guidelines section appended
|
|
26
|
+
- Validation checklist completed
|
|
27
|
+
- File ready for AI agent consumption
|
|
28
|
+
- Next steps provided for maintenance and evolution
|
|
29
|
+
</output>
|
|
30
|
+
|
|
3
31
|
## MANDATORY EXECUTION RULES (READ FIRST):
|
|
4
32
|
|
|
5
33
|
- 🛑 NEVER generate content without user input
|
|
@@ -8,6 +8,27 @@ nextStepFile_modeA: './step-03-execute.md'
|
|
|
8
8
|
nextStepFile_modeB: './step-02-context-gathering.md'
|
|
9
9
|
---
|
|
10
10
|
|
|
11
|
+
<purpose>
|
|
12
|
+
Determine whether the user has provided a tech-spec file (Mode A) or direct task instructions (Mode B). Capture baseline commit, load project context if available, and evaluate escalation threshold to decide whether the request fits in Quick Dev or needs broader planning workflows.
|
|
13
|
+
</purpose>
|
|
14
|
+
|
|
15
|
+
<instructions>
|
|
16
|
+
1. Capture the baseline commit hash (or "NO_GIT" if not a git repo)
|
|
17
|
+
2. Load project context if exists in the codebase
|
|
18
|
+
3. Parse user input to determine Mode A (tech-spec path provided) or Mode B (direct task description)
|
|
19
|
+
4. For Mode B, evaluate escalation signals and present appropriate choices
|
|
20
|
+
5. Set state variables for all subsequent steps
|
|
21
|
+
6. Provide explicit NEXT directive indicating which step to load or workflow to exit to
|
|
22
|
+
</instructions>
|
|
23
|
+
|
|
24
|
+
<output>
|
|
25
|
+
- `{baseline_commit}` - Git HEAD at workflow start (or "NO_GIT")
|
|
26
|
+
- `{execution_mode}` - Either "tech-spec" or "direct"
|
|
27
|
+
- `{tech_spec_path}` - Path to tech-spec file (only if Mode A)
|
|
28
|
+
- `{project_context}` - Loaded project context if available
|
|
29
|
+
- Explicit NEXT directive showing the next step to load or workflow to exit to
|
|
30
|
+
</output>
|
|
31
|
+
|
|
11
32
|
# Step 1: Mode Detection
|
|
12
33
|
|
|
13
34
|
**Goal:** Determine execution mode, capture baseline, handle escalation if needed.
|
|
@@ -7,6 +7,29 @@ thisStepFile: './step-02-context-gathering.md'
|
|
|
7
7
|
nextStepFile: './step-03-execute.md'
|
|
8
8
|
---
|
|
9
9
|
|
|
10
|
+
<purpose>
|
|
11
|
+
Gather sufficient context for Mode B (direct instructions) to create a realistic mental plan of tasks. Identify affected files, detect existing code patterns, note dependencies, and create preliminary acceptance criteria based on the user's request.
|
|
12
|
+
</purpose>
|
|
13
|
+
|
|
14
|
+
<instructions>
|
|
15
|
+
1. Search codebase to identify files relevant to the user's task description
|
|
16
|
+
2. Examine those files to discover existing patterns, conventions, and error handling approaches
|
|
17
|
+
3. Identify dependencies (libraries, modules, configs) that may be affected
|
|
18
|
+
4. Synthesize gathered information into a mental plan with ordered tasks and inferred acceptance criteria
|
|
19
|
+
5. Present the plan to the user for confirmation before proceeding to execution
|
|
20
|
+
6. Accept user feedback (y/n/adjust) and continue or refine the plan accordingly
|
|
21
|
+
</instructions>
|
|
22
|
+
|
|
23
|
+
<output>
|
|
24
|
+
- List of files to modify (with their purposes)
|
|
25
|
+
- Key patterns identified in the codebase
|
|
26
|
+
- Dependencies and related files that might be affected
|
|
27
|
+
- Mental plan with ordered tasks
|
|
28
|
+
- Inferred acceptance criteria from the user request
|
|
29
|
+
- User confirmation to proceed (y/n/adjust)
|
|
30
|
+
- Explicit NEXT directive to step-03-execute.md once confirmed
|
|
31
|
+
</output>
|
|
32
|
+
|
|
10
33
|
# Step 2: Context Gathering (Direct Mode)
|
|
11
34
|
|
|
12
35
|
**Goal:** Quickly gather context for direct instructions - files, patterns, dependencies.
|
|
@@ -7,6 +7,31 @@ thisStepFile: './step-03-execute.md'
|
|
|
7
7
|
nextStepFile: './step-04-self-check.md'
|
|
8
8
|
---
|
|
9
9
|
|
|
10
|
+
<purpose>
|
|
11
|
+
Execute all planned tasks in sequence without pausing for approval between tasks. Write code following identified patterns, run tests to verify functionality, and only halt for blocking issues that require user guidance.
|
|
12
|
+
</purpose>
|
|
13
|
+
|
|
14
|
+
<instructions>
|
|
15
|
+
1. For each task in the plan (from tech-spec or mental plan):
|
|
16
|
+
- Load relevant source files to understand context
|
|
17
|
+
- Implement changes following existing code patterns
|
|
18
|
+
- Write or update tests to verify the specific acceptance criteria for this task
|
|
19
|
+
- Mark task complete and move to the next task immediately
|
|
20
|
+
2. Handle errors pragmatically: retry, look for patterns, test incrementally
|
|
21
|
+
3. Only halt and request guidance if facing a blocking issue (3+ failures, ambiguous decision)
|
|
22
|
+
4. Track all completed work for the next step (self-check)
|
|
23
|
+
5. Once all tasks are complete (or blocked), proceed to step-04-self-check.md
|
|
24
|
+
</instructions>
|
|
25
|
+
|
|
26
|
+
<output>
|
|
27
|
+
- Implemented code changes for all tasks
|
|
28
|
+
- Tests written and passing for new/modified functionality
|
|
29
|
+
- All existing tests still passing
|
|
30
|
+
- List of completed tasks checked off
|
|
31
|
+
- Any blocking issues documented with clear explanation
|
|
32
|
+
- Ready to transition to self-check phase
|
|
33
|
+
</output>
|
|
34
|
+
|
|
10
35
|
# Step 3: Execute Implementation
|
|
11
36
|
|
|
12
37
|
**Goal:** Implement all tasks, write tests, follow patterns, handle errors.
|
|
@@ -7,6 +7,28 @@ thisStepFile: './step-04-self-check.md'
|
|
|
7
7
|
nextStepFile: './step-05-adversarial-review.md'
|
|
8
8
|
---
|
|
9
9
|
|
|
10
|
+
<purpose>
|
|
11
|
+
Perform a comprehensive self-audit of the implementation before external review. Verify that all tasks are complete, tests pass, acceptance criteria are satisfied, and code follows project patterns. Update tech-spec status if in Mode A. Provide a clear summary for the adversarial review phase.
|
|
12
|
+
</purpose>
|
|
13
|
+
|
|
14
|
+
<instructions>
|
|
15
|
+
1. Verify all tasks marked complete with no skipped work
|
|
16
|
+
2. Run full test suite and confirm all tests passing
|
|
17
|
+
3. For each acceptance criterion, verify it is demonstrably satisfied
|
|
18
|
+
4. Review all modified code to ensure it follows existing patterns and project-context rules
|
|
19
|
+
5. If Mode A (tech-spec): load tech-spec file, mark all tasks as [x], update status to "Implementation Complete", save
|
|
20
|
+
6. Present implementation summary to transition to review phase
|
|
21
|
+
7. Load step-05-adversarial-review.md to proceed
|
|
22
|
+
</instructions>
|
|
23
|
+
|
|
24
|
+
<output>
|
|
25
|
+
- Verification checklist: Tasks ✓, Tests ✓, AC ✓, Patterns ✓
|
|
26
|
+
- Test suite run results (all passing)
|
|
27
|
+
- Tech-spec updated with completion status (Mode A only)
|
|
28
|
+
- Implementation summary showing what was built, files modified, and test status
|
|
29
|
+
- Transition message to adversarial review phase
|
|
30
|
+
</output>
|
|
31
|
+
|
|
10
32
|
# Step 4: Self-Check
|
|
11
33
|
|
|
12
34
|
**Goal:** Audit completed work against tasks, tests, AC, and patterns before external review.
|