proofread

Run the proofreading protocol on lecture files. Checks grammar, typos, overflow, consistency, and academic writing quality. Produces a report without editing files.

857 stars

Best use case

proofread is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

Run the proofreading protocol on lecture files. Checks grammar, typos, overflow, consistency, and academic writing quality. Produces a report without editing files.

Teams using proofread should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/proofread/SKILL.md --create-dirs "https://raw.githubusercontent.com/pedrohcgs/claude-code-my-workflow/main/.claude/skills/proofread/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/proofread/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How proofread Compares

Feature / AgentproofreadStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

Run the proofreading protocol on lecture files. Checks grammar, typos, overflow, consistency, and academic writing quality. Produces a report without editing files.

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

Related Guides

SKILL.md Source

# Proofread Lecture Files

Run the mandatory proofreading protocol on lecture files. This produces a report of all issues found WITHOUT editing any source files.

## Steps

1. **Identify files to review:**
   - If `$ARGUMENTS` is a specific filename: review that file only
   - If `$ARGUMENTS` is "all": review all lecture files in `Slides/` and `Quarto/`

2. **For each file, launch the proofreader agent** that checks for:

   **GRAMMAR:** Subject-verb agreement, articles (a/an/the), prepositions, tense consistency
   **TYPOS:** Misspellings, search-and-replace artifacts, duplicated words
   **OVERFLOW:** Overfull hbox (LaTeX), content exceeding slide boundaries (Quarto)
   **CONSISTENCY:** Citation format, notation, terminology
   **ACADEMIC QUALITY:** Informal language, missing words, awkward constructions

3. **Produce a detailed report** for each file listing every finding with:
   - Location (line number or slide title)
   - Current text (what's wrong)
   - Proposed fix (what it should be)
   - Category and severity

4. **Save each report** to `quality_reports/`:
   - For `.tex` files: `quality_reports/FILENAME_report.md`
   - For `.qmd` files: `quality_reports/FILENAME_qmd_report.md`

5. **IMPORTANT: Do NOT edit any source files.**
   Only produce the report. Fixes are applied separately after user review.

6. **Present summary** to the user:
   - Total issues found per file
   - Breakdown by category
   - Most critical issues highlighted

Related Skills

visual-audit

857
from pedrohcgs/claude-code-my-workflow

Perform adversarial visual audit of Quarto or Beamer slides checking for overflow, font consistency, box fatigue, and layout issues.

validate-bib

857
from pedrohcgs/claude-code-my-workflow

Validate bibliography entries against citations in all lecture files. Find missing entries and unused references.

translate-to-quarto

857
from pedrohcgs/claude-code-my-workflow

Translate Beamer LaTeX to Quarto RevealJS. Multi-phase workflow with TikZ extraction and QA.

slide-excellence

857
from pedrohcgs/claude-code-my-workflow

Multi-agent slide review (visual, pedagogy, proofreading). Use for comprehensive quality check before milestones.

review-r

857
from pedrohcgs/claude-code-my-workflow

Run the R code review protocol on R scripts. Checks code quality, reproducibility, domain correctness, and professional standards. Produces a report without editing files.

review-paper

857
from pedrohcgs/claude-code-my-workflow

Comprehensive manuscript review covering argument structure, econometric specification, citation completeness, and potential referee objections

research-ideation

857
from pedrohcgs/claude-code-my-workflow

Generate structured research questions, testable hypotheses, and empirical strategies from a topic or dataset

qa-quarto

857
from pedrohcgs/claude-code-my-workflow

Adversarial Quarto vs Beamer QA. Critic finds issues, fixer applies fixes, loops until APPROVED (max 5 rounds).

pedagogy-review

857
from pedrohcgs/claude-code-my-workflow

Run holistic pedagogical review on lecture slides. Checks narrative arc, student prerequisites, worked examples, notation clarity, and deck pacing.

lit-review

857
from pedrohcgs/claude-code-my-workflow

Structured literature search and synthesis with citation extraction and gap identification

learn

857
from pedrohcgs/claude-code-my-workflow

Extract reusable knowledge from the current session into a persistent skill. Use when you discover something non-obvious, create a workaround, or develop a multi-step workflow that future sessions would benefit from.

interview-me

857
from pedrohcgs/claude-code-my-workflow

Interactive interview to formalize a research idea into a structured specification with hypotheses and empirical strategy