Skip to main content

Strict Docs Quality Roadmap

Why this page matters

The guide now has two quality levels:

  • npm run docs:check catches structural correctness issues for the whole guide.
  • npm run docs:check:strict enforces 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:

RequirementWhy
exercisesturns reading into practice
review/drill/artifact sectionproves architect-level application
source lens or further readingconnects claims to stable sources
valid frontmatter and slug hygienekeeps navigation stable
no broken local Markdown linksprotects reader flow

Expansion waves

WaveTargetOutcome
1new maps, diagrams, reference architectures, interview workbookfoundation and practice layer stays complete
2Part 0 and Part Iall foundation and decision chapters produce artifacts
3Part II and Part IIIruntime/rendering/data chapters all include drills and source lenses
4Part VI and Part VIIIquality-critical performance/security/reliability chapters become launch-review ready
5system-design prompts and worked answersinterview section becomes a full workbook
6capstones and solution packsevery 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

  1. Pick five Part II chapters and promote them to strict mode.
  2. Convert one system-design prompt into workbook format.
  3. 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.