writing-style

To tighten documentation prose, revise narrative sections to remove filler, use active voice, and shorten sentences. This trims hedging and repetition while preserving the original meaning and leaving code blocks or JSON untouched.

Editing documentation prose preserves rendered blocks, JSON sidecars, schema-bound values, code blocks, and command output exactly. Only author-written narrative text is modified, ensuring structural and configuration elements remain completely untouched.

The best way to improve readability in PRD and TRD narrative sections is converting long passages into bullets or tables and applying plain language. This restructures content for scanning without altering the technical meaning.

You can clean up research notes before publishing by revising summaries, rationale, and outcomes. The process removes throat-clearing and repetition from narrative text, making the final document shorter and easier to scan.

You should not use automated prose editing when your markdown contains schema-bound values, inline config snippets, or command output that must remain exactly as written, because the tool targets narrative text and leaves structural blocks untouched.

Shield documentation needs filler removed from narrative sections because hedging and repetition create reading friction. Trimming filler and using short sentences makes the prose clearer and easier to scan without changing the meaning.