Files
BMAD-METHOD/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions.md
2025-10-16 08:26:26 -05:00

7.8 KiB

PRD Workflow - Small Projects (Level 0-1)

The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.xml You MUST have already loaded and processed: {installed_path}/workflow.yaml Communicate all responses in {communication_language} This is the SMALL instruction set for Level 0-1 projects - tech-spec with story generation Level 0: tech-spec + single user story | Level 1: tech-spec + epic/stories Project analysis already completed - proceeding directly to technical specification NO PRD generated - uses tech_spec_template + story templates

Check if bmm-workflow-status.md exists in {output_folder}/

**⚠️ No Workflow Status File Found**

The tech-spec workflow requires an existing workflow status file to understand your project context.

Please run workflow-status first to:

  • Map out your complete workflow journey
  • Determine project type and level
  • Create the status file with your planned workflow

To proceed:

Run: bmad analyst workflow-status

After completing workflow planning, you'll be directed back to this workflow. Exit workflow - cannot proceed without status file

Load status file and proceed to Step 1

Load bmm-workflow-status.md from {output_folder}/bmm-workflow-status.md Verify project_level is 0 or 1

This workflow is for Level 0-1 only. Level 2-4 should use PRD workflow. **Incorrect Workflow for Your Level**

Your status file indicates Level {{project_level}}.

Correct workflow: prd (run with PM agent)

Run: bmad pm prd Exit and redirect user to prd workflow

This workflow is for software projects. Game projects should use GDD workflow. **Incorrect Workflow for Game Projects**

Correct workflow: gdd (run with PM agent)

Run: bmad pm gdd Exit and redirect user to gdd workflow

Update Workflow Status Tracker: Set current_workflow = "tech-spec (Level 0 - generating tech spec)" Set current_workflow = "tech-spec (Level 1 - generating tech spec)" Set progress_percentage = 20% Save bmm-workflow-status.md

Confirm Level 0 - Single atomic change Please describe the specific change/fix you need to implement: Confirm Level 1 - Coherent feature Please describe the feature you need to implement:

Generate tech-spec.md - this is the TECHNICAL SOURCE OF TRUTH ALL TECHNICAL DECISIONS MUST BE DEFINITIVE - NO AMBIGUITY ALLOWED

Update progress in bmm-workflow-status.md: Set progress_percentage = 40% Save bmm-workflow-status.md

Initialize and write out tech-spec.md using tech_spec_template

DEFINITIVE DECISIONS REQUIRED:

BAD Examples (NEVER DO THIS):

  • "Python 2 or 3"
  • "Use a logger like pino or winston"

GOOD Examples (ALWAYS DO THIS):

  • "Python 3.11"
  • "winston v3.8.2 for logging"

Source Tree Structure: EXACT file changes needed source_tree

Technical Approach: SPECIFIC implementation for the change technical_approach

Implementation Stack: DEFINITIVE tools and versions implementation_stack

Technical Details: PRECISE change details technical_details

Testing Approach: How to verify the change testing_approach

Deployment Strategy: How to deploy the change deployment_strategy

{project-root}/bmad/core/tasks/adv-elicit.xml

Offer to run cohesion validation

Tech-spec complete! Before proceeding to implementation, would you like to validate project cohesion?

Cohesion Validation checks:

  • Tech spec completeness and definitiveness
  • Feature sequencing and dependencies
  • External dependencies properly planned
  • User/agent responsibilities clear
  • Greenfield/brownfield-specific considerations

Run cohesion validation? (y/n)

Load {installed_path}/checklist.md Review tech-spec.md against "Cohesion Validation (All Levels)" section Focus on Section A (Tech Spec), Section D (Feature Sequencing) Apply Section B (Greenfield) or Section C (Brownfield) based on field_type Generate validation report with findings

Load bmm-workflow-status.md to determine project_level

Invoke instructions-level0-story.md to generate single user story Story will be saved to user-story.md Story links to tech-spec.md for technical implementation details Invoke instructions-level1-stories.md to generate epic and stories Epic and stories will be saved to epics.md Stories link to tech-spec.md implementation tasks

Confirm tech-spec is complete and definitive

Confirm user-story.md generated successfully Confirm epics.md generated successfully

Summary

- **Level 0 Output**: tech-spec.md + user-story.md - **No PRD required** - **Direct to implementation with story tracking** - **Level 1 Output**: tech-spec.md + epics.md - **No PRD required** - **Ready for sprint planning with epic/story breakdown**

Next Steps Checklist

Determine appropriate next steps for Level 0 atomic change

Optional Next Steps:

- [ ] **Create simple UX documentation** (if UI change is user-facing) - Note: Full instructions-ux workflow may be overkill for Level 0 - Consider documenting just the specific UI change
  • Generate implementation task
    • Command: workflow task-generation
    • Uses: tech-spec.md

Recommended Next Steps:

  • Create test plan for the change

    • Unit tests for the specific change
    • Integration test if affects other components
  • Generate implementation task

    • Command: workflow task-generation
    • Uses: tech-spec.md

Tech-Spec Complete, {user_name}!

Next action:

  1. Proceed to implementation
  2. Generate development task
  3. Create test plan
  4. Exit workflow

Select option (1-4):