prose-quality-check

name

prose-quality-check

description

Review or revise explanatory prose for readability, local structure, audience fit, and preserved nuance. Use for wording in documentation, comments, release notes, issues, pull requests, changelogs, handoff notes, and Agent Skills after the document's purpose and factual ownership are known. Use software-documentation-maintenance instead for repository-wide document maps, canonical ownership, technical evidence, coverage, or migration.

Prose Quality Check

Goals

• Make prose easy to scan without flattening meaning.
• Preserve nuance that affects reader decisions, implementation safety, or release interpretation.
• Match structure to content: sentences for simple ideas, lists for enumerations, and nested bullets for grouped details.
• Keep wording aligned with the target audience and the local document style.

Responsibility boundary

Use this skill when the destination document, factual source, and ownership are already known and the task is to improve how the text communicates. Do not use it to decide which repository documents should exist, where a technical fact belongs, whether evidence is sufficient, or how a documentation migration should preserve coverage. Use software-documentation-maintenance for those decisions, then return here to refine the resulting prose.

Do not silently repair unsupported technical claims while copyediting. Flag the evidence gap and use the applicable documentation-system or domain-specific skill.

Workflow

1. Classify the text audience before revising:
   • Developer-facing.
   • User-facing.
   • Maintainer-facing.
   • External-contract text.
2. Confirm the intended claim and factual source are known. If ownership or evidence is disputed, stop prose-only revision at that boundary and report the gap.
3. Identify overloaded prose:
   • Sentences carrying multiple ideas, conditions, time references, confidence levels, or relationships.
   • Paragraphs that mix context, decision, evidence, and consequence.
   • List items that contain several facts, exceptions, examples, or follow-up notes.
4. Prefer lists when presenting enumerations.
   • Use inline prose only when the enumeration is short enough to read naturally or when the local document style clearly favors inline wording.
5. Split or restructure dense text when it becomes hard to scan.
   • Use separate paragraphs, parent bullets with indented child bullets, tables, or another local document pattern that makes each idea easy to review.
   • When a sentence continues the same paragraph or comment block, prefer starting it on a new physical line if the local format allows that without changing the rendered structure.
   • Treat sentence-per-line wrapping as a reviewability aid, not as a paragraph break. Do not apply it when it would make short prose, Markdown links, lists, tables, or formatter-controlled code comments harder to read.
   • Do not change wording strength, modality, tense, or voice only to make sentence wrapping work. Keep wording unchanged unless an independent readability issue justifies rewriting it.
6. Preserve the nuance that made the original wording important:
   • Certainty or confidence level.
   • Scope and applicability.
   • Timing and sequence.
   • Exception or limitation status.
   • Dependency or compatibility relationships.
   • Whether a statement is original, backfilled, inferred, superseded, withdrawn, or still unconfirmed.
7. Use as many short sentences or nested bullets as needed. Do not force a fixed sentence count when the content needs a different shape.
8. Re-read the result as a whole and use the domain-specific skill when one owns the document type.
   • Confirm it still answers the same question as the original wording.
   • Confirm each list or paragraph has one clear job.
   • Confirm the structure did not imply a stronger, weaker, broader, or narrower claim than the source material supports.

Output checklist

• Audience and document type were considered before rewriting.
• Factual ownership and evidence gaps were not silently decided through wording changes.
• Enumerations are lists unless inline prose is clearer for the local context.
• Dense paragraphs or list items were split or intentionally left intact.
• Important certainty, scope, timing, relationship, and status nuances were preserved.
• The final text is easier to scan and still communicates the same claim.