跳转到内容

20260913-2341-documentation-standard Define the documentation standard and target directory structure

  • status: completed
  • priority: P1
  • owner: claude/session-63037002
  • createdAt: 2026-09-13 23:41

The repository has grown by accretion: four filename casing schemes, three product-document header conventions, two vendor catalogue layouts, a numbered research series with a duplicate 08 and gaps, tracking records under two ID schemes, and no machine-readable status or date on content pages. The owner asked for a documentation standard and a directory structure that replace this ad hoc pattern.

Deliver a documentation standard for the whole package (document kinds, frontmatter schema, status vocabulary, filename and directory rules, index-page rules, cross-reference rules, templates, and a lint gate) plus a target directory structure with a phased migration path. Implementation of each migration phase is tracked as its own task after the standard is approved.

Acceptance criteria:

  • The plan records the current-state findings and the proposed standard in enough detail to implement without further design.
  • The standard covers every area of the repository: governance, product package, research, vendor catalogues, evidence archives, project records, and unpublished references.
  • Every proposed rename or move has a redirect or link-rewrite strategy that keeps the published site and the build green.
  • The migration is split into independently approvable phases with file counts.

Designing the documentation standard and target directory structure.

  • blocked by: (none)
  • blocks: (migration phase tasks, created after approval)
  • Related plan: 20260913-2344-documentation-standard

  • complete: Standard, templates, lint, DocMeta and the five phases delivered; lint 0 findings, build passes, 6,852 rendered links verified.