Skip to content

Chapter quality checklist

The eight-section anatomy in Course standards says what is present. This says whether the chapter actually teaches. Every item is answerable from the page itself, and a review cites the item number when it fails a chapter.

Items marked must gate the chapter — a chapter missing one is a draft. Items marked should are what separates a usable chapter from a good one.

RequirementPasses whenCheck
A1 mustStated outcomeOpens with one sentence: a measurable verb and what the student can now do. Not “understand X”.read
A2 mustFixed shapeSame sections, same labels, same order in every chapter of every module. A reader who knows chapter 1 can navigate chapter 9 blind.diff
A3 mustSelf-containedA student who missed the lecture can complete the chapter alone: no “as covered in class”.read
A4 shouldOne ideaThe chapter teaches one idea with its consequences. If the heading needs “and”, split it.read
RequirementPasses whenCheck
B1 mustCovers the outcomeEvery clause of the outcome is taught, not gestured at. Nothing ends in “exercise for the reader”.read
B2 mustExact readingPrimary source named per chapter: lecture number and textbook chapter/§. “Read the docs” is not a reading.read
B3 shouldScope boundarySays what is deliberately left out and which chapter covers it.read
B4 shouldSourced claimsAny claim a practitioner would challenge has a citation or a demonstration in the page.read
RequirementPasses whenCheck
C1 mustStarts from the knownOpens on an artefact the student has already met — earlier chapter, or real FTM code and data.read
C2 mustMechanism, not factsExplains why it works and what happens when it doesn’t, not a list of properties.read
C3 mustOne running exampleThe same example carries the chapter. Three unrelated snippets is a summary, not a lesson.read
C4 shouldNamed failureShows the wrong version and what breaks — the error, the silent wrong answer, the outage.read
C5 mustTwo misconceptionsEach stated as the wrong model a student holds, then the correction. “Students confuse X and Y” is not a misconception.read
RequirementPasses whenCheck
D1 mustReasoning shownStep-by-step why, line by line — not code followed by “this works”.read
D2 shouldEdge caseIncludes one input that is valid but wrong in meaning (empty, reversed, off-by-one, null).read
D3 mustVerifiableRunnable asserts or a stated output the student can reproduce.run
RequirementPasses whenCheck
E1 mustBackward linkNames the chapters it assumes, explicitly (“needs Chapter 6’s aliasing”).grep
E2 mustForward linkNames where it is used later — chapter or module. A chapter nothing depends on is either misplaced or unnecessary.grep
E3 mustWorking linksEvery cross-reference is a relative link that resolves. No external document IDs, no ticket numbers.script
E4 shouldShared vocabularySame term for the same thing across modules; new terms defined at first use and used consistently after.read
E5 shouldCross-moduleWhere a concept recurs in the FTM codebase (FTM301+) or another CS module, says so.grep
RequirementPasses whenCheck
F1 mustSelf-checkFour items with answers and reasoning, after the teaching, covering the misconceptions.read
F2 mustProblem setFive graduated problems (recall → apply → analyse → synthesise), marks visible, totalling 20.script
F3 mustSolutionsWorked, with the mark allocation visible, so the student can mark themselves.read
F4 shouldAlignedEvery problem and every exam question maps to a clause of the outcome.read
RequirementPasses whenCheck
G1 mustCode blocksLanguage always; file title where the code is a real file; line markers where a specific line is the point.read
G2 mustNotationTeX via $…$ / $$…$$ only; no currency inside dollar signs; symbols match Notation & code.grep
G3 shouldReference tablesTables for reference material (values, orders, comparisons), prose for reasoning. No wall of bullets where a sentence belongs.read

A review is one row per chapter: module · chapter · failed items · evidence. A must failure is fixed before the chapter ships; a should failure is logged and fixed when the chapter is next touched. The audit of the first-year modules lives in the repo at review/first-year.md.