pedagogy-review

Review Quarto and Markdown reports for pedagogical clarity and comprehension.

220|358|Updated Apr 29, 2026
One-click install
npx skills add https://github.com/maxwell2732/codex-stata-for-economists --skill pedagogy-review-maxwell2732
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pedagogy-review
Source: https://github.com/maxwell2732/codex-stata-for-economists/tree/main/.claude/skills/pedagogy-review
Command: npx skills add https://github.com/maxwell2732/codex-stata-for-economists --skill pedagogy-review-maxwell2732

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It helps you identify and fix pedagogical issues in a Quarto or Markdown report so readers can understand prerequisites, notation, worked examples, and the document’s narrative arc without confusion.

Core Features & Use Cases

  • Motivation and reader fit: Checks whether the document sets appropriate context and matches the intended audience’s assumed knowledge.
  • Prerequisites and worked-example quality: Verifies that prerequisites are stated clearly and that examples are sufficient and readable to non-coauthors.
  • Notation, structure, and pacing: Reviews notation consistency, structural flow, pacing, and clarity of identification/econometric claims when applicable to econometric reports.
  • Output for actionable iteration: Produces a dedicated pedagogy report saved under quality_reports/ for easy review.

Quick Start

Review the file reports/your_report.qmd by running the pedagogy-review skill with that exact filename or path.

Frequently Asked Questions about pedagogy-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check notation consistency and clarity in a Quarto report?

To check notation consistency in a Quarto report, you need a pedagogical review that evaluates prerequisites, worked examples, and structural flow. This process identifies violations in notation and produces a documented evaluation with actionable recommendations.

What is a pedagogical review of an econometric replication report?

A pedagogical review of an econometric replication report verifies reader comprehension by checking if prerequisites, worked examples, notation, and pacing are clear. It ensures the document's narrative arc and identification claims are understandable to non-coauthors.

How do I improve reader comprehension in Markdown documentation?

You improve reader comprehension in Markdown documentation by reviewing the document's motivation, reader fit, and pacing. A holistic review checks whether the context matches the intended audience's assumed knowledge and verifies that examples are sufficient and readable.

Can I generate a quality report for pedagogical issues in Quarto files?

Yes, you can generate a quality report for pedagogical issues in Quarto files. The review process checks the specified input file and writes a documented evaluation, including violations and top recommendations, to a deterministic output filename in the quality_reports directory.

Does pedagogical review work for econometric analysis documents?

Pedagogical review works for econometric analysis documents by specifically verifying the clarity of identification claims, notation consistency, and structural flow. It ensures the complex prerequisites and worked examples meet the comprehension needs of the intended audience.