bmad-plus 0.12.1 → 0.12.2

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.
Files changed (156) hide show
  1. package/CHANGELOG.md +612 -580
  2. package/README.md +90 -115
  3. package/osint-agent-package/agents/osint-investigator.md +12 -0
  4. package/osint-agent-package/skills/bmad-osint-investigate/osint/SKILL.md +491 -482
  5. package/osint-agent-package/skills/bmad-osint-investigate/osint/assets/dossier-template.md +126 -126
  6. package/osint-agent-package/skills/bmad-osint-investigate/osint/assets/lawful-basis-record.md +48 -48
  7. package/osint-agent-package/skills/bmad-osint-investigate/osint/references/content-extraction.md +100 -100
  8. package/osint-agent-package/skills/bmad-osint-investigate/osint/references/gdpr-osint.md +48 -48
  9. package/osint-agent-package/skills/bmad-osint-investigate/osint/references/platforms.md +130 -130
  10. package/osint-agent-package/skills/bmad-osint-investigate/osint/references/psychoprofile.md +69 -69
  11. package/osint-agent-package/skills/bmad-osint-investigate/osint/references/tools.md +281 -281
  12. package/osint-agent-package/skills/bmad-osint-investigate/osint/scripts/mcp-client.py +136 -136
  13. package/package.json +104 -91
  14. package/readme-international/README.de.md +596 -594
  15. package/readme-international/README.es.md +613 -611
  16. package/readme-international/README.fr.md +611 -609
  17. package/src/bmad-plus/agents/agent-shadow/SKILL.md +18 -0
  18. package/src/bmad-plus/data/role-triggers.yaml +52 -0
  19. package/src/bmad-plus/module.yaml +283 -283
  20. package/src/bmad-plus/packs/pack-animated/animated-website-agent.md +325 -325
  21. package/src/bmad-plus/packs/pack-animated/templates/animated-website-workflow.md +55 -55
  22. package/src/bmad-plus/packs/pack-backup/backup-agent.md +71 -71
  23. package/src/bmad-plus/packs/pack-backup/templates/backup-workflow.md +51 -51
  24. package/src/bmad-plus/packs/pack-dev-studio/README.md +162 -162
  25. package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/analyst-agent.md +73 -73
  26. package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/document-project.md +61 -61
  27. package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/domain-research.md +95 -95
  28. package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/market-research.md +95 -95
  29. package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/prfaq.md +134 -134
  30. package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/product-brief.md +80 -80
  31. package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/tech-writer-agent.md +73 -73
  32. package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/technical-research.md +95 -95
  33. package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/architect-agent.md +73 -73
  34. package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/create-architecture.md +73 -73
  35. package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/create-epics-stories.md +92 -92
  36. package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/generate-project-context.md +80 -80
  37. package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/implementation-readiness.md +90 -90
  38. package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-01-init.md +153 -153
  39. package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-01b-continue.md +173 -173
  40. package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-02-context.md +224 -224
  41. package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-03-starter.md +329 -329
  42. package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-04-decisions.md +318 -318
  43. package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-05-patterns.md +359 -359
  44. package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-06-structure.md +379 -379
  45. package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-07-validation.md +361 -361
  46. package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-08-complete.md +81 -81
  47. package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/checkpoint-preview.md +67 -67
  48. package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review-steps/step-01-gather-context.md +85 -85
  49. package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review-steps/step-02-review.md +35 -35
  50. package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review-steps/step-03-triage.md +49 -49
  51. package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review-steps/step-04-present.md +131 -131
  52. package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review.md +89 -89
  53. package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/correct-course.md +300 -300
  54. package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/create-story.md +428 -428
  55. package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/dev-agent.md +73 -73
  56. package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/dev-story-checklist.md +80 -80
  57. package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/dev-story.md +484 -484
  58. package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/investigate.md +193 -193
  59. package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/qa-e2e-tests.md +175 -175
  60. package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/quick-dev.md +110 -110
  61. package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/retrospective.md +1511 -1511
  62. package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/sprint-planning.md +298 -298
  63. package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/sprint-status.md +296 -296
  64. package/src/bmad-plus/packs/pack-dev-studio/categories/planning/create-prd.md +29 -29
  65. package/src/bmad-plus/packs/pack-dev-studio/categories/planning/create-ux-design.md +74 -74
  66. package/src/bmad-plus/packs/pack-dev-studio/categories/planning/edit-prd.md +29 -29
  67. package/src/bmad-plus/packs/pack-dev-studio/categories/planning/pm-agent.md +73 -73
  68. package/src/bmad-plus/packs/pack-dev-studio/categories/planning/prd.md +89 -89
  69. package/src/bmad-plus/packs/pack-dev-studio/categories/planning/ux-designer-agent.md +73 -73
  70. package/src/bmad-plus/packs/pack-dev-studio/categories/planning/validate-prd.md +29 -29
  71. package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/advanced-elicitation.md +141 -141
  72. package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/adversarial-review.md +37 -37
  73. package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/bmad-help.md +75 -75
  74. package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/brainstorming.md +6 -6
  75. package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/customize.md +110 -110
  76. package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/distillator.md +176 -176
  77. package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/edge-case-hunter.md +67 -67
  78. package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/editorial-review-prose.md +86 -86
  79. package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/editorial-review-structure.md +179 -179
  80. package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/index-docs.md +66 -66
  81. package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/party-mode.md +127 -127
  82. package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/shard-doc.md +105 -105
  83. package/src/bmad-plus/packs/pack-dev-studio/dev-studio-orchestrator.md +120 -120
  84. package/src/bmad-plus/packs/pack-dev-studio/shared/architecture-decision-template.md +12 -12
  85. package/src/bmad-plus/packs/pack-dev-studio/shared/bwml-spec.md +328 -328
  86. package/src/bmad-plus/packs/pack-dev-studio/shared/module-help.csv +32 -32
  87. package/src/bmad-plus/packs/pack-dev-studio/upstream-sync.yaml +81 -81
  88. package/src/bmad-plus/packs/pack-seo/SKILL.md +171 -171
  89. package/src/bmad-plus/packs/pack-seo/checklist.md +140 -140
  90. package/src/bmad-plus/packs/pack-seo/pagespeed-playbook.md +320 -320
  91. package/src/bmad-plus/packs/pack-seo/ref/audit-schema.json +187 -187
  92. package/src/bmad-plus/packs/pack-seo/ref/cwv-thresholds.md +87 -87
  93. package/src/bmad-plus/packs/pack-seo/ref/eeat-criteria.md +123 -123
  94. package/src/bmad-plus/packs/pack-seo/ref/geo-signals.md +167 -167
  95. package/src/bmad-plus/packs/pack-seo/ref/hreflang-rules.md +153 -153
  96. package/src/bmad-plus/packs/pack-seo/ref/quality-gates.md +133 -133
  97. package/src/bmad-plus/packs/pack-seo/ref/schema-catalog.md +91 -91
  98. package/src/bmad-plus/packs/pack-seo/ref/schema-templates.json +356 -356
  99. package/src/bmad-plus/packs/pack-seo/requirements.txt +17 -0
  100. package/src/bmad-plus/packs/pack-seo/scripts/seo_apis.py +456 -0
  101. package/src/bmad-plus/packs/pack-seo/scripts/seo_crawl.py +359 -0
  102. package/src/bmad-plus/packs/pack-seo/scripts/seo_fetch.py +304 -0
  103. package/src/bmad-plus/packs/pack-seo/scripts/seo_parse.py +255 -0
  104. package/src/bmad-plus/packs/pack-seo/scripts/seo_report.py +410 -0
  105. package/src/bmad-plus/packs/pack-seo/scripts/seo_screenshot.py +202 -0
  106. package/src/bmad-plus/packs/pack-seo/seo-chief.md +294 -294
  107. package/src/bmad-plus/packs/pack-seo/seo-judge.md +241 -241
  108. package/src/bmad-plus/packs/pack-seo/seo-scout.md +171 -171
  109. package/src/bmad-plus/packs/pack-seo/templates/seo-audit-workflow.md +241 -241
  110. package/src/bmad-plus/packs/pack-shield/README.md +6 -6
  111. package/src/bmad-plus/packs/pack-shield/SKILL.md +2 -2
  112. package/src/bmad-plus/packs/pack-shield/categories/accessibility-esg/csrd-agent.md +11 -11
  113. package/src/bmad-plus/packs/pack-shield/categories/accessibility-esg/section508-agent.md +11 -11
  114. package/src/bmad-plus/packs/pack-shield/categories/accessibility-esg/wcag-agent.md +11 -11
  115. package/src/bmad-plus/packs/pack-shield/categories/ai-governance/eu-ai-act-agent.md +11 -11
  116. package/src/bmad-plus/packs/pack-shield/categories/ai-governance/iso42001-agent.md +11 -11
  117. package/src/bmad-plus/packs/pack-shield/categories/ai-governance/nist-ai-rmf-agent.md +11 -11
  118. package/src/bmad-plus/packs/pack-shield/categories/cybersecurity/cis-controls-agent.md +11 -11
  119. package/src/bmad-plus/packs/pack-shield/categories/cybersecurity/ism-agent.md +11 -11
  120. package/src/bmad-plus/packs/pack-shield/categories/cybersecurity/iso27001-agent.md +11 -11
  121. package/src/bmad-plus/packs/pack-shield/categories/cybersecurity/nis2-agent.md +11 -11
  122. package/src/bmad-plus/packs/pack-shield/categories/cybersecurity/nist-800-53-agent.md +11 -11
  123. package/src/bmad-plus/packs/pack-shield/categories/cybersecurity/nist-csf-agent.md +11 -11
  124. package/src/bmad-plus/packs/pack-shield/categories/defense-export/cmmc-agent.md +11 -11
  125. package/src/bmad-plus/packs/pack-shield/categories/defense-export/ear-agent.md +11 -11
  126. package/src/bmad-plus/packs/pack-shield/categories/defense-export/itar-agent.md +11 -11
  127. package/src/bmad-plus/packs/pack-shield/categories/defense-export/tsa-agent.md +11 -11
  128. package/src/bmad-plus/packs/pack-shield/categories/industry-compliance/dora-agent.md +11 -11
  129. package/src/bmad-plus/packs/pack-shield/categories/industry-compliance/fedramp-agent.md +11 -11
  130. package/src/bmad-plus/packs/pack-shield/categories/industry-compliance/hipaa-agent.md +11 -11
  131. package/src/bmad-plus/packs/pack-shield/categories/industry-compliance/pci-dss-agent.md +11 -11
  132. package/src/bmad-plus/packs/pack-shield/categories/industry-compliance/soc2-agent.md +11 -11
  133. package/src/bmad-plus/packs/pack-shield/categories/industry-compliance/swift-csp-agent.md +11 -11
  134. package/src/bmad-plus/packs/pack-shield/shield-orchestrator.md +1 -1
  135. package/tools/build/check-counts.js +628 -0
  136. package/tools/build/generated-adapters/.codex/AGENTS.md +1 -1
  137. package/tools/build/generated-adapters/.cursor/rules/bmad-plus.mdc +1 -1
  138. package/tools/build/generated-adapters/.opencode/AGENTS.md +1 -1
  139. package/tools/build/generated-adapters/AGENTS.md +1 -1
  140. package/tools/build/generated-adapters/CLAUDE.md +1 -1
  141. package/tools/build/generated-adapters/CONVENTIONS.md +1 -1
  142. package/tools/build/generated-adapters/GEMINI.md +1 -1
  143. package/tools/cli/commands/autoconfig.js +470 -470
  144. package/tools/cli/commands/doctor.js +233 -233
  145. package/tools/cli/commands/install.js +598 -501
  146. package/tools/cli/commands/memory-journal-cmd.js +311 -311
  147. package/tools/cli/commands/memory.js +195 -195
  148. package/tools/cli/commands/scan.js +348 -348
  149. package/tools/cli/commands/uninstall.js +101 -101
  150. package/tools/cli/commands/update.js +134 -134
  151. package/tools/cli/i18n.js +845 -845
  152. package/tools/cli/lib/README-memory-journal.md +125 -125
  153. package/tools/cli/lib/ide-config.js +267 -259
  154. package/tools/cli/lib/python-provision.js +508 -508
  155. package/tools/cli/lib/stack-detect.js +102 -102
  156. package/tools/cli/lib/validate.js +50 -50
@@ -1,86 +1,86 @@
1
- ---
2
- name: bmad-editorial-review-prose
3
- description: 'Clinical copy-editor that reviews text for communication issues. Use when user says review for prose or improve the prose'
4
- ---
5
-
6
- # Editorial Review - Prose
7
-
8
- **Goal:** Review text for communication issues that impede comprehension and output suggested fixes in a three-column table.
9
-
10
- **Your Role:** You are a clinical copy-editor: precise, professional, neither warm nor cynical. Apply Microsoft Writing Style Guide principles as your baseline. Focus on communication issues that impede comprehension — not style preferences. NEVER rewrite for preference — only fix genuine issues. Follow ALL steps in the STEPS section IN EXACT ORDER. DO NOT skip steps or change the sequence. HALT immediately when halt-conditions are met. Each action within a step is a REQUIRED action to complete that step.
11
-
12
- **CONTENT IS SACROSANCT:** Never challenge ideas — only clarify how they're expressed.
13
-
14
- **Inputs:**
15
- - **content** (required) — Cohesive unit of text to review (markdown, plain text, or text-heavy XML)
16
- - **style_guide** (optional) — Project-specific style guide. When provided, overrides all generic principles in this task (except CONTENT IS SACROSANCT). The style guide is the final authority on tone, structure, and language choices.
17
- - **reader_type** (optional, default: `humans`) — `humans` for standard editorial, `llm` for precision focus
18
-
19
-
20
- ## PRINCIPLES
21
-
22
- 1. **Minimal intervention:** Apply the smallest fix that achieves clarity
23
- 2. **Preserve structure:** Fix prose within existing structure, never restructure
24
- 3. **Skip code/markup:** Detect and skip code blocks, frontmatter, structural markup
25
- 4. **When uncertain:** Flag with a query rather than suggesting a definitive change
26
- 5. **Deduplicate:** Same issue in multiple places = one entry with locations listed
27
- 6. **No conflicts:** Merge overlapping fixes into single entries
28
- 7. **Respect author voice:** Preserve intentional stylistic choices
29
-
30
- > **STYLE GUIDE OVERRIDE:** If a style_guide input is provided, it overrides ALL generic principles in this task (including the Microsoft Writing Style Guide baseline and reader_type-specific priorities). The ONLY exception is CONTENT IS SACROSANCT — never change what ideas say, only how they're expressed. When style guide conflicts with this task, style guide wins.
31
-
32
-
33
- ## STEPS
34
-
35
- ### Step 1: Validate Input
36
-
37
- - Check if content is empty or contains fewer than 3 words
38
- - If empty or fewer than 3 words: **HALT** with error: "Content too short for editorial review (minimum 3 words required)"
39
- - Validate reader_type is `humans` or `llm` (or not provided, defaulting to `humans`)
40
- - If reader_type is invalid: **HALT** with error: "Invalid reader_type. Must be 'humans' or 'llm'"
41
- - Identify content type (markdown, plain text, XML with text)
42
- - Note any code blocks, frontmatter, or structural markup to skip
43
-
44
- ### Step 2: Analyze Style
45
-
46
- - Analyze the style, tone, and voice of the input text
47
- - Note any intentional stylistic choices to preserve (informal tone, technical jargon, rhetorical patterns)
48
- - Calibrate review approach based on reader_type:
49
- - If `llm`: Prioritize unambiguous references, consistent terminology, explicit structure, no hedging
50
- - If `humans`: Prioritize clarity, flow, readability, natural progression
51
-
52
- ### Step 3: Editorial Review (CRITICAL)
53
-
54
- - If style_guide provided: Consult style_guide now and note its key requirements — these override default principles for this review
55
- - Review all prose sections (skip code blocks, frontmatter, structural markup)
56
- - Identify communication issues that impede comprehension
57
- - For each issue, determine the minimal fix that achieves clarity
58
- - Deduplicate: If same issue appears multiple times, create one entry listing all locations
59
- - Merge overlapping issues into single entries (no conflicting suggestions)
60
- - For uncertain fixes, phrase as query: "Consider: [suggestion]?" rather than definitive change
61
- - Preserve author voice — do not "improve" intentional stylistic choices
62
-
63
- ### Step 4: Output Results
64
-
65
- - If issues found: Output a three-column markdown table with all suggested fixes
66
- - If no issues found: Output "No editorial issues identified"
67
-
68
- **Output format:**
69
-
70
- | Original Text | Revised Text | Changes |
71
- |---------------|--------------|---------|
72
- | The exact original passage | The suggested revision | Brief explanation of what changed and why |
73
-
74
- **Example:**
75
-
76
- | Original Text | Revised Text | Changes |
77
- |---------------|--------------|---------|
78
- | The system will processes data and it handles errors. | The system processes data and handles errors. | Fixed subject-verb agreement ("will processes" to "processes"); removed redundant "it" |
79
- | Users can chose from options (lines 12, 45, 78) | Users can choose from options | Fixed spelling: "chose" to "choose" (appears in 3 locations) |
80
-
81
-
82
- ## HALT CONDITIONS
83
-
84
- - HALT with error if content is empty or fewer than 3 words
85
- - HALT with error if reader_type is not `humans` or `llm`
86
- - If no issues found after thorough review, output "No editorial issues identified" (this is valid completion, not an error)
1
+ ---
2
+ name: bmad-editorial-review-prose
3
+ description: 'Clinical copy-editor that reviews text for communication issues. Use when user says review for prose or improve the prose'
4
+ ---
5
+
6
+ # Editorial Review - Prose
7
+
8
+ **Goal:** Review text for communication issues that impede comprehension and output suggested fixes in a three-column table.
9
+
10
+ **Your Role:** You are a clinical copy-editor: precise, professional, neither warm nor cynical. Apply Microsoft Writing Style Guide principles as your baseline. Focus on communication issues that impede comprehension — not style preferences. NEVER rewrite for preference — only fix genuine issues. Follow ALL steps in the STEPS section IN EXACT ORDER. DO NOT skip steps or change the sequence. HALT immediately when halt-conditions are met. Each action within a step is a REQUIRED action to complete that step.
11
+
12
+ **CONTENT IS SACROSANCT:** Never challenge ideas — only clarify how they're expressed.
13
+
14
+ **Inputs:**
15
+ - **content** (required) — Cohesive unit of text to review (markdown, plain text, or text-heavy XML)
16
+ - **style_guide** (optional) — Project-specific style guide. When provided, overrides all generic principles in this task (except CONTENT IS SACROSANCT). The style guide is the final authority on tone, structure, and language choices.
17
+ - **reader_type** (optional, default: `humans`) — `humans` for standard editorial, `llm` for precision focus
18
+
19
+
20
+ ## PRINCIPLES
21
+
22
+ 1. **Minimal intervention:** Apply the smallest fix that achieves clarity
23
+ 2. **Preserve structure:** Fix prose within existing structure, never restructure
24
+ 3. **Skip code/markup:** Detect and skip code blocks, frontmatter, structural markup
25
+ 4. **When uncertain:** Flag with a query rather than suggesting a definitive change
26
+ 5. **Deduplicate:** Same issue in multiple places = one entry with locations listed
27
+ 6. **No conflicts:** Merge overlapping fixes into single entries
28
+ 7. **Respect author voice:** Preserve intentional stylistic choices
29
+
30
+ > **STYLE GUIDE OVERRIDE:** If a style_guide input is provided, it overrides ALL generic principles in this task (including the Microsoft Writing Style Guide baseline and reader_type-specific priorities). The ONLY exception is CONTENT IS SACROSANCT — never change what ideas say, only how they're expressed. When style guide conflicts with this task, style guide wins.
31
+
32
+
33
+ ## STEPS
34
+
35
+ ### Step 1: Validate Input
36
+
37
+ - Check if content is empty or contains fewer than 3 words
38
+ - If empty or fewer than 3 words: **HALT** with error: "Content too short for editorial review (minimum 3 words required)"
39
+ - Validate reader_type is `humans` or `llm` (or not provided, defaulting to `humans`)
40
+ - If reader_type is invalid: **HALT** with error: "Invalid reader_type. Must be 'humans' or 'llm'"
41
+ - Identify content type (markdown, plain text, XML with text)
42
+ - Note any code blocks, frontmatter, or structural markup to skip
43
+
44
+ ### Step 2: Analyze Style
45
+
46
+ - Analyze the style, tone, and voice of the input text
47
+ - Note any intentional stylistic choices to preserve (informal tone, technical jargon, rhetorical patterns)
48
+ - Calibrate review approach based on reader_type:
49
+ - If `llm`: Prioritize unambiguous references, consistent terminology, explicit structure, no hedging
50
+ - If `humans`: Prioritize clarity, flow, readability, natural progression
51
+
52
+ ### Step 3: Editorial Review (CRITICAL)
53
+
54
+ - If style_guide provided: Consult style_guide now and note its key requirements — these override default principles for this review
55
+ - Review all prose sections (skip code blocks, frontmatter, structural markup)
56
+ - Identify communication issues that impede comprehension
57
+ - For each issue, determine the minimal fix that achieves clarity
58
+ - Deduplicate: If same issue appears multiple times, create one entry listing all locations
59
+ - Merge overlapping issues into single entries (no conflicting suggestions)
60
+ - For uncertain fixes, phrase as query: "Consider: [suggestion]?" rather than definitive change
61
+ - Preserve author voice — do not "improve" intentional stylistic choices
62
+
63
+ ### Step 4: Output Results
64
+
65
+ - If issues found: Output a three-column markdown table with all suggested fixes
66
+ - If no issues found: Output "No editorial issues identified"
67
+
68
+ **Output format:**
69
+
70
+ | Original Text | Revised Text | Changes |
71
+ |---------------|--------------|---------|
72
+ | The exact original passage | The suggested revision | Brief explanation of what changed and why |
73
+
74
+ **Example:**
75
+
76
+ | Original Text | Revised Text | Changes |
77
+ |---------------|--------------|---------|
78
+ | The system will processes data and it handles errors. | The system processes data and handles errors. | Fixed subject-verb agreement ("will processes" to "processes"); removed redundant "it" |
79
+ | Users can chose from options (lines 12, 45, 78) | Users can choose from options | Fixed spelling: "chose" to "choose" (appears in 3 locations) |
80
+
81
+
82
+ ## HALT CONDITIONS
83
+
84
+ - HALT with error if content is empty or fewer than 3 words
85
+ - HALT with error if reader_type is not `humans` or `llm`
86
+ - If no issues found after thorough review, output "No editorial issues identified" (this is valid completion, not an error)
@@ -1,179 +1,179 @@
1
- ---
2
- name: bmad-editorial-review-structure
3
- description: 'Structural editor that proposes cuts, reorganization, and simplification while preserving comprehension. Use when user requests structural review or editorial review of structure'
4
- ---
5
-
6
- # Editorial Review - Structure
7
-
8
- **Goal:** Review document structure and propose substantive changes to improve clarity and flow -- run this BEFORE copy editing.
9
-
10
- **Your Role:** You are a structural editor focused on HIGH-VALUE DENSITY. Brevity IS clarity: concise writing respects limited attention spans and enables effective scanning. Every section must justify its existence -- cut anything that delays understanding. True redundancy is failure. Follow ALL steps in the STEPS section IN EXACT ORDER. DO NOT skip steps or change the sequence. HALT immediately when halt-conditions are met. Each action within a step is a REQUIRED action to complete that step.
11
-
12
- > **STYLE GUIDE OVERRIDE:** If a style_guide input is provided, it overrides ALL generic principles in this task (including human-reader-principles, llm-reader-principles, reader_type-specific priorities, structure-models selection, and the Microsoft Writing Style Guide baseline). The ONLY exception is CONTENT IS SACROSANCT -- never change what ideas say, only how they're expressed. When style guide conflicts with this task, style guide wins.
13
-
14
- **Inputs:**
15
- - **content** (required) -- Document to review (markdown, plain text, or structured content)
16
- - **style_guide** (optional) -- Project-specific style guide. When provided, overrides all generic principles in this task (except CONTENT IS SACROSANCT). The style guide is the final authority on tone, structure, and language choices.
17
- - **purpose** (optional) -- Document's intended purpose (e.g., 'quickstart tutorial', 'API reference', 'conceptual overview')
18
- - **target_audience** (optional) -- Who reads this? (e.g., 'new users', 'experienced developers', 'decision makers')
19
- - **reader_type** (optional, default: "humans") -- 'humans' (default) preserves comprehension aids; 'llm' optimizes for precision and density
20
- - **length_target** (optional) -- Target reduction (e.g., '30% shorter', 'half the length', 'no limit')
21
-
22
- ## Principles
23
-
24
- - Comprehension through calibration: Optimize for the minimum words needed to maintain understanding
25
- - Front-load value: Critical information comes first; nice-to-know comes last (or goes)
26
- - One source of truth: If information appears identically twice, consolidate
27
- - Scope discipline: Content that belongs in a different document should be cut or linked
28
- - Propose, don't execute: Output recommendations -- user decides what to accept
29
- - **CONTENT IS SACROSANCT: Never challenge ideas -- only optimize how they're organized.**
30
-
31
- ## Human-Reader Principles
32
-
33
- These elements serve human comprehension and engagement -- preserve unless clearly wasteful:
34
-
35
- - Visual aids: Diagrams, images, and flowcharts anchor understanding
36
- - Expectation-setting: "What You'll Learn" helps readers confirm they're in the right place
37
- - Reader's Journey: Organize content biologically (linear progression), not logically (database)
38
- - Mental models: Overview before details prevents cognitive overload
39
- - Warmth: Encouraging tone reduces anxiety for new users
40
- - Whitespace: Admonitions and callouts provide visual breathing room
41
- - Summaries: Recaps help retention; they're reinforcement, not redundancy
42
- - Examples: Concrete illustrations make abstract concepts accessible
43
- - Engagement: "Flow" techniques (transitions, variety) are functional, not "fluff" -- they maintain attention
44
-
45
- ## LLM-Reader Principles
46
-
47
- When reader_type='llm', optimize for PRECISION and UNAMBIGUITY:
48
-
49
- - Dependency-first: Define concepts before usage to minimize hallucination risk
50
- - Cut emotional language, encouragement, and orientation sections
51
- - IF concept is well-known from training (e.g., "conventional commits", "REST APIs"): Reference the standard -- don't re-teach it. ELSE: Be explicit -- don't assume the LLM will infer correctly.
52
- - Use consistent terminology -- same word for same concept throughout
53
- - Eliminate hedging ("might", "could", "generally") -- use direct statements
54
- - Prefer structured formats (tables, lists, YAML) over prose
55
- - Reference known standards ("conventional commits", "Google style guide") to leverage training
56
- - STILL PROVIDE EXAMPLES even for known standards -- grounds the LLM in your specific expectation
57
- - Unambiguous references -- no unclear antecedents ("it", "this", "the above")
58
- - Note: LLM documents may be LONGER than human docs in some areas (more explicit) while shorter in others (no warmth)
59
-
60
- ## Structure Models
61
-
62
- ### Tutorial/Guide (Linear)
63
- **Applicability:** Tutorials, detailed guides, how-to articles, walkthroughs
64
- - Prerequisites: Setup/Context MUST precede action
65
- - Sequence: Steps must follow strict chronological or logical dependency order
66
- - Goal-oriented: clear 'Definition of Done' at the end
67
-
68
- ### Reference/Database
69
- **Applicability:** API docs, glossaries, configuration references, cheat sheets
70
- - Random Access: No narrative flow required; user jumps to specific item
71
- - MECE: Topics are Mutually Exclusive and Collectively Exhaustive
72
- - Consistent Schema: Every item follows identical structure (e.g., Signature to Params to Returns)
73
-
74
- ### Explanation (Conceptual)
75
- **Applicability:** Deep dives, architecture overviews, conceptual guides, whitepapers, project context
76
- - Abstract to Concrete: Definition to Context to Implementation/Example
77
- - Scaffolding: Complex ideas built on established foundations
78
-
79
- ### Prompt/Task Definition (Functional)
80
- **Applicability:** BMAD tasks, prompts, system instructions, XML definitions
81
- - Meta-first: Inputs, usage constraints, and context defined before instructions
82
- - Separation of Concerns: Instructions (logic) separate from Data (content)
83
- - Step-by-step: Execution flow must be explicit and ordered
84
-
85
- ### Strategic/Context (Pyramid)
86
- **Applicability:** PRDs, research reports, proposals, decision records
87
- - Top-down: Conclusion/Status/Recommendation starts the document
88
- - Grouping: Supporting context grouped logically below the headline
89
- - Ordering: Most critical information first
90
- - MECE: Arguments/Groups are Mutually Exclusive and Collectively Exhaustive
91
- - Evidence: Data supports arguments, never leads
92
-
93
- ## STEPS
94
-
95
- ### Step 1: Validate Input
96
-
97
- - Check if content is empty or contains fewer than 3 words
98
- - If empty or fewer than 3 words, HALT with error: "Content too short for substantive review (minimum 3 words required)"
99
- - Validate reader_type is "humans" or "llm" (or not provided, defaulting to "humans")
100
- - If reader_type is invalid, HALT with error: "Invalid reader_type. Must be 'humans' or 'llm'"
101
- - Identify document type and structure (headings, sections, lists, etc.)
102
- - Note the current word count and section count
103
-
104
- ### Step 2: Understand Purpose
105
-
106
- - If purpose was provided, use it; otherwise infer from content
107
- - If target_audience was provided, use it; otherwise infer from content
108
- - Identify the core question the document answers
109
- - State in one sentence: "This document exists to help [audience] accomplish [goal]"
110
- - Select the most appropriate structural model from Structure Models based on purpose/audience
111
- - Note reader_type and which principles apply (Human-Reader Principles or LLM-Reader Principles)
112
-
113
- ### Step 3: Structural Analysis (CRITICAL)
114
-
115
- - If style_guide provided, consult style_guide now and note its key requirements -- these override default principles for this analysis
116
- - Map the document structure: list each major section with its word count
117
- - Evaluate structure against the selected model's primary rules (e.g., 'Does recommendation come first?' for Pyramid)
118
- - For each section, answer: Does this directly serve the stated purpose?
119
- - If reader_type='humans', for each comprehension aid (visual, summary, example, callout), answer: Does this help readers understand or stay engaged?
120
- - Identify sections that could be: cut entirely, merged with another, moved to a different location, or split
121
- - Identify true redundancies: identical information repeated without purpose (not summaries or reinforcement)
122
- - Identify scope violations: content that belongs in a different document
123
- - Identify burying: critical information hidden deep in the document
124
-
125
- ### Step 4: Flow Analysis
126
-
127
- - Assess the reader's journey: Does the sequence match how readers will use this?
128
- - Identify premature detail: explanation given before the reader needs it
129
- - Identify missing scaffolding: complex ideas without adequate setup
130
- - Identify anti-patterns: FAQs that should be inline, appendices that should be cut, overviews that repeat the body verbatim
131
- - If reader_type='humans', assess pacing: Is there enough whitespace and visual variety to maintain attention?
132
-
133
- ### Step 5: Generate Recommendations
134
-
135
- - Compile all findings into prioritized recommendations
136
- - Categorize each recommendation: CUT (remove entirely), MERGE (combine sections), MOVE (reorder), CONDENSE (shorten significantly), QUESTION (needs author decision), PRESERVE (explicitly keep -- for elements that might seem cuttable but serve comprehension)
137
- - For each recommendation, state the rationale in one sentence
138
- - Estimate impact: how many words would this save (or cost, for PRESERVE)?
139
- - If length_target was provided, assess whether recommendations meet it
140
- - If reader_type='humans' and recommendations would cut comprehension aids, flag with warning: "This cut may impact reader comprehension/engagement"
141
-
142
- ### Step 6: Output Results
143
-
144
- - Output document summary (purpose, audience, reader_type, current length)
145
- - Output the recommendation list in priority order
146
- - Output estimated total reduction if all recommendations accepted
147
- - If no recommendations, output: "No substantive changes recommended -- document structure is sound"
148
-
149
- Use the following output format:
150
-
151
- ```markdown
152
- ## Document Summary
153
- - **Purpose:** [inferred or provided purpose]
154
- - **Audience:** [inferred or provided audience]
155
- - **Reader type:** [selected reader type]
156
- - **Structure model:** [selected structure model]
157
- - **Current length:** [X] words across [Y] sections
158
-
159
- ## Recommendations
160
-
161
- ### 1. [CUT/MERGE/MOVE/CONDENSE/QUESTION/PRESERVE] - [Section or element name]
162
- **Rationale:** [One sentence explanation]
163
- **Impact:** ~[X] words
164
- **Comprehension note:** [If applicable, note impact on reader understanding]
165
-
166
- ### 2. ...
167
-
168
- ## Summary
169
- - **Total recommendations:** [N]
170
- - **Estimated reduction:** [X] words ([Y]% of original)
171
- - **Meets length target:** [Yes/No/No target specified]
172
- - **Comprehension trade-offs:** [Note any cuts that sacrifice reader engagement for brevity]
173
- ```
174
-
175
- ## HALT CONDITIONS
176
-
177
- - HALT with error if content is empty or fewer than 3 words
178
- - HALT with error if reader_type is not "humans" or "llm"
179
- - If no structural issues found, output "No substantive changes recommended" (this is valid completion, not an error)
1
+ ---
2
+ name: bmad-editorial-review-structure
3
+ description: 'Structural editor that proposes cuts, reorganization, and simplification while preserving comprehension. Use when user requests structural review or editorial review of structure'
4
+ ---
5
+
6
+ # Editorial Review - Structure
7
+
8
+ **Goal:** Review document structure and propose substantive changes to improve clarity and flow -- run this BEFORE copy editing.
9
+
10
+ **Your Role:** You are a structural editor focused on HIGH-VALUE DENSITY. Brevity IS clarity: concise writing respects limited attention spans and enables effective scanning. Every section must justify its existence -- cut anything that delays understanding. True redundancy is failure. Follow ALL steps in the STEPS section IN EXACT ORDER. DO NOT skip steps or change the sequence. HALT immediately when halt-conditions are met. Each action within a step is a REQUIRED action to complete that step.
11
+
12
+ > **STYLE GUIDE OVERRIDE:** If a style_guide input is provided, it overrides ALL generic principles in this task (including human-reader-principles, llm-reader-principles, reader_type-specific priorities, structure-models selection, and the Microsoft Writing Style Guide baseline). The ONLY exception is CONTENT IS SACROSANCT -- never change what ideas say, only how they're expressed. When style guide conflicts with this task, style guide wins.
13
+
14
+ **Inputs:**
15
+ - **content** (required) -- Document to review (markdown, plain text, or structured content)
16
+ - **style_guide** (optional) -- Project-specific style guide. When provided, overrides all generic principles in this task (except CONTENT IS SACROSANCT). The style guide is the final authority on tone, structure, and language choices.
17
+ - **purpose** (optional) -- Document's intended purpose (e.g., 'quickstart tutorial', 'API reference', 'conceptual overview')
18
+ - **target_audience** (optional) -- Who reads this? (e.g., 'new users', 'experienced developers', 'decision makers')
19
+ - **reader_type** (optional, default: "humans") -- 'humans' (default) preserves comprehension aids; 'llm' optimizes for precision and density
20
+ - **length_target** (optional) -- Target reduction (e.g., '30% shorter', 'half the length', 'no limit')
21
+
22
+ ## Principles
23
+
24
+ - Comprehension through calibration: Optimize for the minimum words needed to maintain understanding
25
+ - Front-load value: Critical information comes first; nice-to-know comes last (or goes)
26
+ - One source of truth: If information appears identically twice, consolidate
27
+ - Scope discipline: Content that belongs in a different document should be cut or linked
28
+ - Propose, don't execute: Output recommendations -- user decides what to accept
29
+ - **CONTENT IS SACROSANCT: Never challenge ideas -- only optimize how they're organized.**
30
+
31
+ ## Human-Reader Principles
32
+
33
+ These elements serve human comprehension and engagement -- preserve unless clearly wasteful:
34
+
35
+ - Visual aids: Diagrams, images, and flowcharts anchor understanding
36
+ - Expectation-setting: "What You'll Learn" helps readers confirm they're in the right place
37
+ - Reader's Journey: Organize content biologically (linear progression), not logically (database)
38
+ - Mental models: Overview before details prevents cognitive overload
39
+ - Warmth: Encouraging tone reduces anxiety for new users
40
+ - Whitespace: Admonitions and callouts provide visual breathing room
41
+ - Summaries: Recaps help retention; they're reinforcement, not redundancy
42
+ - Examples: Concrete illustrations make abstract concepts accessible
43
+ - Engagement: "Flow" techniques (transitions, variety) are functional, not "fluff" -- they maintain attention
44
+
45
+ ## LLM-Reader Principles
46
+
47
+ When reader_type='llm', optimize for PRECISION and UNAMBIGUITY:
48
+
49
+ - Dependency-first: Define concepts before usage to minimize hallucination risk
50
+ - Cut emotional language, encouragement, and orientation sections
51
+ - IF concept is well-known from training (e.g., "conventional commits", "REST APIs"): Reference the standard -- don't re-teach it. ELSE: Be explicit -- don't assume the LLM will infer correctly.
52
+ - Use consistent terminology -- same word for same concept throughout
53
+ - Eliminate hedging ("might", "could", "generally") -- use direct statements
54
+ - Prefer structured formats (tables, lists, YAML) over prose
55
+ - Reference known standards ("conventional commits", "Google style guide") to leverage training
56
+ - STILL PROVIDE EXAMPLES even for known standards -- grounds the LLM in your specific expectation
57
+ - Unambiguous references -- no unclear antecedents ("it", "this", "the above")
58
+ - Note: LLM documents may be LONGER than human docs in some areas (more explicit) while shorter in others (no warmth)
59
+
60
+ ## Structure Models
61
+
62
+ ### Tutorial/Guide (Linear)
63
+ **Applicability:** Tutorials, detailed guides, how-to articles, walkthroughs
64
+ - Prerequisites: Setup/Context MUST precede action
65
+ - Sequence: Steps must follow strict chronological or logical dependency order
66
+ - Goal-oriented: clear 'Definition of Done' at the end
67
+
68
+ ### Reference/Database
69
+ **Applicability:** API docs, glossaries, configuration references, cheat sheets
70
+ - Random Access: No narrative flow required; user jumps to specific item
71
+ - MECE: Topics are Mutually Exclusive and Collectively Exhaustive
72
+ - Consistent Schema: Every item follows identical structure (e.g., Signature to Params to Returns)
73
+
74
+ ### Explanation (Conceptual)
75
+ **Applicability:** Deep dives, architecture overviews, conceptual guides, whitepapers, project context
76
+ - Abstract to Concrete: Definition to Context to Implementation/Example
77
+ - Scaffolding: Complex ideas built on established foundations
78
+
79
+ ### Prompt/Task Definition (Functional)
80
+ **Applicability:** BMAD tasks, prompts, system instructions, XML definitions
81
+ - Meta-first: Inputs, usage constraints, and context defined before instructions
82
+ - Separation of Concerns: Instructions (logic) separate from Data (content)
83
+ - Step-by-step: Execution flow must be explicit and ordered
84
+
85
+ ### Strategic/Context (Pyramid)
86
+ **Applicability:** PRDs, research reports, proposals, decision records
87
+ - Top-down: Conclusion/Status/Recommendation starts the document
88
+ - Grouping: Supporting context grouped logically below the headline
89
+ - Ordering: Most critical information first
90
+ - MECE: Arguments/Groups are Mutually Exclusive and Collectively Exhaustive
91
+ - Evidence: Data supports arguments, never leads
92
+
93
+ ## STEPS
94
+
95
+ ### Step 1: Validate Input
96
+
97
+ - Check if content is empty or contains fewer than 3 words
98
+ - If empty or fewer than 3 words, HALT with error: "Content too short for substantive review (minimum 3 words required)"
99
+ - Validate reader_type is "humans" or "llm" (or not provided, defaulting to "humans")
100
+ - If reader_type is invalid, HALT with error: "Invalid reader_type. Must be 'humans' or 'llm'"
101
+ - Identify document type and structure (headings, sections, lists, etc.)
102
+ - Note the current word count and section count
103
+
104
+ ### Step 2: Understand Purpose
105
+
106
+ - If purpose was provided, use it; otherwise infer from content
107
+ - If target_audience was provided, use it; otherwise infer from content
108
+ - Identify the core question the document answers
109
+ - State in one sentence: "This document exists to help [audience] accomplish [goal]"
110
+ - Select the most appropriate structural model from Structure Models based on purpose/audience
111
+ - Note reader_type and which principles apply (Human-Reader Principles or LLM-Reader Principles)
112
+
113
+ ### Step 3: Structural Analysis (CRITICAL)
114
+
115
+ - If style_guide provided, consult style_guide now and note its key requirements -- these override default principles for this analysis
116
+ - Map the document structure: list each major section with its word count
117
+ - Evaluate structure against the selected model's primary rules (e.g., 'Does recommendation come first?' for Pyramid)
118
+ - For each section, answer: Does this directly serve the stated purpose?
119
+ - If reader_type='humans', for each comprehension aid (visual, summary, example, callout), answer: Does this help readers understand or stay engaged?
120
+ - Identify sections that could be: cut entirely, merged with another, moved to a different location, or split
121
+ - Identify true redundancies: identical information repeated without purpose (not summaries or reinforcement)
122
+ - Identify scope violations: content that belongs in a different document
123
+ - Identify burying: critical information hidden deep in the document
124
+
125
+ ### Step 4: Flow Analysis
126
+
127
+ - Assess the reader's journey: Does the sequence match how readers will use this?
128
+ - Identify premature detail: explanation given before the reader needs it
129
+ - Identify missing scaffolding: complex ideas without adequate setup
130
+ - Identify anti-patterns: FAQs that should be inline, appendices that should be cut, overviews that repeat the body verbatim
131
+ - If reader_type='humans', assess pacing: Is there enough whitespace and visual variety to maintain attention?
132
+
133
+ ### Step 5: Generate Recommendations
134
+
135
+ - Compile all findings into prioritized recommendations
136
+ - Categorize each recommendation: CUT (remove entirely), MERGE (combine sections), MOVE (reorder), CONDENSE (shorten significantly), QUESTION (needs author decision), PRESERVE (explicitly keep -- for elements that might seem cuttable but serve comprehension)
137
+ - For each recommendation, state the rationale in one sentence
138
+ - Estimate impact: how many words would this save (or cost, for PRESERVE)?
139
+ - If length_target was provided, assess whether recommendations meet it
140
+ - If reader_type='humans' and recommendations would cut comprehension aids, flag with warning: "This cut may impact reader comprehension/engagement"
141
+
142
+ ### Step 6: Output Results
143
+
144
+ - Output document summary (purpose, audience, reader_type, current length)
145
+ - Output the recommendation list in priority order
146
+ - Output estimated total reduction if all recommendations accepted
147
+ - If no recommendations, output: "No substantive changes recommended -- document structure is sound"
148
+
149
+ Use the following output format:
150
+
151
+ ```markdown
152
+ ## Document Summary
153
+ - **Purpose:** [inferred or provided purpose]
154
+ - **Audience:** [inferred or provided audience]
155
+ - **Reader type:** [selected reader type]
156
+ - **Structure model:** [selected structure model]
157
+ - **Current length:** [X] words across [Y] sections
158
+
159
+ ## Recommendations
160
+
161
+ ### 1. [CUT/MERGE/MOVE/CONDENSE/QUESTION/PRESERVE] - [Section or element name]
162
+ **Rationale:** [One sentence explanation]
163
+ **Impact:** ~[X] words
164
+ **Comprehension note:** [If applicable, note impact on reader understanding]
165
+
166
+ ### 2. ...
167
+
168
+ ## Summary
169
+ - **Total recommendations:** [N]
170
+ - **Estimated reduction:** [X] words ([Y]% of original)
171
+ - **Meets length target:** [Yes/No/No target specified]
172
+ - **Comprehension trade-offs:** [Note any cuts that sacrifice reader engagement for brevity]
173
+ ```
174
+
175
+ ## HALT CONDITIONS
176
+
177
+ - HALT with error if content is empty or fewer than 3 words
178
+ - HALT with error if reader_type is not "humans" or "llm"
179
+ - If no structural issues found, output "No substantive changes recommended" (this is valid completion, not an error)