2.9 KiB
create-story Workflow Rule
This rule defines the create-story workflow.
Workflow Description
Create the next user story markdown from epics/PRD and architecture, using a standard template and saving to the stories folder
Workflow Definition
name: create-story description: "Create the next user story markdown from epics/PRD and architecture, using a standard template and saving to the stories folder" author: "BMad"
Critical variables from config
config_source: "{project-root}/.bmad/bmm/config.yaml" output_folder: "{config_source}:output_folder" user_name: "{config_source}:user_name" communication_language: "{config_source}:communication_language" date: system-generated story_dir: "{config_source}:dev_ephemeral_location/stories"
Workflow components
installed_path: "{project-root}/.bmad/bmm/workflows/4-implementation/create-story" template: "{installed_path}/template.md" instructions: "{installed_path}/instructions.md" validation: "{installed_path}/checklist.md"
Variables and inputs
variables: sprint_status: "{config_source}:dev_ephemeral_location/sprint-status.yaml || {output_folder}/sprint-status.yaml" # Primary source for story tracking epics_file: "{output_folder}/epics.md" # Preferred source for epic/story breakdown prd_file: "{output_folder}/PRD.md" # Fallback for requirements architecture_file: "{output_folder}/architecture.md" # Optional architecture context tech_spec_file: "" # Will be auto-discovered from docs as tech-spec-epic-{{epic_num}}-.md tech_spec_search_dir: "{project-root}/docs" tech_spec_glob_template: "tech-spec-epic-{{epic_num}}.md" arch_docs_search_dirs: | - "{project-root}/docs" - "{output_folder}" arch_docs_file_names: | - architecture.md story_title: "" # Will be elicited if not derivable
Output configuration
Uses story_key from sprint-status.yaml (e.g., "1-2-user-authentication")
default_output_file: "{story_dir}/{{story_key}}.md"
Smart input file references - handles both whole docs and sharded docs
Priority: Whole document first, then sharded version
Strategy: SELECTIVE LOAD - only load the specific epic needed for this story
input_file_patterns: prd: whole: "{output_folder}/prd.md" sharded: "{output_folder}/prd/index.md" tech_spec: whole: "{output_folder}/tech-spec.md" architecture: whole: "{output_folder}/architecture.md" sharded: "{output_folder}/architecture/index.md" ux_design: whole: "{output_folder}/ux.md" sharded: "{output_folder}/ux/index.md" epics: whole: "{output_folder}/epic.md" sharded_index: "{output_folder}/epic/index.md" sharded_single: "{output_folder}/epic/epic-{{epic_num}}.md" document_project: sharded: "{output_folder}/index.md"
standalone: true
Usage
Reference this workflow with @workflow-create-story to execute the guided workflow.
Module
Part of the BMAD BMM module.