course-review

What this skill does

# Course Review Frameworks

Comprehensive frameworks and checklists for reviewing programming educational content.

## Review Severity Levels

Use these severity levels to prioritize findings:

### Critical (Must Fix)
Issues that make content incorrect, misleading, or harmful to learning:
- Code that doesn't compile or produces wrong output
- Factually incorrect explanations
- Missing critical prerequisites
- Security vulnerabilities in example code
- Misleading simplifications that create misconceptions

### Major (Should Fix)
Issues that significantly impact quality or learning effectiveness:
- Inconsistent terminology or style
- Unclear explanations for target audience
- Missing important edge cases or pitfalls
- Poor progression or scaffolding
- Examples that don't follow best practices

### Minor (Nice to Fix)
Issues that affect polish but not correctness or core learning:
- Typos and grammatical errors
- Formatting inconsistencies
- Suboptimal code style choices
- Missing "nice to have" content
- Verbose or redundant explanations

### Enhancement (Suggestions)
Opportunities to improve beyond current quality:
- Additional examples or analogies
- Better visual representations
- Extended challenges for advanced students
- Industry anecdotes or real-world connections
- Alternative approaches worth mentioning

## Code Review Checklist

### Compilation & Execution
- [ ] All code examples compile without errors
- [ ] All code examples produce the stated output
- [ ] Include directives and imports are present
- [ ] Main functions or entry points are properly defined
- [ ] Build/run instructions are accurate

### Correctness
- [ ] Logic is correct and bug-free
- [ ] Edge cases are handled appropriately
- [ ] Error examples actually demonstrate errors
- [ ] Fixed versions actually fix the problems
- [ ] Return values and types are correct

### Style & Idioms
- [ ] Code follows language-specific conventions
- [ ] Naming is consistent and meaningful
- [ ] Comments explain "why" not "what"
- [ ] Code matches course style guidelines
- [ ] Modern language features used appropriately

### Best Practices
- [ ] No deprecated features or patterns
- [ ] Proper error handling where appropriate
- [ ] Memory management follows course approach
- [ ] Resource cleanup is demonstrated
- [ ] Security considerations addressed

### Presentation
- [ ] Code is properly formatted and indented
- [ ] Syntax highlighting is correct
- [ ] Output matches actual program output
- [ ] Error messages are realistic
- [ ] Line numbers are helpful (if used)

## Technical Accuracy Checklist

### Conceptual Correctness
- [ ] Definitions are accurate and precise
- [ ] Analogies are appropriate and don't mislead
- [ ] Simplifications are acknowledged
- [ ] Mental models align with reality
- [ ] Technical claims are verifiable

### Terminology
- [ ] Terms are used correctly
- [ ] Jargon is defined before use
- [ ] Acronyms are expanded on first use
- [ ] Naming matches language conventions
- [ ] Consistent terminology throughout

### Explanations
- [ ] Cause and effect are correctly linked
- [ ] Sequence of events is accurate
- [ ] Performance claims are correct
- [ ] Comparisons are fair and accurate
- [ ] Limitations are acknowledged

### Currency
- [ ] Information reflects current standards
- [ ] Language version is appropriate
- [ ] Deprecated features are noted
- [ ] Best practices are up-to-date
- [ ] Tools and libraries are current

## Pedagogical Quality Checklist

### Audience Appropriateness
- [ ] Complexity matches target audience
- [ ] Prerequisites are realistic
- [ ] Pacing is appropriate
- [ ] Depth is suitable for level
- [ ] Examples resonate with audience

### Scaffolding
- [ ] Concepts build incrementally
- [ ] New concepts connect to prior knowledge
- [ ] Sufficient stepping stones provided
- [ ] Not too many concepts at once
- [ ] Guidance gradually decreases

### Clarity
- [ ] Explanations are understandable
- [ ] Abstract concepts are made concrete
- [ ] Multiple representations used
- [ ] Assumptions are explicit
- [ ] Transitions are smooth

### Engagement
- [ ] Content motivates learning
- [ ] Real-world relevance is clear
- [ ] Active learning opportunities exist
- [ ] Examples are interesting
- [ ] Tone is appropriate

### Assessment Alignment
- [ ] Exercises match learning objectives
- [ ] Difficulty progression is appropriate
- [ ] Practice opportunities are sufficient
- [ ] Feedback mechanisms exist
- [ ] Self-check opportunities provided

## Content Completeness Checklist

### Coverage
- [ ] All learning objectives addressed
- [ ] No gaps in concept chain
- [ ] Edge cases discussed
- [ ] Common mistakes covered
- [ ] Pitfalls and gotchas explained

### Depth
- [ ] Sufficient detail for understanding
- [ ] "Why" explained, not just "how"
- [ ] Trade-offs discussed
- [ ] Alternative approaches mentioned
- [ ] Limitations acknowledged

### Practice
- [ ] Enough exercises for mastery
- [ ] Range of difficulty levels
- [ ] Different types of practice
- [ ] Extension opportunities exist
- [ ] Self-assessment possible

### Support Materials
- [ ] Prerequisites clearly stated
- [ ] Summary/review provided
- [ ] Further reading suggested
- [ ] Solutions or hints available
- [ ] Reference material accessible

## Consistency Checklist

### Terminology
- [ ] Same terms used for same concepts
- [ ] Consistent use of technical language
- [ ] Abbreviations used consistently
- [ ] Names match across files
- [ ] Cross-references are accurate

### Style
- [ ] Code style matches course standards
- [ ] Writing voice is consistent
- [ ] Formatting follows templates
- [ ] Heading structure is uniform
- [ ] Callout boxes used consistently

### Presentation
- [ ] Visual style is uniform
- [ ] Diagram conventions consistent
- [ ] Code block formatting matches
- [ ] Emphasis conventions consistent
- [ ] Link formatting standardized

### Approach
- [ ] Pedagogical approach is consistent
- [ ] Complexity level is uniform
- [ ] Exercise difficulty scales consistently
- [ ] Explanation depth is consistent
- [ ] Philosophy matches throughout

## Structure & Organization Checklist

### Logical Flow
- [ ] Prerequisites come before dependents
- [ ] Complexity increases appropriately
- [ ] Related topics are grouped
- [ ] Transitions are logical
- [ ] Flow makes sense to learner

### Dependencies
- [ ] No forward references to unlearned content
- [ ] Prerequisites are clearly identified
- [ ] Dependency chain is respected
- [ ] Review happens before advancement
- [ ] Callbacks reference actual earlier content

### Organization
- [ ] Clear hierarchical structure
- [ ] Consistent sectioning
- [ ] Appropriate granularity
- [ ] Balanced section lengths
- [ ] Navigation aids present

### Integration
- [ ] Parts work together as a whole
- [ ] Assessments match content
- [ ] Labs reinforce chapters
- [ ] Projects synthesize learning
- [ ] Everything serves learning objectives

## Course-Wide Review Framework

### Course Architecture Review
1. **Learning Objectives Analysis**
   - Are objectives measurable and achievable?
   - Do they align with audience needs?
   - Are they covered by course content?
   - Are they assessed appropriately?

2. **Prerequisite Analysis**
   - Are prerequisites clearly stated?
   - Are they realistic for target audience?
   - Is prerequisite knowledge actually needed?
   - Are prerequisites tested/reviewed?

3. **Topic Sequencing**
   - Is the order logical?
   - Are dependencies respected?
   - Could anything be reordered for better learning?
   - Are review/consolidation points appropriate?

4. **Scope Assessment**
   - Is scope appropriate for duration?
   - Are there gaps in coverage?
   - Is there unnecessary content?
   - Is depth consistent across topics?

### Cross-Module Consistency Review
1. **Terminology Audit**
   - Collect all defined terms
   - Check for inconsistent definitions
   - Verify consistent usage
   - Check first-use introductions

2. **Code Style