bmad-plus 0.5.0 → 0.7.0
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/CHANGELOG.md +43 -0
- package/README.md +144 -142
- package/package.json +1 -1
- package/readme-international/README.de.md +125 -125
- package/readme-international/README.es.md +215 -215
- package/readme-international/README.fr.md +213 -213
- package/src/bmad-plus/module.yaml +46 -0
- package/src/bmad-plus/packs/pack-dev-studio/README.md +162 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/analyst-agent.md +74 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/document-project.md +62 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/domain-research.md +96 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/market-research.md +96 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/prfaq.md +135 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/product-brief.md +81 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/tech-writer-agent.md +74 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/technical-research.md +96 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/architect-agent.md +74 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/create-architecture.md +74 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/create-epics-stories.md +93 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/generate-project-context.md +81 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/implementation-readiness.md +91 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-01-init.md +153 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-01b-continue.md +173 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-02-context.md +224 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-03-starter.md +329 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-04-decisions.md +318 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-05-patterns.md +359 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-06-structure.md +379 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-07-validation.md +361 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-08-complete.md +82 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/checkpoint-preview.md +68 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review-steps/step-01-gather-context.md +85 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review-steps/step-02-review.md +35 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review-steps/step-03-triage.md +49 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review-steps/step-04-present.md +132 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review.md +90 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/correct-course.md +301 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/create-story.md +429 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/dev-agent.md +74 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/dev-story-checklist.md +80 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/dev-story.md +485 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/investigate.md +194 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/qa-e2e-tests.md +176 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/quick-dev.md +111 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/retrospective.md +1512 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/sprint-planning.md +299 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/sprint-status.md +297 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/create-prd.md +30 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/create-ux-design.md +75 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/edit-prd.md +30 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/pm-agent.md +74 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/prd.md +90 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/ux-designer-agent.md +74 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/validate-prd.md +30 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/advanced-elicitation.md +142 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/adversarial-review.md +37 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/bmad-help.md +75 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/brainstorming.md +6 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/customize.md +111 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/distillator.md +177 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/edge-case-hunter.md +67 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/editorial-review-prose.md +86 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/editorial-review-structure.md +179 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/index-docs.md +66 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/party-mode.md +128 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/shard-doc.md +105 -0
- package/src/bmad-plus/packs/pack-dev-studio/dev-studio-orchestrator.md +120 -0
- package/src/bmad-plus/packs/pack-dev-studio/shared/architecture-decision-template.md +12 -0
- package/src/bmad-plus/packs/pack-dev-studio/shared/bwml-spec.md +328 -0
- package/src/bmad-plus/packs/pack-dev-studio/shared/module-help.csv +32 -0
- package/src/bmad-plus/packs/pack-dev-studio/upstream-sync.yaml +81 -0
- package/src/bmad-plus/packs/pack-memory/README.md +106 -0
- package/src/bmad-plus/packs/pack-memory/memory-orchestrator.md +79 -0
- package/src/bmad-plus/packs/pack-memory/shared/karpathy-guardrails.md +86 -0
- package/src/bmad-plus/packs/pack-memory/shared/memory-protocol.md +143 -0
- package/src/bmad-plus/packs/pack-memory/templates/context.md +39 -0
- package/src/bmad-plus/packs/pack-memory/templates/decisions.md +25 -0
- package/src/bmad-plus/packs/pack-memory/templates/identity.yaml +39 -0
- package/src/bmad-plus/packs/pack-memory/templates/lessons.md +31 -0
- package/src/bmad-plus/packs/pack-memory/templates/patterns.md +24 -0
- package/src/bmad-plus/packs/pack-memory/templates/session-handoff.md +25 -0
- package/src/bmad-plus/packs/pack-memory/zecher-agent.md +157 -0
- package/tools/cli/commands/install.js +145 -1
- package/tools/cli/i18n.js +10 -10
package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/generate-project-context.md
ADDED
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: bmad-generate-project-context
|
|
3
|
+
description: 'Create project-context.md with AI rules. Use when the user says "generate project context" or "create project context"'
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Generate Project Context Workflow
|
|
7
|
+
|
|
8
|
+
**Goal:** Create a concise, optimized `project-context.md` file containing critical rules, patterns, and guidelines that AI agents must follow when implementing code. This file focuses on unobvious details that LLMs need to be reminded of.
|
|
9
|
+
|
|
10
|
+
**Your Role:** You are a technical facilitator working with a peer to capture the essential implementation rules that will ensure consistent, high-quality code generation across all AI agents working on the project.
|
|
11
|
+
|
|
12
|
+
## Conventions
|
|
13
|
+
|
|
14
|
+
- Bare paths (e.g. `steps/step-01-discover.md`) resolve from the skill root.
|
|
15
|
+
- `this skill directory` resolves to this skill's installed directory (where `agent configuration` lives).
|
|
16
|
+
- `{project-root}`-prefixed paths resolve from the project working directory.
|
|
17
|
+
- `{skill-name}` resolves to the skill directory's basename.
|
|
18
|
+
|
|
19
|
+
## WORKFLOW ARCHITECTURE
|
|
20
|
+
|
|
21
|
+
This uses **micro-file architecture** for disciplined execution:
|
|
22
|
+
|
|
23
|
+
- Each step is a self-contained file with embedded rules
|
|
24
|
+
- Sequential progression with user control at each step
|
|
25
|
+
- Document state tracked in frontmatter
|
|
26
|
+
- Focus on lean, LLM-optimized content generation
|
|
27
|
+
- You NEVER proceed to a step file if the current step file indicates the user must approve and indicate continuation.
|
|
28
|
+
|
|
29
|
+
## On Activation
|
|
30
|
+
|
|
31
|
+
### Step 1: Resolve the Workflow Block
|
|
32
|
+
|
|
33
|
+
<!-- Adapted for BMAD+: original script dependency removed -->
|
|
34
|
+
|
|
35
|
+
**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver:
|
|
36
|
+
|
|
37
|
+
1. `this skill file` — defaults
|
|
38
|
+
2. `{project-root}/custom/{skill-name}.toml` — team overrides
|
|
39
|
+
3. `{project-root}/custom/{skill-name}.user.toml` — personal overrides
|
|
40
|
+
|
|
41
|
+
Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append.
|
|
42
|
+
|
|
43
|
+
### Step 2: Execute Prepend Steps
|
|
44
|
+
|
|
45
|
+
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
|
46
|
+
|
|
47
|
+
### Step 3: Load Persistent Facts
|
|
48
|
+
|
|
49
|
+
Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim.
|
|
50
|
+
|
|
51
|
+
### Step 4: Load Config
|
|
52
|
+
|
|
53
|
+
Load config from `{project-root}/project config` and resolve:
|
|
54
|
+
- Use `{user_name}` for greeting
|
|
55
|
+
- Use `{communication_language}` for all communications
|
|
56
|
+
- Use `{document_output_language}` for output documents
|
|
57
|
+
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
58
|
+
- Use `{project_knowledge}` for additional context scanning
|
|
59
|
+
|
|
60
|
+
### Step 5: Greet the User
|
|
61
|
+
|
|
62
|
+
Greet `{user_name}`, speaking in `{communication_language}`.
|
|
63
|
+
|
|
64
|
+
### Step 6: Execute Append Steps
|
|
65
|
+
|
|
66
|
+
Execute each entry in `{workflow.activation_steps_append}` in order.
|
|
67
|
+
|
|
68
|
+
Activation is complete. Begin the workflow below.
|
|
69
|
+
|
|
70
|
+
## Paths
|
|
71
|
+
|
|
72
|
+
- `output_file` = `{output_folder}/project-context.md`
|
|
73
|
+
|
|
74
|
+
## Execution
|
|
75
|
+
|
|
76
|
+
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
|
77
|
+
- ✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`
|
|
78
|
+
|
|
79
|
+
Load and execute `./steps/step-01-discover.md` to begin the workflow.
|
|
80
|
+
|
|
81
|
+
**Note:** Input document discovery and initialization protocols are handled in step-01-discover.md.
|
package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/implementation-readiness.md
ADDED
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: bmad-check-implementation-readiness
|
|
3
|
+
description: 'Validate PRD, UX, Architecture and Epics specs are complete. Use when the user says "check implementation readiness".'
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Implementation Readiness
|
|
7
|
+
|
|
8
|
+
**Goal:** Validate that PRD, UX, Architecture, Epics and Stories are complete and aligned before Phase 4 implementation starts, with a focus on ensuring epics and stories are logical and have accounted for all requirements and planning.
|
|
9
|
+
|
|
10
|
+
**Your Role:** You are an expert Product Manager, renowned and respected in the field of requirements traceability and spotting gaps in planning. Your success is measured in spotting the failures others have made in planning or preparation of epics and stories to produce the user's product vision.
|
|
11
|
+
|
|
12
|
+
## Conventions
|
|
13
|
+
|
|
14
|
+
- Bare paths (e.g. `steps/step-01-document-discovery.md`) resolve from the skill root.
|
|
15
|
+
- `this skill directory` resolves to this skill's installed directory (where `agent configuration` lives).
|
|
16
|
+
- `{project-root}`-prefixed paths resolve from the project working directory.
|
|
17
|
+
- `{skill-name}` resolves to the skill directory's basename.
|
|
18
|
+
|
|
19
|
+
## WORKFLOW ARCHITECTURE
|
|
20
|
+
|
|
21
|
+
### Core Principles
|
|
22
|
+
|
|
23
|
+
- **Micro-file Design**: Each step toward the overall goal is a self-contained instruction file; adhere to one file at a time, as directed
|
|
24
|
+
- **Just-In-Time Loading**: Only 1 current step file will be loaded and followed to completion - never load future step files until told to do so
|
|
25
|
+
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
|
|
26
|
+
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
|
|
27
|
+
- **Append-Only Building**: Build documents by appending content as directed to the output file
|
|
28
|
+
|
|
29
|
+
### Step Processing Rules
|
|
30
|
+
|
|
31
|
+
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
|
32
|
+
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
|
33
|
+
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
|
34
|
+
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
|
35
|
+
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
|
|
36
|
+
6. **LOAD NEXT**: When directed, read fully and follow the next step file
|
|
37
|
+
|
|
38
|
+
### Critical Rules (NO EXCEPTIONS)
|
|
39
|
+
|
|
40
|
+
- 🛑 **NEVER** load multiple step files simultaneously
|
|
41
|
+
- 📖 **ALWAYS** read entire step file before execution
|
|
42
|
+
- 🚫 **NEVER** skip steps or optimize the sequence
|
|
43
|
+
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
|
|
44
|
+
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
|
45
|
+
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
|
46
|
+
- 📋 **NEVER** create mental todo lists from future steps
|
|
47
|
+
|
|
48
|
+
## On Activation
|
|
49
|
+
|
|
50
|
+
### Step 1: Resolve the Workflow Block
|
|
51
|
+
|
|
52
|
+
<!-- Adapted for BMAD+: original script dependency removed -->
|
|
53
|
+
|
|
54
|
+
**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver:
|
|
55
|
+
|
|
56
|
+
1. `this skill file` — defaults
|
|
57
|
+
2. `{project-root}/custom/{skill-name}.toml` — team overrides
|
|
58
|
+
3. `{project-root}/custom/{skill-name}.user.toml` — personal overrides
|
|
59
|
+
|
|
60
|
+
Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append.
|
|
61
|
+
|
|
62
|
+
### Step 2: Execute Prepend Steps
|
|
63
|
+
|
|
64
|
+
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
|
65
|
+
|
|
66
|
+
### Step 3: Load Persistent Facts
|
|
67
|
+
|
|
68
|
+
Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim.
|
|
69
|
+
|
|
70
|
+
### Step 4: Load Config
|
|
71
|
+
|
|
72
|
+
Load config from `{project-root}/project config` and resolve:
|
|
73
|
+
- Use `{user_name}` for greeting
|
|
74
|
+
- Use `{communication_language}` for all communications
|
|
75
|
+
- Use `{document_output_language}` for output documents
|
|
76
|
+
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
77
|
+
- Use `{project_knowledge}` for additional context scanning
|
|
78
|
+
|
|
79
|
+
### Step 5: Greet the User
|
|
80
|
+
|
|
81
|
+
Greet `{user_name}`, speaking in `{communication_language}`.
|
|
82
|
+
|
|
83
|
+
### Step 6: Execute Append Steps
|
|
84
|
+
|
|
85
|
+
Execute each entry in `{workflow.activation_steps_append}` in order.
|
|
86
|
+
|
|
87
|
+
Activation is complete. Begin the workflow below.
|
|
88
|
+
|
|
89
|
+
## Execution
|
|
90
|
+
|
|
91
|
+
Read fully and follow: `./steps/step-01-document-discovery.md` to begin the workflow.
|
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
# Step 1: Architecture Workflow Initialization
|
|
2
|
+
|
|
3
|
+
## MANDATORY EXECUTION RULES (READ FIRST):
|
|
4
|
+
|
|
5
|
+
- 🛑 NEVER generate content without user input
|
|
6
|
+
- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
|
|
7
|
+
- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
|
|
8
|
+
- ✅ ALWAYS treat this as collaborative discovery between architectural peers
|
|
9
|
+
- 📋 YOU ARE A FACILITATOR, not a content generator
|
|
10
|
+
- 💬 FOCUS on initialization and setup only - don't look ahead to future steps
|
|
11
|
+
- 🚪 DETECT existing workflow state and handle continuation properly
|
|
12
|
+
- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed
|
|
13
|
+
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
|
14
|
+
|
|
15
|
+
## EXECUTION PROTOCOLS:
|
|
16
|
+
|
|
17
|
+
- 🎯 Show your analysis before taking any action
|
|
18
|
+
- 💾 Initialize document and update frontmatter
|
|
19
|
+
- 📖 Set up frontmatter `stepsCompleted: [1]` before loading next step
|
|
20
|
+
- 🚫 FORBIDDEN to load next step until setup is complete
|
|
21
|
+
|
|
22
|
+
## CONTEXT BOUNDARIES:
|
|
23
|
+
|
|
24
|
+
- Variables from workflow.md are available in memory
|
|
25
|
+
- Previous context = what's in output document + frontmatter
|
|
26
|
+
- Don't assume knowledge from other steps
|
|
27
|
+
- Input document discovery happens in this step
|
|
28
|
+
|
|
29
|
+
## YOUR TASK:
|
|
30
|
+
|
|
31
|
+
Initialize the Architecture workflow by detecting continuation state, discovering input documents, and setting up the document for collaborative architectural decision making.
|
|
32
|
+
|
|
33
|
+
## INITIALIZATION SEQUENCE:
|
|
34
|
+
|
|
35
|
+
### 1. Check for Existing Workflow
|
|
36
|
+
|
|
37
|
+
First, check if the output document already exists:
|
|
38
|
+
|
|
39
|
+
- Look for existing {planning_artifacts}/`*architecture*.md`
|
|
40
|
+
- If exists, read the complete file(s) including frontmatter
|
|
41
|
+
- If not exists, this is a fresh workflow
|
|
42
|
+
|
|
43
|
+
### 2. Handle Continuation (If Document Exists)
|
|
44
|
+
|
|
45
|
+
If the document exists and has frontmatter with `stepsCompleted`:
|
|
46
|
+
|
|
47
|
+
- **STOP here** and load `./step-01b-continue.md` immediately
|
|
48
|
+
- Do not proceed with any initialization tasks
|
|
49
|
+
- Let step-01b handle the continuation logic
|
|
50
|
+
|
|
51
|
+
### 3. Fresh Workflow Setup (If No Document)
|
|
52
|
+
|
|
53
|
+
If no document exists or no `stepsCompleted` in frontmatter:
|
|
54
|
+
|
|
55
|
+
#### A. Input Document Discovery
|
|
56
|
+
|
|
57
|
+
Discover and load context documents using smart discovery. Documents can be in the following locations:
|
|
58
|
+
- {planning_artifacts}/**
|
|
59
|
+
- {output_folder}/**
|
|
60
|
+
- {project_knowledge}/**
|
|
61
|
+
- {project-root}/docs/**
|
|
62
|
+
|
|
63
|
+
Also - when searching - documents can be a single markdown file, or a folder with an index and multiple files. For Example, if searching for `*foo*.md` and not found, also search for a folder called *foo*/index.md (which indicates sharded content)
|
|
64
|
+
|
|
65
|
+
Try to discover the following:
|
|
66
|
+
- Product Brief (`*brief*.md`)
|
|
67
|
+
- Product Requirements Document (`*prd*.md`)
|
|
68
|
+
- UX Design (`*ux-design*.md`) and other
|
|
69
|
+
- Research Documents (`*research*.md`)
|
|
70
|
+
- Project Documentation (generally multiple documents might be found for this in the `{project_knowledge}` or `{project-root}/docs` folder.)
|
|
71
|
+
- Project Context (`**/project-context.md`)
|
|
72
|
+
|
|
73
|
+
<critical>Confirm what you have found with the user, along with asking if the user wants to provide anything else. Only after this confirmation will you proceed to follow the loading rules</critical>
|
|
74
|
+
|
|
75
|
+
**Loading Rules:**
|
|
76
|
+
|
|
77
|
+
- Load ALL discovered files completely that the user confirmed or provided (no offset/limit)
|
|
78
|
+
- If there is a project context, whatever is relevant should try to be biased in the remainder of this whole workflow process
|
|
79
|
+
- For sharded folders, load ALL files to get complete picture, using the index first to potentially know the potential of each document
|
|
80
|
+
- index.md is a guide to what's relevant whenever available
|
|
81
|
+
- Track all successfully loaded files in frontmatter `inputDocuments` array
|
|
82
|
+
|
|
83
|
+
#### B. Validate Required Inputs
|
|
84
|
+
|
|
85
|
+
Before proceeding, verify we have the essential inputs:
|
|
86
|
+
|
|
87
|
+
**PRD Validation:**
|
|
88
|
+
|
|
89
|
+
- If no PRD found: "Architecture requires a PRD to work from. Please run the PRD workflow first or provide the PRD file path."
|
|
90
|
+
- Do NOT proceed without PRD
|
|
91
|
+
|
|
92
|
+
**Other Input that might exist:**
|
|
93
|
+
|
|
94
|
+
- UX Spec: "Provides UI/UX architectural requirements"
|
|
95
|
+
|
|
96
|
+
#### C. Create Initial Document
|
|
97
|
+
|
|
98
|
+
Copy the template from `../architecture-decision-template.md` to `{planning_artifacts}/architecture.md`
|
|
99
|
+
|
|
100
|
+
#### D. Complete Initialization and Report
|
|
101
|
+
|
|
102
|
+
Complete setup and report to user:
|
|
103
|
+
|
|
104
|
+
**Document Setup:**
|
|
105
|
+
|
|
106
|
+
- Created: `{planning_artifacts}/architecture.md` from template
|
|
107
|
+
- Initialized frontmatter with workflow state
|
|
108
|
+
|
|
109
|
+
**Input Documents Discovered:**
|
|
110
|
+
Report what was found:
|
|
111
|
+
"Welcome {{user_name}}! I've set up your Architecture workspace for {{project_name}}.
|
|
112
|
+
|
|
113
|
+
**Documents Found:**
|
|
114
|
+
|
|
115
|
+
- PRD: {number of PRD files loaded or "None found - REQUIRED"}
|
|
116
|
+
- UX Design: {number of UX files loaded or "None found"}
|
|
117
|
+
- Research: {number of research files loaded or "None found"}
|
|
118
|
+
- Project docs: {number of project files loaded or "None found"}
|
|
119
|
+
- Project context: {project_context_rules count of rules for AI agents found}
|
|
120
|
+
|
|
121
|
+
**Files loaded:** {list of specific file names or "No additional documents found"}
|
|
122
|
+
|
|
123
|
+
Ready to begin architectural decision making. Do you have any other documents you'd like me to include?
|
|
124
|
+
|
|
125
|
+
[C] Continue to project context analysis
|
|
126
|
+
|
|
127
|
+
## SUCCESS METRICS:
|
|
128
|
+
|
|
129
|
+
✅ Existing workflow detected and handed off to step-01b correctly
|
|
130
|
+
✅ Fresh workflow initialized with template and frontmatter
|
|
131
|
+
✅ Input documents discovered and loaded using sharded-first logic
|
|
132
|
+
✅ All discovered files tracked in frontmatter `inputDocuments`
|
|
133
|
+
✅ PRD requirement validated and communicated
|
|
134
|
+
✅ User confirmed document setup and can proceed
|
|
135
|
+
|
|
136
|
+
## FAILURE MODES:
|
|
137
|
+
|
|
138
|
+
❌ Proceeding with fresh initialization when existing workflow exists
|
|
139
|
+
❌ Not updating frontmatter with discovered input documents
|
|
140
|
+
❌ Creating document without proper template
|
|
141
|
+
❌ Not checking sharded folders first before whole files
|
|
142
|
+
❌ Not reporting what documents were found to user
|
|
143
|
+
❌ Proceeding without validating PRD requirement
|
|
144
|
+
|
|
145
|
+
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
|
146
|
+
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
|
147
|
+
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
|
148
|
+
|
|
149
|
+
## NEXT STEP:
|
|
150
|
+
|
|
151
|
+
After user selects [C] to continue, only after ensuring all the template output has been created, then load `./step-02-context.md` to analyze the project context and begin architectural decision making.
|
|
152
|
+
|
|
153
|
+
Remember: Do NOT proceed to step-02 until user explicitly selects [C] from the menu and setup is confirmed!
|
package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-01b-continue.md
ADDED
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
# Step 1b: Workflow Continuation Handler
|
|
2
|
+
|
|
3
|
+
## MANDATORY EXECUTION RULES (READ FIRST):
|
|
4
|
+
|
|
5
|
+
- 🛑 NEVER generate content without user input
|
|
6
|
+
|
|
7
|
+
- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
|
|
8
|
+
- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
|
|
9
|
+
- ✅ ALWAYS treat this as collaborative discovery between architectural peers
|
|
10
|
+
- 📋 YOU ARE A FACILITATOR, not a content generator
|
|
11
|
+
- 💬 FOCUS on understanding current state and getting user confirmation
|
|
12
|
+
- 🚪 HANDLE workflow resumption smoothly and transparently
|
|
13
|
+
- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed
|
|
14
|
+
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
|
15
|
+
|
|
16
|
+
## EXECUTION PROTOCOLS:
|
|
17
|
+
|
|
18
|
+
- 🎯 Show your analysis before taking any action
|
|
19
|
+
- 📖 Read existing document completely to understand current state
|
|
20
|
+
- 💾 Update frontmatter to reflect continuation
|
|
21
|
+
- 🚫 FORBIDDEN to proceed to next step without user confirmation
|
|
22
|
+
|
|
23
|
+
## CONTEXT BOUNDARIES:
|
|
24
|
+
|
|
25
|
+
- Existing document and frontmatter are available
|
|
26
|
+
- Input documents already loaded should be in frontmatter `inputDocuments`
|
|
27
|
+
- Steps already completed are in `stepsCompleted` array
|
|
28
|
+
- Focus on understanding where we left off
|
|
29
|
+
|
|
30
|
+
## YOUR TASK:
|
|
31
|
+
|
|
32
|
+
Handle workflow continuation by analyzing existing work and guiding the user to resume at the appropriate step.
|
|
33
|
+
|
|
34
|
+
## CONTINUATION SEQUENCE:
|
|
35
|
+
|
|
36
|
+
### 1. Analyze Current Document State
|
|
37
|
+
|
|
38
|
+
Read the existing architecture document completely and analyze:
|
|
39
|
+
|
|
40
|
+
**Frontmatter Analysis:**
|
|
41
|
+
|
|
42
|
+
- `stepsCompleted`: What steps have been done
|
|
43
|
+
- `inputDocuments`: What documents were loaded
|
|
44
|
+
- `lastStep`: Last step that was executed
|
|
45
|
+
- `project_name`, `user_name`, `date`: Basic context
|
|
46
|
+
|
|
47
|
+
**Content Analysis:**
|
|
48
|
+
|
|
49
|
+
- What sections exist in the document
|
|
50
|
+
- What architectural decisions have been made
|
|
51
|
+
- What appears incomplete or in progress
|
|
52
|
+
- Any TODOs or placeholders remaining
|
|
53
|
+
|
|
54
|
+
### 2. Present Continuation Summary
|
|
55
|
+
|
|
56
|
+
Show the user their current progress:
|
|
57
|
+
|
|
58
|
+
"Welcome back {{user_name}}! I found your Architecture work for {{project_name}}.
|
|
59
|
+
|
|
60
|
+
**Current Progress:**
|
|
61
|
+
|
|
62
|
+
- Steps completed: {{stepsCompleted list}}
|
|
63
|
+
- Last step worked on: Step {{lastStep}}
|
|
64
|
+
- Input documents loaded: {{number of inputDocuments}} files
|
|
65
|
+
|
|
66
|
+
**Document Sections Found:**
|
|
67
|
+
{list all H2/H3 sections found in the document}
|
|
68
|
+
|
|
69
|
+
{if_incomplete_sections}
|
|
70
|
+
**Incomplete Areas:**
|
|
71
|
+
|
|
72
|
+
- {areas that appear incomplete or have placeholders}
|
|
73
|
+
{/if_incomplete_sections}
|
|
74
|
+
|
|
75
|
+
**What would you like to do?**
|
|
76
|
+
[R] Resume from where we left off
|
|
77
|
+
[C] Continue to next logical step
|
|
78
|
+
[O] Overview of all remaining steps
|
|
79
|
+
[X] Start over (will overwrite existing work)
|
|
80
|
+
"
|
|
81
|
+
|
|
82
|
+
### 3. Handle User Choice
|
|
83
|
+
|
|
84
|
+
#### If 'R' (Resume from where we left off):
|
|
85
|
+
|
|
86
|
+
- Identify the next step based on `stepsCompleted`
|
|
87
|
+
- Load the appropriate step file to continue
|
|
88
|
+
- Example: If `stepsCompleted: [1, 2, 3]`, load `./step-04-decisions.md`
|
|
89
|
+
|
|
90
|
+
#### If 'C' (Continue to next logical step):
|
|
91
|
+
|
|
92
|
+
- Analyze the document content to determine logical next step
|
|
93
|
+
- May need to review content quality and completeness
|
|
94
|
+
- If content seems complete for current step, advance to next
|
|
95
|
+
- If content seems incomplete, suggest staying on current step
|
|
96
|
+
|
|
97
|
+
#### If 'O' (Overview of all remaining steps):
|
|
98
|
+
|
|
99
|
+
- Provide brief description of all remaining steps
|
|
100
|
+
- Let user choose which step to work on
|
|
101
|
+
- Don't assume sequential progression is always best
|
|
102
|
+
|
|
103
|
+
#### If 'X' (Start over):
|
|
104
|
+
|
|
105
|
+
- Confirm: "This will delete all existing architectural decisions. Are you sure? (y/n)"
|
|
106
|
+
- If confirmed: Delete existing document and read fully and follow: `./step-01-init.md`
|
|
107
|
+
- If not confirmed: Return to continuation menu
|
|
108
|
+
|
|
109
|
+
### 4. Navigate to Selected Step
|
|
110
|
+
|
|
111
|
+
After user makes choice:
|
|
112
|
+
|
|
113
|
+
**Load the selected step file:**
|
|
114
|
+
|
|
115
|
+
- Update frontmatter `lastStep` to reflect current navigation
|
|
116
|
+
- Execute the selected step file
|
|
117
|
+
- Let that step handle the detailed continuation logic
|
|
118
|
+
|
|
119
|
+
**State Preservation:**
|
|
120
|
+
|
|
121
|
+
- Maintain all existing content in the document
|
|
122
|
+
- Keep `stepsCompleted` accurate
|
|
123
|
+
- Track the resumption in workflow status
|
|
124
|
+
|
|
125
|
+
### 5. Special Continuation Cases
|
|
126
|
+
|
|
127
|
+
#### If `stepsCompleted` is empty but document has content:
|
|
128
|
+
|
|
129
|
+
- This suggests an interrupted workflow
|
|
130
|
+
- Ask user: "I see the document has content but no steps are marked as complete. Should I analyze what's here and set the appropriate step status?"
|
|
131
|
+
|
|
132
|
+
#### If document appears corrupted or incomplete:
|
|
133
|
+
|
|
134
|
+
- Ask user: "The document seems incomplete. Would you like me to try to recover what's here, or would you prefer to start fresh?"
|
|
135
|
+
|
|
136
|
+
#### If document is complete but workflow not marked as done:
|
|
137
|
+
|
|
138
|
+
- Ask user: "The architecture looks complete! Should I mark this workflow as finished, or is there more you'd like to work on?"
|
|
139
|
+
|
|
140
|
+
## SUCCESS METRICS:
|
|
141
|
+
|
|
142
|
+
✅ Existing document state properly analyzed and understood
|
|
143
|
+
✅ User presented with clear continuation options
|
|
144
|
+
✅ User choice handled appropriately and transparently
|
|
145
|
+
✅ Workflow state preserved and updated correctly
|
|
146
|
+
✅ Navigation to appropriate step handled smoothly
|
|
147
|
+
|
|
148
|
+
## FAILURE MODES:
|
|
149
|
+
|
|
150
|
+
❌ Not reading the complete existing document before making suggestions
|
|
151
|
+
❌ Losing track of what steps were actually completed
|
|
152
|
+
❌ Automatically proceeding without user confirmation of next steps
|
|
153
|
+
❌ Not checking for incomplete or placeholder content
|
|
154
|
+
❌ Losing existing document content during resumption
|
|
155
|
+
|
|
156
|
+
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
|
157
|
+
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
|
158
|
+
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
|
159
|
+
|
|
160
|
+
## NEXT STEP:
|
|
161
|
+
|
|
162
|
+
After user selects their continuation option, load the appropriate step file based on their choice. The step file will handle the detailed work from that point forward.
|
|
163
|
+
|
|
164
|
+
Valid step files to load:
|
|
165
|
+
- `./step-02-context.md`
|
|
166
|
+
- `./step-03-starter.md`
|
|
167
|
+
- `./step-04-decisions.md`
|
|
168
|
+
- `./step-05-patterns.md`
|
|
169
|
+
- `./step-06-structure.md`
|
|
170
|
+
- `./step-07-validation.md`
|
|
171
|
+
- `./step-08-complete.md`
|
|
172
|
+
|
|
173
|
+
Remember: The goal is smooth, transparent resumption that respects the work already done while giving the user control over how to proceed.
|