bmad初始化

2025-11-01 19:22:39 +08:00
parent 5b21dc0bd5
commit 426ae41f54
447 changed files with 80633 additions and 0 deletions
--- a/bmad/bmm/workflows/4-implementation/story-context/README.md
+++ b/bmad/bmm/workflows/4-implementation/story-context/README.md
@@ -0,0 +1,234 @@
+# Story Context Assembly Workflow
+
+## Overview
+
+Assembles a dynamic Story Context XML by pulling latest documentation and existing code/library artifacts relevant to a drafted story. Creates comprehensive development context for AI agents and developers working on specific stories.
+
+## Key Features
+
+- **Automated Context Discovery** - Scans documentation and codebase for relevant artifacts
+- **XML Output Format** - Structured context optimized for LLM consumption
+- **Dependency Detection** - Identifies frameworks, packages, and technical dependencies
+- **Interface Mapping** - Locates existing APIs and interfaces to reuse
+- **Testing Integration** - Includes testing standards and generates test ideas
+- **Status Tracking** - Updates story status and maintains context references
+
+## Usage
+
+### Basic Invocation
+
+```bash
+workflow story-context
+```
+
+### With Specific Story
+
+```bash
+# Process specific story file
+workflow story-context --input /path/to/story.md
+
+# Using story path variable
+workflow story-context --story_path "docs/stories/1.2.feature-name.md"
+```
+
+### Configuration
+
+- **story_path**: Path to target story markdown file (defaults to latest.md)
+- **auto_update_status**: Whether to automatically update story status (default: false)
+
+## Workflow Structure
+
+### Files Included
+
+```
+story-context/
+├── workflow.yaml           # Configuration and metadata
+├── instructions.md         # Step-by-step execution guide
+├── context-template.xml    # XML structure template
+├── checklist.md           # Validation criteria
+└── README.md              # This file
+```
+
+## Workflow Process
+
+### Phase 1: Story Analysis (Steps 1-2)
+
+- **Story Location**: Finds and loads target story markdown file
+- **Content Parsing**: Extracts epic ID, story ID, title, acceptance criteria, and tasks
+- **Template Initialization**: Creates initial XML context structure
+- **User Story Extraction**: Parses "As a... I want... So that..." components
+
+### Phase 2: Documentation Discovery (Step 3)
+
+- **Keyword Analysis**: Identifies relevant terms from story content
+- **Document Scanning**: Searches docs and module documentation
+- **Authority Prioritization**: Prefers PRDs, architecture docs, and specs
+- **Context Extraction**: Captures relevant sections with snippets
+
+### Phase 3: Code Analysis (Step 4)
+
+- **Symbol Search**: Finds relevant modules, functions, and components
+- **Interface Identification**: Locates existing APIs and interfaces
+- **Constraint Extraction**: Identifies development patterns and requirements
+- **Reuse Opportunities**: Highlights existing code to leverage
+
+### Phase 4: Dependency Analysis (Step 5)
+
+- **Manifest Detection**: Scans for package.json, requirements.txt, go.mod, etc.
+- **Framework Identification**: Identifies Unity, Node.js, Python, Go ecosystems
+- **Version Tracking**: Captures dependency versions where available
+- **Configuration Discovery**: Finds relevant project configurations
+
+### Phase 5: Testing Context (Step 6)
+
+- **Standards Extraction**: Identifies testing frameworks and patterns
+- **Location Mapping**: Documents where tests should be placed
+- **Test Ideas**: Generates initial test concepts for acceptance criteria
+- **Framework Integration**: Links to existing test infrastructure
+
+### Phase 6: Validation and Updates (Steps 7-8)
+
+- **XML Validation**: Ensures proper structure and completeness
+- **Status Updates**: Changes story status from Draft to ContextReadyDraft
+- **Reference Tracking**: Adds context file reference to story document
+- **Quality Assurance**: Validates against workflow checklist
+
+## Output
+
+### Generated Files
+
+- **Primary output**: story-context-{epic_id}.{story_id}-{date}.xml
+- **Story updates**: Modified original story file with context references
+
+### Output Structure
+
+```xml
+<storyContext>
+  <story>
+    <basicInfo>
+      <epicId>...</epicId>
+      <storyId>...</storyId>
+      <title>...</title>
+      <status>...</status>
+    </basicInfo>
+    <userStory>
+      <asA>...</asA>
+      <iWant>...</iWant>
+      <soThat>...</soThat>
+    </userStory>
+    <acceptanceCriteria>
+      <criterion id="1">...</criterion>
+    </acceptanceCriteria>
+    <tasks>
+      <task>...</task>
+    </tasks>
+  </story>
+
+  <artifacts>
+    <docs>
+      <doc path="..." title="..." section="..." snippet="..."/>
+    </docs>
+    <code>
+      <file path="..." kind="..." symbol="..." lines="..." reason="..."/>
+    </code>
+    <dependencies>
+      <node>
+        <package name="..." version="..."/>
+      </node>
+    </dependencies>
+  </artifacts>
+
+  <interfaces>
+    <interface name="..." kind="..." signature="..." path="..."/>
+  </interfaces>
+
+  <constraints>
+    <constraint>...</constraint>
+  </constraints>
+
+  <tests>
+    <standards>...</standards>
+    <locations>
+      <location>...</location>
+    </locations>
+    <ideas>
+      <idea ac="1">...</idea>
+    </ideas>
+  </tests>
+</storyContext>
+```
+
+## Requirements
+
+- **Story File**: Valid story markdown with proper structure (epic.story.title.md format)
+- **Repository Access**: Ability to scan documentation and source code
+- **Documentation**: Project documentation in standard locations (docs/, src/, etc.)
+
+## Best Practices
+
+### Before Starting
+
+1. **Ensure Story Quality**: Verify story has clear acceptance criteria and tasks
+2. **Update Documentation**: Ensure relevant docs are current and discoverable
+3. **Clean Repository**: Remove obsolete code that might confuse context assembly
+
+### During Execution
+
+1. **Review Extracted Context**: Verify that discovered artifacts are actually relevant
+2. **Check Interface Accuracy**: Ensure identified APIs and interfaces are current
+3. **Validate Dependencies**: Confirm dependency information matches project state
+
+### After Completion
+
+1. **Review XML Output**: Validate the generated context makes sense
+2. **Test with Developer**: Have a developer review context usefulness
+3. **Update Story Status**: Verify story status was properly updated
+
+## Troubleshooting
+
+### Common Issues
+
+**Issue**: Context contains irrelevant or outdated information
+
+- **Solution**: Review keyword extraction and document filtering logic
+- **Check**: Ensure story title and acceptance criteria are specific and clear
+
+**Issue**: Missing relevant code or interfaces
+
+- **Solution**: Verify code search patterns and symbol extraction
+- **Check**: Ensure relevant code follows project naming conventions
+
+**Issue**: Dependency information is incomplete or wrong
+
+- **Solution**: Check for multiple package manifests or unusual project structure
+- **Check**: Verify dependency files are in expected locations and formats
+
+## Customization
+
+To customize this workflow:
+
+1. **Modify Search Patterns**: Update instructions.md to adjust code and doc discovery
+2. **Extend XML Schema**: Customize context-template.xml for additional context types
+3. **Add Validation**: Extend checklist.md with project-specific quality criteria
+4. **Configure Dependencies**: Adjust dependency detection for specific tech stacks
+
+## Version History
+
+- **v6.0.0** - XML-based context assembly with comprehensive artifact discovery
+  - Multi-ecosystem dependency detection
+  - Interface and constraint extraction
+  - Testing context integration
+  - Story status management
+
+## Support
+
+For issues or questions:
+
+- Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
+- Validate output using `checklist.md`
+- Ensure story files follow expected markdown structure
+- Check that repository structure supports automated discovery
+
+---
+
+_Part of the BMad Method v6 - BMM (Method) Module_