/proofread¶
editingMITrevision-editingProofread Lecture Files¶
Run the mandatory proofreading protocol on lecture files. This produces a report of all issues found WITHOUT editing any source files.
Steps¶
- Identify files to review:
- If
$ARGUMENTSis a specific filename: review that file only -
If
$ARGUMENTSis "all": review all lecture files inSlides/andQuarto/ -
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
- 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
-
Save each report to
quality_reports/: - For
.texfiles:quality_reports/FILENAME_report.md -
For
.qmdfiles:quality_reports/FILENAME_qmd_report.md -
IMPORTANT: Do NOT edit any source files. Only produce the report. Fixes are applied separately after user review.
-
Present summary to the user:
- Total issues found per file
- Breakdown by category
- Most critical issues highlighted