Strict Docs Quality Roadmap
Why this page matters
The guide now has two quality levels:
npm run docs:checkcatches structural correctness issues for the whole guide.npm run docs:check:strictenforces the newer curriculum standard for selected high-value pages.
Strict mode should expand deliberately. Turning it on for every legacy page at once would create noise instead of useful quality pressure.
Current strict standard
Strict-target pages should include:
| Requirement | Why |
|---|---|
| exercises | turns reading into practice |
| review/drill/artifact section | proves architect-level application |
| source lens or further reading | connects claims to stable sources |
| valid frontmatter and slug hygiene | keeps navigation stable |
| no broken local Markdown links | protects reader flow |
Expansion waves
| Wave | Target | Outcome |
|---|---|---|
| 1 | new maps, diagrams, reference architectures, interview workbook | foundation and practice layer stays complete |
| 2 | Part 0 and Part I | all foundation and decision chapters produce artifacts |
| 3 | Part II and Part III | runtime/rendering/data chapters all include drills and source lenses |
| 4 | Part VI and Part VIII | quality-critical performance/security/reliability chapters become launch-review ready |
| 5 | system-design prompts and worked answers | interview section becomes a full workbook |
| 6 | capstones and solution packs | every portfolio project has calibrated expected/weak answers |
Promotion checklist
Before adding a legacy page to the strict target set:
- Add or verify exercises.
- Add an architecture drill, review checklist, or artifact output.
- Add source lens or further reading.
- Check local links.
- Run
npm run docs:check:strict.
Review checklist
- Is strict mode small enough to remain trusted?
- Are new pages added to strict mode immediately?
- Are legacy chapters promoted in coherent waves?
- Does each promoted page produce an artifact, not only explanation?
Exercises
- Pick five Part II chapters and promote them to strict mode.
- Convert one system-design prompt into workbook format.
- Add a source lens to one legacy security or performance chapter.
Source lens
This roadmap operationalizes the guide's quality bar and source-backed reading notes. It should be updated whenever the strict target set expands.