2.0 KiB
2.0 KiB
Chapter Completeness Checklist
Use this checklist to ensure chapters have all necessary components and flow well.
Introduction
- Introduction hooks reader with real-world relevance
- Learning objectives are stated clearly upfront
- Chapter overview provides roadmap
- Prerequisites are reminded/referenced
- Context is provided (how this fits in book)
Content Structure
- Concepts are explained before they are used
- Logical progression from simple to complex
- Clear section headings guide reader
- Transitions between sections are smooth
- No sudden jumps in difficulty
Learning Objectives Alignment
- All stated learning objectives are addressed
- Content supports achieving objectives
- Practice opportunities align with objectives
- Objectives are achievable within chapter scope
- Assessment validates objective completion
Tutorials and Examples
- Hands-on tutorials reinforce key concepts
- Code examples are working and tested
- Tutorials follow best practices (see tutorial-effectiveness-checklist.md)
- Balance of theory and practice
- Examples are realistic and relevant
Exercises
- Exercises provide appropriate practice
- Range from guided to independent challenges
- Difficulty progression is logical
- Instructions are clear
- Solutions or hints are provided (as appropriate)
Visual Aids
- Diagrams support understanding where needed
- Code examples are well-formatted
- Screenshots show expected results
- Visuals are clear and labeled
- Callouts/highlighting used effectively
Summary
- Key concepts are recapped clearly
- Skills checklist shows accomplishments
- Learning objectives are reviewed
- Preview of next chapter provides continuity
- Additional resources offered (if appropriate)
Consistency
- Terminology is used consistently
- Formatting matches book style
- Code examples follow established patterns
- Voice and tone are consistent
- Cross-references are accurate