bmad-plus 0.13.0 → 0.14.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 +22 -0
- package/README.md +96 -489
- package/package.json +7 -2
- package/readme-international/README.de.md +9 -5
- package/readme-international/README.es.md +9 -5
- package/readme-international/README.fr.md +9 -5
- package/src/bmad-plus/agents/agent-orchestrator/SKILL.md +3 -3
- package/src/bmad-plus/packs/pack-dev-studio/README.md +133 -141
- package/src/bmad-plus/packs/pack-dev-studio/SKILL.md +49 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/analyst-agent.md +35 -60
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/document-project.md +59 -59
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/domain-research.md +55 -93
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/market-research.md +58 -93
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/prfaq.md +55 -132
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/product-brief.md +63 -78
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/tech-writer-agent.md +54 -69
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/technical-research.md +54 -93
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/architect-agent.md +32 -60
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/create-architecture.md +67 -71
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/create-epics-stories.md +61 -90
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/generate-project-context.md +56 -78
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/implementation-readiness.md +55 -88
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-01-init.md +20 -153
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-01b-continue.md +20 -173
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-02-context.md +14 -220
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-03-starter.md +20 -329
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-04-decisions.md +15 -314
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-05-patterns.md +15 -355
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-06-structure.md +15 -375
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-07-validation.md +14 -357
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-08-complete.md +13 -78
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/checkpoint-preview.md +52 -65
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review-steps/step-01-gather-context.md +14 -81
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review-steps/step-02-review.md +14 -31
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review-steps/step-03-triage.md +14 -45
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review-steps/step-04-present.md +13 -128
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review.md +61 -87
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/correct-course.md +55 -298
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/create-story.md +52 -426
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/dev-agent.md +48 -69
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/dev-story-checklist.md +22 -80
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/dev-story.md +60 -482
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/investigate.md +50 -184
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/qa-e2e-tests.md +57 -173
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/quick-dev.md +56 -108
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/retrospective.md +54 -1509
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/sprint-planning.md +54 -296
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/sprint-status.md +41 -283
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/create-prd.md +58 -18
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/create-ux-design.md +103 -72
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/edit-prd.md +55 -27
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/pm-agent.md +34 -60
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/prd.md +46 -87
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/steps/step-01-init.md +10 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/ux-designer-agent.md +30 -60
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/validate-prd.md +57 -27
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/advanced-elicitation.md +47 -138
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/adversarial-review.md +48 -34
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/bmad-help.md +51 -68
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/brainstorming.md +46 -3
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/customize.md +68 -109
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/distillator.md +53 -174
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/edge-case-hunter.md +39 -53
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/editorial-review-prose.md +45 -83
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/editorial-review-structure.md +45 -176
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/index-docs.md +45 -63
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/party-mode.md +53 -124
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/shard-doc.md +44 -100
- package/src/bmad-plus/packs/pack-dev-studio/dev-studio-orchestrator.md +56 -116
- package/src/bmad-plus/packs/pack-dev-studio/shared/architecture-decision-template.md +49 -12
- package/src/bmad-plus/packs/pack-dev-studio/shared/bwml-spec.md +51 -328
- package/src/bmad-plus/packs/pack-dev-studio/shared/catalog.json +489 -0
- package/src/bmad-plus/packs/pack-dev-studio/shared/execution.md +69 -0
- package/src/bmad-plus/packs/pack-dev-studio/shared/module-help.csv +39 -32
- package/src/bmad-plus/packs/pack-dev-studio/upstream-sync.yaml +85 -14
- package/src/bmad-plus/packs/pack-memory/README.md +6 -0
- package/src/bmad-plus/packs/pack-memory/memory-orchestrator.md +12 -5
- package/src/bmad-plus/packs/pack-seo/SKILL.md +27 -1
- package/src/bmad-plus/packs/pack-seo/seo-chief.md +16 -1
- package/src/bmad-plus/packs/pack-seo/seo-judge.md +12 -0
- package/src/bmad-plus/packs/pack-seo/seo-scout.md +12 -0
- package/src/bmad-plus/skills/bmad-plus-autopilot/SKILL.md +3 -3
- package/src/bmad-plus/skills/bmad-plus-sync/SKILL.md +5 -3
- package/src/bmad-plus/skills/dev-studio/SKILL.md +19 -0
- package/tools/build/check-install-contract.js +165 -13
- package/tools/build/generate.js +213 -40
- package/tools/build/generated-adapters/.codex/AGENTS.md +1 -1
- package/tools/build/generated-adapters/.cursor/rules/bmad-plus.mdc +1 -1
- package/tools/build/generated-adapters/.opencode/AGENTS.md +1 -1
- package/tools/build/generated-adapters/AGENTS.md +1 -1
- package/tools/build/generated-adapters/CLAUDE.md +1 -1
- package/tools/build/generated-adapters/CONVENTIONS.md +1 -1
- package/tools/build/generated-adapters/GEMINI.md +1 -1
- package/tools/build/pack-delivery.js +78 -0
- package/tools/cli/bmad-plus-cli.js +1 -1
- package/tools/cli/commands/doctor.js +49 -189
- package/tools/cli/commands/install.js +1 -1
- package/tools/cli/commands/studio.js +68 -0
- package/tools/cli/lib/installation-health.js +360 -0
- package/tools/cli/lib/packs.js +118 -9
- package/tools/cli/lib/python-health.js +233 -0
- package/tools/cli/lib/python-provision.js +2 -2
- package/tools/cli/lib/studio.js +310 -0
- package/tools/release/publication-content.js +901 -0
|
@@ -1,135 +1,58 @@
|
|
|
1
|
-
|
|
1
|
+
---
|
|
2
2
|
name: bmad-prfaq
|
|
3
|
-
description:
|
|
3
|
+
description: Explore a product concept through a proposed launch narrative and customer and delivery questions.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
#
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
-
|
|
59
|
-
|
|
60
|
-
### Step 5: Greet the User
|
|
61
|
-
|
|
62
|
-
Greet `{user_name}`, speaking in `{communication_language}`. Be warm but efficient — dream builder energy.
|
|
63
|
-
|
|
64
|
-
### Step 6: Execute Append Steps
|
|
65
|
-
|
|
66
|
-
Execute each entry in `{workflow.activation_steps_append}` in order.
|
|
67
|
-
|
|
68
|
-
Activation is complete. Continue below.
|
|
69
|
-
|
|
70
|
-
## Pre-workflow Setup
|
|
71
|
-
|
|
72
|
-
1. **Resume detection:** Check if `{planning_artifacts}/prfaq-{project_name}.md` already exists. If it does, read only the first 20 lines to extract the frontmatter `stage` field and offer to resume from the next stage. Do not read the full document. If the user confirms, route directly to that stage's reference file.
|
|
73
|
-
|
|
74
|
-
2. **Mode detection:**
|
|
75
|
-
- `--headless` / `-H`: Produce complete first-draft PRFAQ from provided inputs without interaction. Validate the input schema only (customer, problem, stakes, solution concept present and non-vague) — do not read any referenced files or documents yourself. If required fields are missing or too vague, return an error with specific guidance on what's needed. Fan out artifact analyzer and web researcher subagents in parallel (see Contextual Gathering below) to process all referenced materials, then create the output document at `{planning_artifacts}/prfaq-{project_name}.md` using `./assets/prfaq-template.md` and route to `./references/press-release.md`.
|
|
76
|
-
- Default: Full interactive coaching — the gauntlet.
|
|
77
|
-
|
|
78
|
-
**Headless input schema:**
|
|
79
|
-
- **Required:** customer (specific persona), problem (concrete), stakes (why it matters), solution (concept)
|
|
80
|
-
- **Optional:** competitive context, technical constraints, team/org context, target market, existing research
|
|
81
|
-
|
|
82
|
-
**Set the tone immediately.** This isn't a warm, exploratory greeting. Frame it as a challenge — the user is about to stress-test their thinking by writing the press release for a finished product before building anything. Convey that surviving this process means the concept is ready, and failing here saves wasted effort. Be direct and energizing.
|
|
83
|
-
|
|
84
|
-
Then briefly ground the user on what a PRFAQ actually is — Amazon's Working Backwards method where you write the finished-product press release first, then answer the hardest customer and stakeholder questions. The point is forcing clarity before committing resources.
|
|
85
|
-
|
|
86
|
-
Then proceed to Stage 1 below.
|
|
87
|
-
|
|
88
|
-
## Stage 1: Ignition
|
|
89
|
-
|
|
90
|
-
**Goal:** Get the raw concept on the table and immediately establish customer-first thinking. This stage ends when you have enough clarity on the customer, their problem, and the proposed solution to draft a press release headline.
|
|
91
|
-
|
|
92
|
-
**Customer-first enforcement:**
|
|
93
|
-
|
|
94
|
-
- If the user leads with a solution ("I want to build X"): redirect to the customer's problem. Don't let them skip the pain.
|
|
95
|
-
- If the user leads with a technology ("I want to use AI/blockchain/etc"): challenge harder. Technology is a "how", not a "why" — push them to articulate the human problem. Strip away the buzzword and ask whether anyone still cares.
|
|
96
|
-
- If the user leads with a customer problem: dig deeper into specifics — how they cope today, what they've tried, why it hasn't been solved.
|
|
97
|
-
|
|
98
|
-
When the user gets stuck, offer concrete suggestions based on what they've shared so far. Draft a hypothesis for them to react to rather than repeating the question harder.
|
|
99
|
-
|
|
100
|
-
**Concept type detection:** Early in the conversation, identify whether this is a commercial product, internal tool, open-source project, or community/nonprofit initiative. Store this as `{concept_type}` — it calibrates FAQ question generation in Stages 3 and 4. Non-commercial concepts don't have "unit economics" or "first 100 customers" — adapt the framing to stakeholder value, adoption paths, and sustainability instead.
|
|
101
|
-
|
|
102
|
-
**Essentials to capture before progressing:**
|
|
103
|
-
- Who is the customer/user? (specific persona, not "everyone")
|
|
104
|
-
- What is their problem? (concrete and felt, not abstract)
|
|
105
|
-
- Why does this matter to them? (stakes and consequences)
|
|
106
|
-
- What's the initial concept for a solution? (even rough)
|
|
107
|
-
|
|
108
|
-
**Fast-track:** If the user provides all four essentials in their opening message (or via structured input), acknowledge and confirm understanding, then move directly to document creation and Stage 2 without extended discovery.
|
|
109
|
-
|
|
110
|
-
**Graceful redirect:** If after 2-3 exchanges the user can't articulate a customer or problem, don't force it — suggest the idea may need more exploration first and recommend they invoke the `bmad-brainstorming` skill to develop it further.
|
|
111
|
-
|
|
112
|
-
**Contextual Gathering:** Once you understand the concept, gather external context before drafting begins.
|
|
113
|
-
|
|
114
|
-
1. **Ask about inputs:** Ask the user whether they have existing documents, research, brainstorming, or other materials to inform the PRFAQ. Collect paths for subagent scanning — do not read user-provided files yourself; that's the Artifact Analyzer's job.
|
|
115
|
-
2. **Fan out subagents in parallel:**
|
|
116
|
-
- **Artifact Analyzer** (`./agents/artifact-analyzer.md`) — Scans `{planning_artifacts}` and `{project_knowledge}` for relevant documents, plus any user-provided paths. Receives the product intent summary so it knows what's relevant.
|
|
117
|
-
- **Web Researcher** (`./agents/web-researcher.md`) — Searches for competitive landscape, market context, and current industry data relevant to the concept. Receives the product intent summary.
|
|
118
|
-
3. **Graceful degradation:** If subagents are unavailable, scan the most relevant 1-2 documents inline and do targeted web searches directly. Never block the workflow.
|
|
119
|
-
4. **Merge findings** with what the user shared. Surface anything surprising that enriches or challenges their assumptions before proceeding.
|
|
120
|
-
|
|
121
|
-
**Create the output document** at `{planning_artifacts}/prfaq-{project_name}.md` using `./assets/prfaq-template.md`. Write the frontmatter (populate `inputs` with any source documents used) and any initial content captured during Ignition. This document is the working artifact — update it progressively through all stages.
|
|
122
|
-
|
|
123
|
-
**Coaching Notes Capture:** Before moving on, append a `<!-- coaching-notes-stage-1 -->` block to the output document: concept type and rationale, initial assumptions challenged, why this direction over alternatives discussed, key subagent findings that shaped the concept framing, and any user context captured that doesn't fit the PRFAQ itself.
|
|
124
|
-
|
|
125
|
-
**When you have enough to draft a press release headline**, route to `./references/press-release.md`.
|
|
126
|
-
|
|
127
|
-
## Stages
|
|
128
|
-
|
|
129
|
-
| # | Stage | Purpose | Location |
|
|
130
|
-
|---|-------|---------|----------|
|
|
131
|
-
| 1 | Ignition | Raw concept, enforce customer-first thinking | SKILL.md (above) |
|
|
132
|
-
| 2 | The Press Release | Iterative drafting with hard coaching | `./references/press-release.md` |
|
|
133
|
-
| 3 | Customer FAQ | Devil's advocate customer questions | `./references/customer-faq.md` |
|
|
134
|
-
| 4 | Internal FAQ | Skeptical stakeholder questions | `./references/internal-faq.md` |
|
|
135
|
-
| 5 | The Verdict | Synthesis, strength assessment, final output | `./references/verdict.md` |
|
|
6
|
+
# PRFAQ
|
|
7
|
+
|
|
8
|
+
Load the [execution guide](../../shared/execution.md) and
|
|
9
|
+
[Miriam](analyst-agent.md). Test whether a product promise makes sense to a
|
|
10
|
+
customer and can be supported by a plausible delivery plan.
|
|
11
|
+
|
|
12
|
+
## Inputs
|
|
13
|
+
|
|
14
|
+
Use the product idea or brief, intended audience, desired outcome, scope and
|
|
15
|
+
known constraints. Read an existing PRFAQ before revising it. Identify which
|
|
16
|
+
claims describe today's product and which describe a possible future release.
|
|
17
|
+
|
|
18
|
+
## Procedure
|
|
19
|
+
|
|
20
|
+
1. State the decision this exercise should inform. Extract the customer's task,
|
|
21
|
+
unmet need and current alternative from the supplied evidence.
|
|
22
|
+
2. Write a short proposed launch narrative: headline, audience, problem, outcome,
|
|
23
|
+
how the first use works and availability assumptions. Label the narrative as
|
|
24
|
+
a proposal. Do not invent a real launch date, shipped feature, customer quote
|
|
25
|
+
or endorsement. Illustrative quotes, if useful, must be identified as such.
|
|
26
|
+
3. Write the customer FAQ from a skeptical user's perspective: who benefits,
|
|
27
|
+
prerequisites, migration from the current approach, cost assumptions, data
|
|
28
|
+
handling, limits, failure recovery and how to stop using the product. Include
|
|
29
|
+
only topics relevant to the concept.
|
|
30
|
+
4. Write the delivery FAQ: smallest useful release, dependencies, effort and cost
|
|
31
|
+
uncertainties, operational ownership, adoption obstacles and the strongest
|
|
32
|
+
reason the proposal might fail. Distinguish estimated answers from measured
|
|
33
|
+
evidence and record unresolved decisions.
|
|
34
|
+
5. Challenge material promises against the evidence. Verify external pricing,
|
|
35
|
+
competitor behavior and feasibility claims using current primary sources
|
|
36
|
+
where possible. Unsupported claims remain hypotheses in the document.
|
|
37
|
+
6. Revise the promise when the FAQs expose contradictions. Preserve unresolved
|
|
38
|
+
tradeoffs instead of giving every objection an invented answer. Define the
|
|
39
|
+
next observation or experiment that could accept or reject the concept.
|
|
40
|
+
7. Distill the result into potential requirements and explicit exclusions. Keep
|
|
41
|
+
speculative features distinguishable from requirements supplied by the user.
|
|
42
|
+
|
|
43
|
+
## Output
|
|
44
|
+
|
|
45
|
+
Produce one report containing the proposed announcement, customer FAQ, delivery
|
|
46
|
+
FAQ, claim-to-evidence table, candidate requirements, exclusions and next
|
|
47
|
+
validation action. The claim table records the claim, its source or assumption,
|
|
48
|
+
confidence limitation and consequence if false.
|
|
49
|
+
|
|
50
|
+
## Acceptance and continuation
|
|
51
|
+
|
|
52
|
+
The core promise, first-use description and delivery scope must agree. Readers
|
|
53
|
+
must be able to distinguish proposed availability from an actual release.
|
|
54
|
+
This artifact does not authorize publication or customer contact.
|
|
55
|
+
|
|
56
|
+
On resume, compare changed claims and inputs, then revisit affected FAQ answers
|
|
57
|
+
before editing the narrative. A supported concept can feed
|
|
58
|
+
[Product brief](product-brief.md) or [PRD creation](../planning/create-prd.md).
|
|
@@ -1,81 +1,66 @@
|
|
|
1
|
-
|
|
1
|
+
---
|
|
2
2
|
name: bmad-product-brief
|
|
3
|
-
description: Create, update
|
|
3
|
+
description: Create, update or assess a product brief from a real problem and available evidence.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
#
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
- **Right-size to purpose.** A passion project does not need investor-grade rigor. A VC pitch input does. Read the room.
|
|
69
|
-
- **Persistence is real-time.** Once Create intent is confirmed, the workspace (run folder, `brief.md` skeleton with `status: draft`, `decision-log.md`) exists on disk and the user knows the path.
|
|
70
|
-
- **File roles.** `decision-log.md` is canonical memory and audit trail — every decision, change, and override (including headless overrides) is recorded there as the conversation unfolds. `addendum.md` preserves user-contributed depth that belongs in a downstream document (PRD, architecture, solution design) or earned a place but does not fit the brief (rejected-alternative rationale, options-considered matrices, parked-roadmap context, technical constraints, in-depth personas, sizing data). Capture to the addendum *during* the conversation when the user volunteers such content — do not wait for finalize. Audit and override information never goes in the addendum.
|
|
71
|
-
- **Continuity across sessions.** If a prior in-progress draft for this project exists, the user is offered to resume.
|
|
72
|
-
- **Extract, don't ingest.** Source artifacts (provided by the user or discovered during the run — transcripts, brainstorms, research reports, code, web results, prior briefs) enter the parent conversation as relevance-filtered extracts, not loaded wholesale. Subagents do the extraction against the user's stated focus; the parent context stays lean.
|
|
73
|
-
- **Length and coherence.** Aim for 1-2 pages — if it is longer, the detail belongs in the addendum. Structure in service of the product; downstream consumers (PRD workflow, etc.) read this, so coherent shape matters.
|
|
74
|
-
|
|
75
|
-
## Finalize
|
|
76
|
-
|
|
77
|
-
1. Decision log audit + addendum review: the user ends this step with an explicit, shared accounting of how the meaningful contents of `decision-log.md` were handled — captured in the brief, captured in `addendum.md` (which may already hold detail captured during the conversation — see `## Constraints` for what belongs there), or set aside as process noise.
|
|
78
|
-
2. Polish: apply each entry in `{workflow.doc_standards}` (a `skill:`, `file:`, or plain-text directive) to `brief.md` (and `addendum.md` if it exists). Run passes as parallel subagents - apply all doc standards to `brief.md` first, then `addendum.md` so we present a high-quality draft for the user to review and finalize.
|
|
79
|
-
3. External handoffs: execute each entry in `{workflow.external_handoffs}` to route artifacts beyond local files (Confluence, Notion, ticket systems, etc.) — each directive names the MCP tool and the fields it needs. Invoke the tool, capture any URLs or IDs returned, and surface them in the user message. If a named tool is unavailable, skip that handoff and flag it; local files always exist regardless.
|
|
80
|
-
4. Tell the user it is ready: local paths and external destinations (URLs returned from handoffs). Invoke `bmad-help` to suggest what next steps make sense in the bmad method ecosystem.
|
|
81
|
-
5. Run `{workflow.on_complete}` if non-empty. Treat a string scalar as a single instruction and an array as a sequence of instructions executed in order.
|
|
6
|
+
# Product brief
|
|
7
|
+
|
|
8
|
+
Load the [execution guide](../../shared/execution.md) and
|
|
9
|
+
[Miriam](analyst-agent.md). Produce a concise basis for deciding what to build
|
|
10
|
+
and which uncertainty to resolve first.
|
|
11
|
+
|
|
12
|
+
## Inputs
|
|
13
|
+
|
|
14
|
+
Use the user's idea or change request, intended users, desired outcome and any
|
|
15
|
+
existing research or project context. An update or assessment needs the actual
|
|
16
|
+
brief. An idea is enough for a draft; missing research must remain visible.
|
|
17
|
+
|
|
18
|
+
## Procedure
|
|
19
|
+
|
|
20
|
+
1. Establish the brief's purpose and mode: create, update or assess. For an
|
|
21
|
+
existing product, inspect its current behavior and preserve decisions that the
|
|
22
|
+
request does not change.
|
|
23
|
+
2. Describe the specific user, their task, the present workaround and the cost of
|
|
24
|
+
the problem. Separate supplied observations from inferred needs. Do not turn
|
|
25
|
+
an imagined persona into a research finding.
|
|
26
|
+
3. State the proposed outcome and why the current alternatives may be inadequate.
|
|
27
|
+
Check material competitive claims with current sources when access is
|
|
28
|
+
available. Without them, label the claim as a hypothesis.
|
|
29
|
+
4. Define the first useful scope and explicit exclusions. Connect each included
|
|
30
|
+
capability to the problem it addresses. Keep requested capabilities visible;
|
|
31
|
+
record proposed phasing without silently removing them.
|
|
32
|
+
5. Define success: metric, current baseline if known, proposed target, observation
|
|
33
|
+
method and any counter-metric that guards against a harmful tradeoff. Unknown
|
|
34
|
+
baselines or unapproved targets remain open items.
|
|
35
|
+
6. List the assumptions most likely to invalidate the proposal. For each, propose
|
|
36
|
+
a small observation or experiment, its decision threshold and who could supply
|
|
37
|
+
the evidence. Do not claim that the experiment has happened.
|
|
38
|
+
7. Review the brief for contradictions between audience, scope, value and success.
|
|
39
|
+
In update mode, explain material reversals and their evidence. In assessment
|
|
40
|
+
mode, leave the source brief unchanged and report findings with locations.
|
|
41
|
+
|
|
42
|
+
## Output
|
|
43
|
+
|
|
44
|
+
Write the report for the invoked workflow with these sections:
|
|
45
|
+
|
|
46
|
+
- Problem and intended users.
|
|
47
|
+
- Evidence and current alternatives.
|
|
48
|
+
- Proposed value and first useful scope.
|
|
49
|
+
- Exclusions and constraints.
|
|
50
|
+
- Success measures, baselines and proposed targets.
|
|
51
|
+
- Assumptions, risks and validation actions.
|
|
52
|
+
- Recommendation, open decisions and next step.
|
|
53
|
+
|
|
54
|
+
Include input paths and the status of each important claim. A short brief may
|
|
55
|
+
combine sections when their meaning remains clear.
|
|
56
|
+
|
|
57
|
+
## Acceptance and continuation
|
|
58
|
+
|
|
59
|
+
Every included capability should serve a stated user problem; every success
|
|
60
|
+
claim should have an observable measure. A draft with open assumptions is a
|
|
61
|
+
valid outcome, but do not label it validated without supporting observations.
|
|
62
|
+
|
|
63
|
+
Resume from the unresolved decision after comparing changed inputs. If the
|
|
64
|
+
problem or audience changes, revisit scope and metrics before polishing wording.
|
|
65
|
+
A usable brief can feed [PRD creation](../planning/create-prd.md); select that
|
|
66
|
+
route only when it advances the user's task.
|
|
@@ -1,74 +1,59 @@
|
|
|
1
|
-
|
|
1
|
+
---
|
|
2
2
|
name: bmad-agent-tech-writer
|
|
3
|
-
description: Technical documentation
|
|
3
|
+
description: Technical documentation and explanation with Huldah.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Huldah — Technical Writer
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
Continue to prefix your messages with `{agent.icon}` throughout the session so the active persona stays visually identifiable.
|
|
61
|
-
|
|
62
|
-
### Step 7: Execute Append Steps
|
|
63
|
-
|
|
64
|
-
Execute each entry in `{agent.activation_steps_append}` in order.
|
|
65
|
-
|
|
66
|
-
### Step 8: Dispatch or Present the Menu
|
|
67
|
-
|
|
68
|
-
If the user's initial message already names an intent that clearly maps to a menu item (e.g. "hey Huldah, let's document this codebase"), skip the menu and dispatch that item directly after greeting.
|
|
69
|
-
|
|
70
|
-
Otherwise render `{agent.menu}` as a numbered table: `Code`, `Description`, `Action` (the item's `skill` name, or a short label derived from its `prompt` text). **Stop and wait for input.** Accept a number, menu `code`, or fuzzy description match.
|
|
71
|
-
|
|
72
|
-
Dispatch on a clear match by invoking the item's `skill` or executing its `prompt`. Only pause to clarify when two or more items are genuinely close — one short question, not a confirmation ritual. When nothing on the menu fits, just continue the conversation; chat, clarifying questions, and `bmad-help` are always fair game.
|
|
73
|
-
|
|
74
|
-
From here, Huldah stays active — persona, persistent facts, `{agent.icon}` prefix, and `{communication_language}` carry into every turn until the user dismisses her.
|
|
8
|
+
Read the [execution guide](../../shared/execution.md). Help a reader perform a
|
|
9
|
+
task using the behavior the project actually implements. Prefer concrete nouns,
|
|
10
|
+
short examples and a clear next action. Match the user's document language and
|
|
11
|
+
the repository's documentation conventions.
|
|
12
|
+
|
|
13
|
+
## Activation and routes
|
|
14
|
+
|
|
15
|
+
Identify the audience, their task and the source of truth. If the request is
|
|
16
|
+
clear, begin immediately.
|
|
17
|
+
|
|
18
|
+
| Request | Route or action |
|
|
19
|
+
| ----------------------------------- | -------------------------------------------------------------- |
|
|
20
|
+
| Document a repository | [Document project](document-project.md) |
|
|
21
|
+
| Improve wording | [Prose review](../utilities/editorial-review-prose.md) |
|
|
22
|
+
| Improve document organization | [Structure review](../utilities/editorial-review-structure.md) |
|
|
23
|
+
| Create a documentation index | [Index documents](../utilities/index-docs.md) |
|
|
24
|
+
| Write, explain, diagram or validate | Use the procedure below |
|
|
25
|
+
|
|
26
|
+
## Direct writing and explanation
|
|
27
|
+
|
|
28
|
+
1. Read the relevant implementation, existing documentation and actual examples.
|
|
29
|
+
Identify the reader's prerequisites and the supported product version.
|
|
30
|
+
2. Outline the shortest path from the reader's starting point to their result.
|
|
31
|
+
Explain unfamiliar concepts where needed to complete that path.
|
|
32
|
+
3. Write the requested document or answer. For commands, include the working
|
|
33
|
+
directory, necessary inputs and expected result. Mark placeholders explicitly.
|
|
34
|
+
4. Check paths, symbols and options against the implementation. Run safe local
|
|
35
|
+
examples when useful and authorized; label examples that were not executed.
|
|
36
|
+
Keep credentials and personal data out of sample output.
|
|
37
|
+
5. Report changed documents and remaining verification gaps. Updating a document
|
|
38
|
+
does not authorize publishing it or changing unrelated product behavior.
|
|
39
|
+
|
|
40
|
+
## Diagrams and validation
|
|
41
|
+
|
|
42
|
+
Use Mermaid when a small flow, dependency graph or sequence clarifies the
|
|
43
|
+
subject. Identify the real components and transitions from the source before
|
|
44
|
+
drawing them. Explain the diagram in text and keep unknown relationships marked
|
|
45
|
+
as unknown. A diagram is descriptive unless it was checked against runtime
|
|
46
|
+
observations. If a renderer is available, validate syntax and inspect the result;
|
|
47
|
+
otherwise record that rendering was not checked.
|
|
48
|
+
|
|
49
|
+
For a documentation review, check the reader's path in order: prerequisites,
|
|
50
|
+
commands or decisions, expected outputs, recovery and next step. Cite the exact
|
|
51
|
+
source for discrepancies. Distinguish incorrect instructions from editorial
|
|
52
|
+
preferences, and preserve user-authored content unrelated to the request.
|
|
53
|
+
|
|
54
|
+
## Output and continuation
|
|
55
|
+
|
|
56
|
+
Deliver the requested document plus a compact report of source paths, source
|
|
57
|
+
version or commit when known, examples checked and unresolved questions. On
|
|
58
|
+
resume, compare implementation changes before reusing an explanation. Repair
|
|
59
|
+
affected examples and links; do not present old command output as a new test.
|