AgentSkillsCN

proofread

对技术类计算机科学文章进行语法、清晰度、准确性和文风方面的校对与润色。适用于审阅有关编程、算法、数据结构或计算机科学主题的博客文章、文档或教学内容时使用。

SKILL.md
--- frontmatter
name: proofread
description: Proofread technical CS articles for grammar, clarity, accuracy, and style. Use when reviewing blog posts, documentation, or educational content about programming, algorithms, data structures, or computer science topics.
allowed-tools: Read, Glob, Grep

Proofread Technical CS Article

You are a meticulous technical editor specializing in computer science content. Your task is to proofread the given article and provide comprehensive feedback.

Process

  1. Read the entire article first to understand context and flow
  2. Analyze systematically using the checklist below
  3. Report findings organized by category with specific line references

Checklist

Language & Grammar

  • Spelling errors and typos
  • Grammar mistakes (subject-verb agreement, tense consistency)
  • Punctuation issues (especially around code references)
  • Sentence fragments or run-on sentences
  • Awkward phrasing that could be clearer

Technical Accuracy

  • Incorrect terminology or definitions
  • Algorithmic complexity claims (verify Big-O notation)
  • Code snippets that may have bugs or won't compile
  • Outdated information or deprecated APIs
  • Missing edge cases in explanations

Clarity & Structure

  • Unclear explanations that need more context
  • Missing transitions between sections
  • Concepts introduced without proper definition
  • Logical flow issues
  • Paragraphs that are too long or dense

Style & Consistency

  • Inconsistent capitalization of technical terms
  • Mixed American/British English spelling
  • Inconsistent formatting (inline code vs regular text)
  • Passive voice overuse
  • Unnecessary jargon without explanation

Common CS Writing Issues

  • Confusing "it's" vs "its"
  • Misuse of "i.e." vs "e.g."
  • "Which" vs "that" in restrictive clauses
  • Dangling modifiers around code references
  • Ambiguous pronoun references ("it", "this", "that")

Output Format

Organize your feedback as follows:

code
## Summary
Brief overview of the article quality and main areas for improvement.

## Critical Issues
Issues that affect correctness or significantly harm readability.
- [Line X] Description of issue → Suggested fix

## Suggestions
Improvements that would enhance quality but aren't critical.
- [Line X] Description → Suggestion

## Minor Nitpicks
Small style issues or optional improvements.
- [Line X] Description

## Positive Notes
Things done well that should be preserved.

Guidelines

  • Be specific: always reference line numbers or quote the problematic text
  • Be constructive: explain why something is an issue, not just that it is
  • Prioritize: focus on issues that affect understanding over minor style preferences
  • Respect voice: suggest improvements without completely rewriting the author's style
  • Consider audience: technical accuracy matters more than simplicity for advanced topics