EdisonJwa
02ffadfa52
Applies the gen2 desktop-PTT review summary
(`gen2/chanora-desktop-ptt-review-summary-v0.9.2.md`) to our doc set
with the owner rulings PTT-OPEN-001 through PTT-OPEN-006 resolved as
accepted decisions DEC-023 through DEC-028:
* DEC-023 Windows Global PTT P0 / MVP
* DEC-024 macOS Global PTT P0 / MVP with permission UX
* DEC-025 Linux officially-tested env: GNOME on Wayland only
* DEC-026 Mouse side buttons supported (Win + macOS; Linux portal)
* DEC-027 PTT diagnostics: capability + availability only, no
raw key codes ever
* DEC-028 Missed-key-up watchdog: P0
Requirements (SysRS / SRS) and architecture (SysDes / SAD / SDD)
gain the desktop-PTT ID set the gen2 summary describes:
SysRS-296..302 -> SysDes-142..148
-> SRS-195..203
-> SAD-071..079
-> SDD-081..092
ID totals advance from 295 / 141 / 194 / 70 / 80 to 302 / 148 / 203
/ 79 / 92. The strict layered sourcing rule (`SRS -> SysDes` only,
`SAD -> SRS` only, `SDD -> SAD` only) is preserved; the
`tools/validate_docs.py` validator reports zero undefined refs and
zero direct-layer-rule violations.
New document:
* `docs/architecture/desktop-ptt-architecture.md` — capability
ladder (L0Focused, L1GlobalShortcut, L2GlobalHoldToTalk,
L3GlobalWithMouseButtons, L4DeviceAware reserved), Windows /
macOS / Linux strategies, privacy rule, audio-gate rule,
missed-key-up watchdog, release-readiness evidence requirement,
traceability summary.
Doc addenda (Baseline Candidate 0.9.3):
* `privacy/privacy-policy.md` — no raw key history, capability-
dependent Global PTT, UI reflects actual runtime capability
* `security/threat-model.md` — THREAT-PTT-001..006
* `security/diagnostic-redaction-audit-report.md` —
REDACT-PTT-001..006 banned field list enforced by `PttSanitizer`
* `release/platform-release-policy.md` — per-platform evidence
fields, no over-claim on untested Linux compositors
* `release/release-readiness-go-nogo-record.md` — RR-PTT-001..008
release-readiness items
* `verification/swe4-unit-verification-plan.md` —
SWE4-UV-035..039
* `verification/swe5-software-integration-verification-plan.md` —
SWE5-IV-015
* `verification/swe6-software-verification-plan.md` — SWE6-SV-017
* `verification/sys4-system-integration-verification-plan.md` —
SYS4-SIV-016
* `governance/traceability-matrix.md` — full PTT trace rows +
verification map
* `governance/decision-impact-assessment.md` — DEC-023..028
impact matrix
* `governance/product-decision-register.md` v0.9.9 entry
recording DEC-023..028 in the decision table and the status
table at §7
* `governance/document-index.md` — adds
`desktop-ptt-architecture.md` to the controlled set
* `architecture/proof-of-concept-plan.md` —
PoC-PTT-001..005 platform items
* `references/external-references.md` — Windows Raw Input,
macOS event-tap, Linux GlobalShortcuts portal references
* Both validation reports
(`baseline-candidate-validation-report.md`,
`repo-format-validation-report.md`) bumped to v0.9.3 with the
new ID totals (302 / 148 / 203 / 79 / 92).
README §"Desktop Push-to-Talk" added between Architecture Overview
and Repository Layout: capability levels, per-platform strategy,
privacy posture, missed-key-up watchdog.
Tooling:
* `tools/validate_docs.py` copied from the gen2 zip into the
repo tree (was previously available only inside the zip).
Reports zero undefined refs, zero direct-layer-rule violations,
English-only CJK check passes. The 35 "old package-style
filename" hits are pre-existing and identical to the gen2
baseline (they live in `path-migration-map.md` and config-ID
headers of governance docs and are intentional per the path
migration policy).
* `.gitignore` adds `/gen2/` so the externally-provided review
package does not enter the repo.
No code changes in this commit; B (the implementation split into
`transmit_active` / `capture_active`, `PttCapabilityLevel`
reporting, `PttSanitizer` diagnostics rule, and the UI capability
badge) follows in a separate commit.
89 lines
3.7 KiB
Markdown
89 lines
3.7 KiB
Markdown
# Document Index
|
|
|
|
**Document type:** Configuration / Documentation Control
|
|
**Version:** 0.9.2
|
|
**Status:** Baseline Candidate
|
|
**Language:** English
|
|
**Product:** Chanora
|
|
**Repo path:** `docs/governance/document-index.md`
|
|
|
|
---
|
|
|
|
## 1. Purpose
|
|
|
|
This document lists the normalized latest files included in the Chanora repository documentation package.
|
|
|
|
## 2. Current Baseline Candidate Files
|
|
|
|
| File | Status |
|
|
|---|---|
|
|
| `docs/architecture/sad.md` | Baseline Candidate |
|
|
| `docs/architecture/sdd.md` | Baseline Candidate |
|
|
| `docs/architecture/sysdes.md` | Baseline Candidate |
|
|
| `docs/architecture/desktop-ptt-architecture.md` | Baseline Candidate |
|
|
| `docs/governance/baseline-approval-record.md` | Baseline Candidate |
|
|
| `docs/governance/baseline-candidate-validation-report.md` | Baseline Candidate |
|
|
| `docs/governance/decision-impact-assessment.md` | Baseline Candidate |
|
|
| `docs/governance/document-naming-convention.md` | Baseline Candidate |
|
|
| `docs/governance/document-review-report.md` | Baseline Candidate |
|
|
| `docs/governance/git-commit-message-convention.md` | Baseline Candidate |
|
|
| `docs/governance/path-migration-map.md` | Baseline Candidate |
|
|
| `docs/governance/product-decision-register.md` | Baseline Candidate |
|
|
| `docs/governance/repo-format-validation-report.md` | Baseline Candidate |
|
|
| `docs/governance/traceability-matrix.md` | Baseline Candidate |
|
|
| `docs/i18n/localization-architecture.md` | Baseline Candidate |
|
|
| `docs/legal/trademark-and-attribution-review.md` | Baseline Candidate |
|
|
| `docs/privacy/privacy-policy.md` | Baseline Candidate |
|
|
| `docs/references/aspice-swe2-swe3-integration-note.md` | Baseline Candidate |
|
|
| `docs/references/external-references.md` | Baseline Candidate |
|
|
| `docs/release/platform-release-policy.md` | Baseline Candidate |
|
|
| `docs/release/release-readiness-go-nogo-record.md` | Baseline Candidate |
|
|
| `docs/requirements/srs.md` | Baseline Candidate |
|
|
| `docs/requirements/sysrs.md` | Baseline Candidate |
|
|
| `docs/security/dependency-and-supply-chain-report.md` | Baseline Candidate |
|
|
| `docs/security/diagnostic-redaction-audit-report.md` | Baseline Candidate |
|
|
| `docs/security/secure-storage-audit-report.md` | Baseline Candidate |
|
|
| `docs/security/security-privacy-legal-guideline.md` | Baseline Candidate |
|
|
| `docs/security/threat-model.md` | Baseline Candidate |
|
|
| `docs/ui-ux/adaptive-layout-platform-guide.md` | Baseline Candidate |
|
|
| `docs/ui-ux/material3-component-catalog.md` | Baseline Candidate |
|
|
| `docs/ui-ux/material3-design-tokens.md` | Baseline Candidate |
|
|
| `docs/ui-ux/material3-guideline.md` | Baseline Candidate |
|
|
| `docs/verification/swe4-unit-verification-plan.md` | Baseline Candidate |
|
|
| `docs/verification/swe5-software-integration-verification-plan.md` | Baseline Candidate |
|
|
| `docs/verification/swe6-software-verification-plan.md` | Baseline Candidate |
|
|
| `docs/verification/sys4-system-integration-verification-plan.md` | Baseline Candidate |
|
|
| `docs/verification/verification-master-plan.md` | Baseline Candidate |
|
|
|
|
## 3. Core Engineering Hierarchy
|
|
|
|
```text
|
|
SysRS -> SysDes -> SRS -> SAD -> SDD
|
|
```
|
|
|
|
## 4. Verification Work Product Mapping
|
|
|
|
```text
|
|
SDD -> SWE.4
|
|
SAD + SDD -> SWE.5
|
|
SRS -> SWE.6
|
|
SysDes -> SYS.4
|
|
```
|
|
|
|
## 5. Repo File Naming Rules
|
|
|
|
| Rule | Decision |
|
|
|---|---|
|
|
| Product prefix in file names | Not used under `docs/` |
|
|
| Case style | lowercase kebab-case |
|
|
| Version in file name | Not used |
|
|
| Version location | Inside document metadata |
|
|
| Release package version | Used in ZIP/package name |
|
|
|
|
## 6. Change History
|
|
|
|
| Version | Date | Description |
|
|
|---|---|---|
|
|
| 0.9.2 | 2026-05-14 | Converted documentation package to repository-oriented docs folder structure and updated internal filename references. |
|
|
| 0.9.3 | 2026-05-15 | Added `docs/architecture/desktop-ptt-architecture.md` to the controlled document set. |
|