跳转到内容

20260921-1700-switch-line-document-structure Give the Switch line one document model for brief, features, spec and development requirements

  • status: completed
  • priority: P1
  • owner: claude/session-20260921-1700
  • createdAt: 2026-09-21 17:00

The owner reviewed the product line and found the internal structure of the Switch packages confusing: the customer-facing description, the functional description, the target specification and the development (supplier) requirements are not kept in one recognisable place per product. Switch is to be fixed first; the other lines follow later.

Investigation findings are recorded in plan 20260921-1701. In short: the line runs two document models at once (Air and Air Hub as one self-contained file each, Key as a three-file split), the Key package restates its chip table in three registers and carries two requirement ID schemes, and the Key files contradict two bus-wide decisions (Classical CAN, no sleep outside Air) and the documentation standard's page layout.

Acceptance criteria:

  1. Every Switch product (Air, Key, Air Hub) presents the same four registers in the same place: product brief, functional behaviour with requirement IDs, target specification, development requirements for design house and contract manufacturer.
  2. Every numbered target appears in exactly one Level 1 file; Level 2 and supplier files cite an ID or section and do not restate figures.
  3. Every requirement ID and open-item ID that exists today still exists once, or has a recorded mapping in the file's change log.
  4. No Switch file contradicts X01 (Classical CAN, 500 kbit/s, no BRS) or the 2026-09-11 decision that only Air sleeps; no stale name (Hub for Mate, Air 指南) remains.
  5. Every controlled Switch page follows the documentation standard: relations list in the fixed order, ## 变更记录 table, full-width dashes in titles.
  6. Inbound links from governance, shared, Mate, Studio, Control, Tag and research resolve to the moved sections.
  7. bun run docs:lint && bun run docs:build && git diff --check passes.

Restructuring the Switch line documents onto one model

  • blocked by: (none)
  • blocks: (none)
  • Full-tier task: more than three files, crosses bizplan/product/switch/, bizplan/governance/, bizplan/product/shared/ and docs/decisions/.

  • Decision docs/decisions/2026-09-14-air-single-file-spec.md (sunset 2026-12-31) chose the single-file model for Air and Air Hub. The recommended option supersedes it early; the alternative extends it to Key instead. Either way the line ends with one model.

  • A second session (claude/session-20260915-1901, task 20260921-1659) is active on site tooling and three research pages; no Switch file overlaps.

  • complete: Option A implemented; lint 222 pages 0 findings, build and git diff --check pass.