Proofreading Is Not Rewriting: A Checklist Skill for Technical Docs

说明与用途

通过检查表检查技术文档，仅标记语言错误，保留作者语气和事实准确性。

问题

AI polishing tools often rewrite technical documents, altering author voice and introducing factual errors.

结果

The workflow produces a no-defects checklist that preserves author voice and factual accuracy, avoiding the pitfalls of AI rewriting.

工作流

• Read entire document to determine type (tutorial, API reference, blog post, README) and build terminology list.
• Apply six defect categories: Typos and spelling, Grammar, Punctuation, Inline code and proper nouns, Sentence style, Structure.
• For each paragraph, flag only fixable sentences, not rewrite whole paragraphs.
• Mark uncertain items with [verify] instead of silent correction.
• Generate output as checklist items: Original → Suggestion → Reason, with line numbers or short quotes.
• Include statistics: total items and breakdown by category.
• Deliver checklist to author for selective acceptance.
• Stop after one pass; do not iterate endlessly.

证据

I asked my coding agent to proofread a README draft. It returned a beautifully rewritten document — smoother sentences, tidier structure, my voice completely gone.

来源

The skill now proofreads. It does not rewrite.

来源

The output is a checklist, not a new document.

来源