跳转到内容

20260911-0251-air-key-doc-consistency-repair Repair Air/Key documentation consistency after the supplier-guide rewrite

  • status: completed
  • priority: P1
  • owner: doc-review/session-20260911-0251
  • createdAt: 2026-09-11 02:51

The 2026-09-10 Air/Key rewrite replaced the old multi-radio gateway specification and split the shared supplier guide into per-product guides. A review found that documents outside the rewritten set still describe the retired product and point at section numbers and requirement IDs that no longer exist.

Repair, in the order the user approved:

  1. COMPLIANCE-MATRIX.md still scopes Air/Gateway as a Wi-Fi + BLE + 433 MHz + LoRa enclosure with an NMEA 2000 certification obligation, while the supplier guide points suppliers at that file for compliance scope.
  2. The Gateway requires NFC antenna tuning and per-unit NFC EOL testing, but the guide's own OOB flow puts the reader in the authorized tool and the recommended nRF54L15 only provides NFC-A tag emulation.
  3. About thirty §n / FR-nn cross-references in X01, X02, Studio, Mate, Tag and the vendor research point into sections and IDs deleted by the rewrite. The VitePress link checker does not detect these.
  4. Studio and Mate did not receive the scope notice that X01, X02 and Tag did.
  5. Air and Key requirement docs both use an FR-nn namespace with different meanings, and O-nn now means different things in each guide.
  6. The X03 split left unlinked, double-spaced "供应商指南" references with no document short name.
  7. IF-01 demands a frozen X01/X02 revision, but neither file carries a revision identifier.
  8. The two guides duplicate their common clauses with no drift control.
  9. Gateway supply and environment requirements have no traceable requirement ID.

Acceptance: no cross-document reference resolves to a deleted section or ID; compliance and NFC scope match the current base product; requirement and open-item namespaces are unambiguous; bun run docs:build and git diff --check pass; the split and this repair are recorded in the changelog.

Out of scope (reported to the user as product decisions, not documentation defects): the shared ≤60 mA@12 V ceiling for both Key models, whether the Gateway deep-sleep mode should exist at all, and turning the battery-versus-latency tradeoff into an explicit AIR-O-01 decision criterion.

Repairing cross-document references, compliance scope and requirement namespaces across the Air/Key package.

  • blocked by: (none; the user approved the repair order directly)
  • blocks: (none)
  • Full-tier task. Documentation only; no technical claim is added that is not already sourced in the package.

  • The Air/Key rewrite and the X03 split were produced by a separate session; its working tree has been idle since 2026-09-10 09:09 UTC.

  • The separately owned distributed-Core task and its uncommitted plan are left untouched.

  • complete: Compliance scope, Gateway NFC, cross-references, scope notices, namespaces, guide short names, interface baseline and duplication control repaired; corrupted vendor part numbers restored. Build, whitespace, reference and matrix checks pass.