Skip to main content

[Module Name]

How to use this template. Copy this file into docs/courses/<course-name>/<NN-module>/index.md (the module folder's opening page), fill every [...] bracket, and delete this block. A module syllabus is the front door of the module — the sibling of the course syllabus, one level down.

Anti-bloat rule (non-negotiable). This page is a contract, not a lesson. It carries: the Module Overview table, the module's framing (2–3 sentences in the description), the module's mini-SLOs, and the ordered list of what's inside. It does NOT carry teaching: no explanations, no walkthroughs, no exercises, no theory. Teaching lives in the module's lesson/content pages below it. If you find yourself writing teaching here, it belongs on a lesson page. Keep it lean — this is the P6 (page-length) guard for module openers.

Sidebar wiring (at a glance). This page is the module's category link in sidebars.js ({ type: 'category', link: { type: 'doc', id: '<course>/<module>/index' }, items: [content pages + refs] }) — it is NOT listed as its own sidebar item, so it won't duplicate in the sidebar. See the Physical Structure & Sidebar Contract in ../courses/topic-architecture-template.md §3b for the full rules.

Tables are MINIMAL — the house style used on the KB structure page (docs/introduction/structure.md): bold first-column values + padded separator width (|--------|---------|, no alignment colons). Applies to every table unless a page is table-reliant. All syllabus tables are minimal.

Module Overview​

Est. time[e.g. 45 minutes]
Type[Foundations / Pipeline / Tools / Application / Methodology / Skill / Final Project]
Prerequisites[Prior module(s) or "None" — e.g. "Module 02 — Data & Methodology"]
Read first[The module's first content page, e.g. ../03-data-and-methodology/index.md]

The overview table is the module's at-a-glance. It is the only required element. Everything below it fills in context.

Description​

[Two to three sentences of framing: what this module covers, why it's in the course, and where it sits relative to the modules before/after it. This is the "why" — the framing that was previously scattered across intro pages. Keep it to 2–3 sentences; the anti-bloat rule applies here first.]

What You'll Be Able to Do​

By the end of this module you will be able to:

  1. [Objective 1 — measurable, action verb]
  2. [Objective 2]
  3. [Objective 3 — 3–5 objectives, not more]

3–5 objectives per module, each an action the reader can verify. These are the module's mini-SLOs — the course syllabus's Learning Objectives, decomposed one level down.

What's Inside​

This module is organized as [Describe the progression — e.g. "a path from abstract math to applied technique" or "a build-up from the base setup to the full toolset"]. The module pages, in order:

Phase 1: [Stage name]

[Where are we? / What's this stage?]

Phase 2: [Stage name]

[What does this stage do?]

[Page Title]​

[Page Title](./page.md): [N] min read

[Two to three sentences describing what this page covers and why it's in the module — the "what you'll meet here" description. This is the Module-Contents-style 2-block: description + a You'll learn: line.]

You'll learn: [the concrete takeaway / what this page teaches]

[Page Title]​

[Page Title](./page.md): [N] min read

[Description of the page.][You'll learn: …]

The phase-grid at the top gives the reading path (how the pages group into stages — the Learning Path idea). The per-page blocks below give each page a short description + what you'll learn (the Module Contents idea). This is the module's "what's inside" — the reader sees the path AND the pages, without the teaching itself. Teaching lives on the lesson pages.

Resources​

Sources​