Skip to content

paper-audit

Deep-review-first academic paper audit for LaTeX, Typst, and PDF documents. It is a reviewer and gate-checking workflow, not a source editor.

Use It For

  • Quick submission-readiness screening.
  • Final-week mechanical checks for em dashes, AI-tone vocabulary, abstract result gaps, citation/label/equation hygiene, and paragraph-shape weak signals.
  • Reviewer-style deep critique with major/moderate/minor findings.
  • PASS/FAIL gate decisions calibrated for submission blockers.
  • Re-audits that compare a revision against a previous audit.
  • Review workspaces with traceable artifacts, claim maps, quote checks, and revision trajectories.

Do Not Use It For

  • Direct .tex or .typ source editing as the first step.
  • Compilation repair as the main task.
  • Paragraph-level polishing without an audit goal.
  • Free-form literature survey writing.
  • Cover-letter generation or claim alignment; use cover-letter.

Mode Router

ModeUse whenPrimary command
quick-auditYou want a fast script-backed readiness screenuv run python academic-writing-skills/paper-audit/scripts/audit.py paper.tex --mode quick-audit
deep-reviewYou need reviewer-style findings, workspace artifacts, and a revision roadmapuv run python academic-writing-skills/paper-audit/scripts/audit.py paper.tex --mode deep-review --focus full
gateYou only care about hard submission blockersuv run python academic-writing-skills/paper-audit/scripts/audit.py paper.tex --mode gate --venue ieee
polishYou want precheck-only handoff before style editinguv run python academic-writing-skills/paper-audit/scripts/audit.py paper.tex --mode polish
re-auditYou have a previous report and need regression comparisonuv run python academic-writing-skills/paper-audit/scripts/audit.py paper.tex --mode re-audit --previous-report report_v1.md

Compatibility aliases: self-check -> quick-audit; review -> deep-review.

Deep-review dispatches five committee agents and six or more lane agents, then uses synthesis_agent.md. Mode-specific agents cover gate, re-audit, and post-consolidation revision suggestions. Specialized reviewer playbooks under agents/ are reference material, not auto-dispatched; see the agent roster.

Minimum Inputs

  • paper.tex, paper.typ, or paper.pdf.
  • Optional --venue, --lang en|zh, and --report-style deep-review|peer-review.
  • Optional --focus full|editor|theory|literature|methodology|logic for deep-review.
  • --previous-report for re-audit.
  • --review-dir when continuing or rendering an existing review workspace.

Script Entry Points

ScriptPurpose
audit.pyPublic mode router for quick-audit, deep-review, gate, polish, and re-audit
prepare_review_workspace.pyCreates the review workspace for deep review
build_claim_map.pyExtracts headline claims, closure targets, and claim candidates
check_citations.py / check_references.pyCitation and reference hygiene checks
verify_quotes.pyVerifies report quotes against source text
render_deep_review_report.pyRenders Markdown deep-review reports
render_html_report.pyRenders bilingual HTML report twins
render_revision_trajectory.pyProduces the revision trajectory artifact
diff_review_issues.pySupports re-audit comparison

Output Artifacts

For deep-review, the workspace root is reader-facing:

  • review_report.md and review_report.html
  • revision_suggestions.md and revision_suggestions.html

Supporting artifacts live under artifacts/:

  • artifacts/summary/paper_summary.md, overall_assessment.txt, peer_review_report.md
  • artifacts/data/final_issues.json, all_comments.json, claim_map.json, section_index.json, revision_suggestions.json, revision_trajectory.md
  • artifacts/meta/metadata.json, checkpoint.json, phase0_context.md, full_text.md
  • artifacts/sections/, artifacts/comments/, artifacts/committee/, and artifacts/references/

The report language is controlled by --lang en|zh. Headings and labels switch language; issue quotes, source tags, and structured field values stay faithful to the source.

Public Resources

References

Templates

Examples

Agent Contracts

Common Requests

text
Run a quick-audit on paper.tex and tell me what blocks submission.
text
Deep-review this manuscript like a journal reviewer and produce the review workspace plus HTML report.
text
Gate this IEEE paper and separate hard blockers from advisory pseudocode recommendations.
text
Audit only the literature positioning and tell me whether the claimed gap is real or selectively framed.
text
Re-audit this revised manuscript against report_v1.md and summarize resolved vs unresolved issues.

Important Notes

  • PRESUBMISSION is an internal mechanical layer plugged into existing modes, not a separate public mode.
  • Full/editor deep-review may promote high-signal pre-submission findings into pre_submission_readiness; other focused reviews keep them as Phase 0 context.
  • claim_map.json distinguishes visible anchors from support strength; a citation key alone does not prove support.
  • Data availability findings are advisory unless a venue-required central source gap should block submission.
  • PDF input runs text-only checks and skips LaTeX/Typst source hygiene.

Released under the MIT License.