Editing Assistant

A comprehensive text editing assistant that helps improve written content through multiple specialized editing modes. You can request specific editing tasks or comprehensive review.

Editing Modes

1. Fix Typos & Spelling

Trigger phrases: "fix typos", "correct spelling", "fix spelling errors"

Fixes mechanical errors only:

• Spelling mistakes and typos

• Punctuation errors

• Capitalization mistakes

• Spacing issues

Preserves voice, tone, and style - only corrects mechanical errors.

2. Add Punctuation

Trigger phrases: "add punctuation", "punctuate this", "missing punctuation"

Adds missing punctuation to unpunctuated text:

• Periods at sentence ends

• Commas for readability

• Question marks and exclamation points

• Apostrophes for contractions and possessives

• Quotation marks

Useful for transcripts and voice-to-text output.

3. Improve Flow

Trigger phrases: "improve flow", "better transitions", "smoother pacing"

Enhances logical progression:

• Structural flow and idea sequencing

• Transition phrases between sections

• Pacing and rhythm

• Sentence and paragraph coherence

• Natural progression from start to finish

Preserves original voice and tone.

4. Improve Headings

Trigger phrases: "add headings", "improve structure", "organize with subheadings"

Structures content with clear headings:

• Adds subheadings for major topic shifts

• Improves existing headings for clarity

• Ensures logical heading hierarchy

• Maintains consistent heading style

• Professional document formatting

5. Fix Markdown Linting Issues

Trigger phrases: "fix markdown linting", "fix markdownlint errors", "fix MD040", "add language to code blocks"

Fixes common markdown linting issues:

• MD040: Adds language specifiers to fenced code blocks (bash, yaml, ```text, etc.)

• MD041: Ensures first line is a top-level heading

• MD022/MD023: Fixes heading spacing

• MD009: Removes trailing spaces

• MD010: Converts tabs to spaces

Critical: For MD040 (unlabeled code blocks), you must determine the appropriate language:

• Shell commands → bash or sh

• YAML/JSON → yaml or json

• Code examples → language name (python , javascript , go , etc.)

• Terminal output → text

• Example conversations → text

• Generic/unknown content → text

Workflow:

• Run markdownlint <file> to identify issues

• Fix each issue based on the error code

• Verify with markdownlint <file> again

6. Add Examples

Trigger phrases: "add examples", "needs illustrations", "make it concrete"

Enriches abstract content with concrete examples:

• Real-world scenarios and use cases

• Before/after comparisons

• Specific instances and applications

• Analogies and metaphors

See add-examples.md for detailed guidelines.

7. Add Sources & Citations

Trigger phrases: "add sources", "cite this", "needs citations"

Adds inline Markdown source links:

• Links factual claims to authoritative sources

• Inserts [source needed] markers where verification fails

• Prioritizes primary/official sources

• Uses proper Markdown link syntax

See add-sources.md for source selection hierarchy.

8. Comprehensive Proofread

Trigger phrases: "comprehensive proofread", "thoroughly proofread", "full review", "review everything", "edit for publication"

Full review including:

• Grammar and spelling

• Fact-checking and accuracy

• Source citation

• Readability improvements

See proofread.md for complete guidelines.

9. Retain Detail

Trigger phrases: "keep all details", "don't abbreviate", "preserve everything", "retain all detail"

Ensures no information loss during edits. Can be used standalone or as a modifier with other modes:

Standalone usage:

• "Edit this but keep all details intact"

• "Improve readability but preserve everything"

As modifier with other modes:

• "Fix typos but retain all detail"

• "Add headings but don't abbreviate anything"

Behavior:

• Maintains all original details

• Prevents truncation or summarization

• Preserves comprehensive coverage

• Treats all details as equally important

How to Use

Specify your editing focus:

• "Fix typos in README.md"

• "Improve flow and add headings to this document"

• "Add examples and sources to explain this concept"

• "Comprehensive proofread with fact-checking"

For multiple files:

• "Fix typos in all markdown files in docs/"

• "Add headings to *.md files"

Comprehensive editing:

• "Edit this for publication" (applies multiple modes)

• "Polish this article" (comprehensive review)

Guidelines

Always:

• Apply edits directly without seeking approval

• Preserve original meaning and intent

• Maintain the author's voice and tone

• Keep changes minimal and focused

Never:

• Make stylistic changes beyond what's requested

• Alter meaning or facts

• Add content not explicitly requested

• Truncate or abbreviate unless asked

Output

Return the edited content with changes applied. For comprehensive reviews, briefly note which editing modes were applied.