Files
chanora/docs/governance/document-index.md
T
EdisonJwa dfa84ee7bb docs(spec): baseline 0.9.5 — v1 audio + PTT lifecycle redesign
Add SysRS-303/304, SysDes-149/150/151, SRS-204/205/206/207,
SAD-081/082/083, SDD-094/095/096/097, DEC-029/030.

Captures the v1 lifecycle redesign:
- Drop manual Start-audio button; audio engine is bound to voice-channel
  join/leave (ensure_running on first join, shutdown_if_idle on last
  leave). Output stream opens regardless of mic-permission state so
  listen-only is a first-class flow.
- TransmitMode enum (Ptt / Continuous / VoiceActivity-reserved).
  Default Ptt on fresh install. Persisted per identity.
- PTT release tail: 200 ms default (0-500 ms configurable) before
  transmit gate closes, avoiding clipped trailing syllables.
- Hard-mute toggle overrides transmit gate regardless of mode/PTT.
- Bridge surface: drop start_audio/stop_audio; add
  voice_join(channel_id) / voice_leave() and BridgeEvent::VoiceState.

DEC-029 rejects Flutter global-hotkey packages (hotkey_manager,
super_hot_key) for PTT: they wrap RegisterHotKey/RegisterEventHotKey
which consume the key and don't fire key-up, wrong primitive for PTT.
Native Rust DesktopPttBackend (SDD-083/084/085) stays authoritative.

DEC-030 defers Voice Activity Detection to P1. RMS / WebRTC VAD /
Silero VAD trade-off review (binary-size, dependency-surface, CPU
profile) postponed; TransmitMode::VoiceActivity reserved on the enum
surface so a P1 increment is non-breaking.

Validator clean: 304/151/207/83/97 IDs, strict layered sourcing
preserved, no new warnings beyond the pre-existing 35 old-package-name
filenames.
2026-05-15 22:46:51 +08:00

90 lines
4.2 KiB
Markdown

# Document Index
**Document type:** Configuration / Documentation Control
**Version:** 0.9.5
**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. |
| 0.9.5 | 2026-05-15 | Bumped controlled-set version to 0.9.5 for the v1 audio + PTT lifecycle refactor: SysRS-303..304, SysDes-149..151, SRS-204..207, SAD-081..083, SDD-094..097, and two new governance decisions DEC-029 (Flutter global-hotkey packages rejected for PTT) and DEC-030 (Voice Activity Detection deferred to P1). No controlled files added or removed; existing files updated in place under strict layered sourcing. |