Skip to content

Commit 3339f24

Browse files
alexeyvclaude
andauthored
refactor(skills): convert editorial-review-prose.xml to native skill (#1877)
* refactor(skills): convert editorial-review-prose.xml to native skill directory Replace single-file XML task with standard skill directory structure (SKILL.md + workflow.md + bmad-skill-manifest.yaml). Update parent manifest and module-help.csv references. No behavioral changes. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: add mandatory execution instructions to editorial-review-prose workflow Review found missing MANDATORY step-order enforcement and critical marker on Step 3, which were present in the original XML and the reference pattern (editorial-review-structure). Adds both to match established conventions. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix(tasks): align editorial-review-prose role text with section heading Rename EXECUTION heading to STEPS and update the role instruction to reference the correct section name. --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent c0877e7 commit 3339f24

6 files changed

Lines changed: 89 additions & 108 deletions

File tree

src/core/module-help.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ core,anytime,Party Mode,PM,,_bmad/core/workflows/party-mode/workflow.md,bmad-par
44
core,anytime,bmad-help,BH,,skill:bmad-help,bmad-help,false,,,"Get unstuck by showing what workflow steps come next or answering BMad Method questions.",,
55
core,anytime,Index Docs,ID,,_bmad/core/tasks/index-docs.xml,bmad-index-docs,false,,,"Create lightweight index for quick LLM scanning. Use when LLM needs to understand available docs without loading everything.",,
66
core,anytime,Shard Document,SD,,_bmad/core/tasks/shard-doc.xml,bmad-shard-doc,false,,,"Split large documents into smaller files by sections. Use when doc becomes too large (>500 lines) to manage effectively.",,
7-
core,anytime,Editorial Review - Prose,EP,,_bmad/core/tasks/editorial-review-prose.xml,bmad-editorial-review-prose,false,,,"Review prose for clarity, tone, and communication issues. Use after drafting to polish written content.",report located with target document,"three-column markdown table with suggested fixes",
7+
core,anytime,Editorial Review - Prose,EP,,skill:bmad-editorial-review-prose,bmad-editorial-review-prose,false,,,"Review prose for clarity, tone, and communication issues. Use after drafting to polish written content.",report located with target document,"three-column markdown table with suggested fixes",
88
core,anytime,Editorial Review - Structure,ES,,skill:bmad-editorial-review-structure,bmad-editorial-review-structure,false,,,"Propose cuts, reorganization, and simplification while preserving comprehension. Use when doc produced from multiple subprocesses or needs structural improvement.",report located with target document,
99
core,anytime,Adversarial Review (General),AR,,skill:bmad-review-adversarial-general,bmad-review-adversarial-general,false,,,"Review content critically to find issues and weaknesses. Use for quality assurance or before finalizing deliverables. Code Review in other modules run this automatically, but its useful also for document reviews",,
1010
core,anytime,Edge Case Hunter Review,ECH,,skill:bmad-review-edge-case-hunter,bmad-review-edge-case-hunter,false,,,"Walk every branching path and boundary condition in code, report only unhandled edge cases. Use alongside adversarial review for orthogonal coverage - method-driven not attitude-driven.",,
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
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+
Follow the instructions in [workflow.md](workflow.md).
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
type: skill
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Editorial Review - Prose
2+
3+
**Goal:** Review text for communication issues that impede comprehension and output suggested fixes in a three-column table.
4+
5+
**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.
6+
7+
**CONTENT IS SACROSANCT:** Never challenge ideas — only clarify how they're expressed.
8+
9+
**Inputs:**
10+
- **content** (required) — Cohesive unit of text to review (markdown, plain text, or text-heavy XML)
11+
- **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.
12+
- **reader_type** (optional, default: `humans`) — `humans` for standard editorial, `llm` for precision focus
13+
14+
15+
## PRINCIPLES
16+
17+
1. **Minimal intervention:** Apply the smallest fix that achieves clarity
18+
2. **Preserve structure:** Fix prose within existing structure, never restructure
19+
3. **Skip code/markup:** Detect and skip code blocks, frontmatter, structural markup
20+
4. **When uncertain:** Flag with a query rather than suggesting a definitive change
21+
5. **Deduplicate:** Same issue in multiple places = one entry with locations listed
22+
6. **No conflicts:** Merge overlapping fixes into single entries
23+
7. **Respect author voice:** Preserve intentional stylistic choices
24+
25+
> **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.
26+
27+
28+
## STEPS
29+
30+
### Step 1: Validate Input
31+
32+
- Check if content is empty or contains fewer than 3 words
33+
- If empty or fewer than 3 words: **HALT** with error: "Content too short for editorial review (minimum 3 words required)"
34+
- Validate reader_type is `humans` or `llm` (or not provided, defaulting to `humans`)
35+
- If reader_type is invalid: **HALT** with error: "Invalid reader_type. Must be 'humans' or 'llm'"
36+
- Identify content type (markdown, plain text, XML with text)
37+
- Note any code blocks, frontmatter, or structural markup to skip
38+
39+
### Step 2: Analyze Style
40+
41+
- Analyze the style, tone, and voice of the input text
42+
- Note any intentional stylistic choices to preserve (informal tone, technical jargon, rhetorical patterns)
43+
- Calibrate review approach based on reader_type:
44+
- If `llm`: Prioritize unambiguous references, consistent terminology, explicit structure, no hedging
45+
- If `humans`: Prioritize clarity, flow, readability, natural progression
46+
47+
### Step 3: Editorial Review (CRITICAL)
48+
49+
- If style_guide provided: Consult style_guide now and note its key requirements — these override default principles for this review
50+
- Review all prose sections (skip code blocks, frontmatter, structural markup)
51+
- Identify communication issues that impede comprehension
52+
- For each issue, determine the minimal fix that achieves clarity
53+
- Deduplicate: If same issue appears multiple times, create one entry listing all locations
54+
- Merge overlapping issues into single entries (no conflicting suggestions)
55+
- For uncertain fixes, phrase as query: "Consider: [suggestion]?" rather than definitive change
56+
- Preserve author voice — do not "improve" intentional stylistic choices
57+
58+
### Step 4: Output Results
59+
60+
- If issues found: Output a three-column markdown table with all suggested fixes
61+
- If no issues found: Output "No editorial issues identified"
62+
63+
**Output format:**
64+
65+
| Original Text | Revised Text | Changes |
66+
|---------------|--------------|---------|
67+
| The exact original passage | The suggested revision | Brief explanation of what changed and why |
68+
69+
**Example:**
70+
71+
| Original Text | Revised Text | Changes |
72+
|---------------|--------------|---------|
73+
| 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" |
74+
| Users can chose from options (lines 12, 45, 78) | Users can choose from options | Fixed spelling: "chose" to "choose" (appears in 3 locations) |
75+
76+
77+
## HALT CONDITIONS
78+
79+
- HALT with error if content is empty or fewer than 3 words
80+
- HALT with error if reader_type is not `humans` or `llm`
81+
- If no issues found after thorough review, output "No editorial issues identified" (this is valid completion, not an error)

src/core/tasks/bmad-skill-manifest.yaml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
editorial-review-prose.xml:
2-
canonicalId: bmad-editorial-review-prose
3-
type: task
4-
description: "Clinical copy-editor that reviews text for communication issues"
5-
61
index-docs.xml:
72
canonicalId: bmad-index-docs
83
type: task

src/core/tasks/editorial-review-prose.xml

Lines changed: 0 additions & 102 deletions
This file was deleted.

0 commit comments

Comments
 (0)