ldy26098
/
BMAD-METHOD
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git
1
0
Fork 0
Code Packages Projects Releases Wiki Activity

docs: improve formatting and clarity in README.md for task definitions

This commit is contained in:
MJ 2025-10-13 10:34:05 +08:00
parent fc6d3f6aff
commit e2c1c7327b
1 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/modules/bmm/tasks/README.md
View File

@ -11,6 +11,7 @@ Reusable task definitions that agents can execute. Tasks are atomic units of wor
**Purpose:** View comprehensive real-time development progress across planning and implementation phases. **Purpose:** View comprehensive real-time development progress across planning and implementation phases.
**Usage:** **Usage:**
```bash ```bash
/sm /sm
*development-status *development-status
@ -24,6 +25,7 @@ Reusable task definitions that agents can execute. Tasks are atomic units of wor
``` ```
**What it shows:** **What it shows:**
- Planning phase status (PRD, Architecture, Epics existence) - Planning phase status (PRD, Architecture, Epics existence)
- Story breakdown by status (Draft/In Progress/Done/etc) - Story breakdown by status (Draft/In Progress/Done/etc)
- Task completion metrics - Task completion metrics
@ -32,6 +34,7 @@ Reusable task definitions that agents can execute. Tasks are atomic units of wor
- Context-aware recommendations for next steps - Context-aware recommendations for next steps
**When to use:** **When to use:**
- Daily standup preparation - Daily standup preparation
- Sprint planning - Sprint planning
- Progress reporting to stakeholders - Progress reporting to stakeholders
@ -47,12 +50,14 @@ Reusable task definitions that agents can execute. Tasks are atomic units of wor
**Purpose:** Run structured daily standup meetings with context from current stories. **Purpose:** Run structured daily standup meetings with context from current stories.
**What it does:** **What it does:**
- Discovers current story status - Discovers current story status
- Gathers team context - Gathers team context
- Facilitates structured standup discussion - Facilitates structured standup discussion
- Creates actionable summary - Creates actionable summary
**When to use:** **When to use:**
- Start of each working day - Start of each working day
- Sprint checkpoint meetings - Sprint checkpoint meetings
@ -63,6 +68,7 @@ Reusable task definitions that agents can execute. Tasks are atomic units of wor
**Purpose:** Facilitate team retrospective after completing an epic. **Purpose:** Facilitate team retrospective after completing an epic.
**What it does:** **What it does:**
- Reviews completed epic metrics - Reviews completed epic metrics
- Gathers team feedback (What went well, What to improve) - Gathers team feedback (What went well, What to improve)
- Identifies lessons learned - Identifies lessons learned
@ -70,6 +76,7 @@ Reusable task definitions that agents can execute. Tasks are atomic units of wor
- Creates action items - Creates action items
**When to use:** **When to use:**
- After completing all stories in an epic - After completing all stories in an epic
- Before starting next epic - Before starting next epic
- Sprint/milestone completion - Sprint/milestone completion
@ -106,16 +113,17 @@ Tasks follow a structured XML format with these key sections:
## How Tasks Differ from Workflows ## How Tasks Differ from Workflows
| Aspect | Tasks | Workflows | | Aspect | Tasks | Workflows |
|--------|-------|-----------| | ------------- | -------------------------- | ---------------------------------- |
| **Format** | XML | YAML + Markdown | | **Format** | XML | YAML + Markdown |
| **Scope** | Single focused operation | Multi-step process | | **Scope** | Single focused operation | Multi-step process |
| **Structure** | Linear flow of steps | Complex branching logic | | **Structure** | Linear flow of steps | Complex branching logic |
| **Duration** | Quick (seconds to minutes) | Extended (minutes to hours) | | **Duration** | Quick (seconds to minutes) | Extended (minutes to hours) |
| **State** | Stateless, read-only | May modify project files | | **State** | Stateless, read-only | May modify project files |
| **Use Case** | Status checks, reports | Creating artifacts, implementation | | **Use Case** | Status checks, reports | Creating artifacts, implementation |
**Examples:** **Examples:**
- **Task:** View development status (read-only, quick) - **Task:** View development status (read-only, quick)
- **Workflow:** Create story (generates files, multi-step) - **Workflow:** Create story (generates files, multi-step)
@ -126,7 +134,7 @@ Tasks are integrated into agent menus using the `exec` attribute:
```yaml ```yaml
menu: menu:
- trigger: development-status - trigger: development-status
exec: "{project-root}/bmad/bmm/tasks/development-status.xml" exec: '{project-root}/bmad/bmm/tasks/development-status.xml'
description: View current development progress description: View current development progress
``` ```