Back to Plate

docs pack

docs/plans/templates/packs/docs.md

53.3.101.5 KB
Original Source

docs pack

Use this pack when docs are a touched surface but not the dominant risk. If docs are the dominant deliverable, use --template docs as the primary template.

Start Gates:

GateAppliesEvidence
Docs pack selectedpendingpending
docs-creator loadedpendingpending
Docs lane selectedpendingpending
Target docs and nearest sibling docs readpendingpending
Docs style doctrine readpendingpending
Documented source owner identifiedpendingpending

Work Checklist:

  • Docs pack: docs lane, target docs, nearest sibling docs, and source owner are recorded.
  • Docs pack: every named API, import, option, route, component, transform, demo, and preview is source-backed or marked N/A with reason.
  • Docs pack: docs use current-state reference voice, not changelog voice.
  • Docs pack: links, anchors, and previews target real leaf pages or are marked N/A with reason.

Completion Gates:

GateAppliesRequired actionEvidence
Docs source-backed claim auditpendingVerify docs claims against current source or record N/Apending
Docs links / routes / previewspendingVerify leaf links, routes, anchors, and preview names or record N/Apending
Docs MDX/content parserpendingRun pnpm --filter www build:source for MDX/content changes, or record N/Apending
Plugin page specificspendingFor plugin pages, apply docs-creator kit/manual/API rules; otherwise N/Apending