Course Guide¶
Guide Fit¶
flowchart TD
family["Reproducible Research"] --> program["Deep Dive Snakemake"]
program --> pressure["A concrete learner or reviewer question"]
pressure --> guide["Course Guide"]
guide --> next["Modules, capstone, and reference surfaces"]
flowchart TD
question["What kind of help do you need?"] --> choose["Choose the matching course surface"]
choose --> route["Open one guide, module, or capstone page"]
route --> next_move["Leave with one smaller next move"]
Read the first diagram as a timing map: this guide is a support hub, not another chapter. Read the second diagram as the loop: identify the kind of help you need, choose the matching surface, then leave with one smaller next move.
Deep Dive Snakemake has four durable surfaces:
- course home and orientation for entry and reading order
- modules for the teaching arc itself
- capstone pages for executable corroboration
- reference pages for durable review and repair maps
Choose the right surface¶
| If you need... | Start here | Do not start with |
|---|---|---|
| first entry into the course | Start Here | the capstone repository |
| the module sequence explained | Module 00 | incident or governance pages |
| one support page for urgency | Pressure Routes | random browsing through guides/ |
| workflow-versus-policy separation | Boundary Map | the strongest available command |
| module-to-repository routing | Capstone Map | raw repository files |
| durable review maps | Reference | course-home prose |
The teaching arc¶
| Arc | Modules | What becomes legible |
|---|---|---|
| file-contract foundations | Modules 01-02 | truthful file contracts, deterministic discovery, and explicit checkpoints |
| policy and scaling boundaries | Modules 03-05 | profiles, scaling interfaces, helper-code boundaries, and honest software seams |
| publish and architecture surfaces | Modules 06-08 | downstream contracts, repository file APIs, and operating-context boundaries |
| incident and governance judgment | Modules 09-10 | observability, incident evidence, migration boundaries, and stewardship judgment |
The support shelf by job¶
- Read Workflow Modularization when repository splits or module boundaries feel fuzzy.
- Read Module Promise Map when module titles feel too compressed.
- Read Module Checkpoints when you need a visible exit bar.
- Read Pressure Routes when the reading order is shaped by urgency.
- Read Proof Matrix when you already know the claim and need the evidence surface.
- Read Command Guide when you know the route but not the command layer.
- Read Capstone Guide when you need the capstone contract before opening repository files.
Best defaults¶
Use these as your stable defaults unless the current pressure gives you a stronger reason:
- enter with Start Here
- anchor in Module 00
- read modules in order
- keep Proof Ladder nearby
- enter the capstone through Capstone Map
Good stopping point¶
Stop when you can answer two questions clearly:
- which surface should answer the next question
- why the heavier surfaces would be premature right now