技术开发文档体系方案 v1.0
技术开发文档体系方案 v1.0
摘要
本方案定义 Xisound 技术开发文档的整体框架,面向 14 产品线 × 6 层矩阵 × 软/硬/算/芯四栈。 核心理念:双轨分离(内部开发 · 对外客户)· 七层分治(战略/架构/接口/模块/数据/测试/运维)· 单源多发(MD 唯一真源 · MkDocs 静态站 + GitHub/Gitee wiki 双渠道)。
v1.0 拍板生效 · 2026-05-06
本方案于 2026-05-06 经用户一次性拍板通过 O1-O10 全部 10 项决策(详见 §9)。
v1.0-draft → v1.0 · published · Phase 4「技术开发文档体系」期正式启动。
执行路线:整理批 1 基建期(D3/D4/D6 骨架 + nav 挂接)→ 整理批 2 迁移 old-arch-doc/ → 整理批 3 归档草稿 → 实现批 1-2 填充期 → 扩展批。
1. 背景与目标
1.1 为什么需要新方案
现状痛点(基于 2026-05-06 探索结果):
| 现状 | 问题 |
|---|---|
| Phase 3 v1.0+ 221 份文档 | 覆盖战略/产品/商务/交付/培训/质量,但几乎无技术开发实现层 |
| old-arch-doc/ 33 份 | 含完整 System/Backend/Frontend/DSP 架构 + 9 大模块设计,但游离于体系外 · 命名风格不一 · 版本号混乱(v5/v6/v7) |
| 04_development/ 项目代号 TuningTool | 代码存在(C#/Vue/C/Py),但代码级文档零散:仅 CLAUDE.md / AGENTS.md / SESSION_CONTEXT.md 等 agent 协作笔记,缺少面向工程师的规范架构 |
| 07_web/ · 03_algorithms/ · 05_system_integration/ | 各有代码,均无体系化开发文档 |
| 02_architecture/ 目录缺失 | 被 .claude/agents.json / prompt.txt 等多处引用,实际未建 |
| 前端栈冲突 | 产品策略说 P10 XiVST 用 Astro(07_web),实际调音前端用 Vue 3(04_development/frontend_vue3) |
1.2 目标
v1.0 方案目标
- 体系化:所有技术文档在统一层级下归位,新工程师一周内读懂
- 双轨分离:内部(含实现细节)vs 对外(仅稳定 API / 集成指南)清晰切分
- 产品对齐:每份文档明确归属哪个产品线(14 产品)哪个层级(L0-L5 六层)
- 代码对齐:文档结构 = 代码目录结构 mirror · 避免"代码变了文档没变"
- 一次写 · 多地看:MD 唯一真源 · 内部站 / 对外站 / GitHub wiki 皆可发布
2. 双轨设计(Internal vs External)
2.1 双轨总览
flowchart LR
A[MD 源文件<br/>site-build/docs/] --> B{分流规则}
B -->|D0-D3 内部分层| C[🏢 内部站<br/>Internal MkDocs]
B -->|external/ 对外分层| D[🌐 对外站<br/>External MkDocs]
C --> E[员工/合作方 VPN]
D --> F[公网 xisound.com]
classDef xyL0 fill:#6B3FA0,stroke:#6B3FA0,color:#fff
classDef xyL3 fill:#DFA66D,stroke:#DFA66D,color:#fff
class A,B xyL0
class C,D xyL3
2.2 内部 vs 对外 · 分流规则
| 维度 | 内部文档(D0-D3) | 对外文档(external/) |
|---|---|---|
| 受众 | Xisound 员工 · 关联公司 · 签 NDA 的客户 | 潜在客户 · 开发者社区 · 公开搜索 |
| 内容层 | 战略 / 架构 / 实现 / 代码 / 测试 / 运维 / 敏感数据 | 产品介绍 / 集成指南 / 稳定 API / 案例 · Demo |
| 版本状态 | 可以 draft / internal-only / 敏感 | 必须 published · 法务审查过 |
| 典型示例 | DSPAlgo 模块内部数据结构 · 车规 bring-up 方法 · Tapeout checklist | XiDSP 集成示例 · XiStudio 用户手册 · API 快速入门 |
| 构建方式 | mkdocs build 输出到 _site/ · 内部部署 |
Astro 构建 07_web/xisound-website → xisound.com |
| 链接方向 | 内部可引用 external(公开引用 OK)· external 禁止反向引用内部 | 仅引用本站 + 第三方公开资料 |
2.3 边界判定 · "这份文档到底该放哪?" 3 条硬规则
| # | 规则 | 示例 |
|---|---|---|
| R1 | 出现 RTL/原理图/车规 bring-up/Tapeout/IP 核源码 → 内部(D1-rd/ic 或 D1-rd/hw) | XiDSP 芯片 RTL 设计、流片 checklist |
| R2 | 出现客户合同金额/供应商报价/内部 OKR/股权/薪酬 → 内部(D0-company) | 定价单、竞品情报、财务模型 |
| R3 | 出现稳定 API / 集成示例 / 用户手册 / 公开 Demo → 对外(external/) | XiStudio API 快速入门、Demo 视频 |
模糊区判例: - 「算法 API」:稳定版(≥ v1.0)→ 对外;alpha/internal → 内部 - 「架构图」:系统级 block diagram → 对外脱敏版;详细层级图 + IP 核内部接口 → 内部 - 「FAQ」:客户常问 → 对外;内部 bug workaround → 内部
3. 内部文档七层分治(D0-D6)
3.1 七层整体架构
flowchart TB
L0[📘 D0 · 公司级<br/>战略 · 品牌 · 融资 · 制度 · 跨中心规范]
L1[🏢 D1 · 中心级<br/>A产品/B研发/C商务/D交付/E战略/F运营]
L2[📦 D2 · 产品级<br/>P1-P10 共 10 产品 × 12 标准模板]
L3[🏛️ D3 · 架构级【新增】<br/>系统架构/接口/数据模型/部署拓扑]
L4[🔧 D4 · 实现级【新增】<br/>后端/前端/算法/芯片 4 栈模块实现]
L5[⚙️ D5 · 执行级<br/>模板库 · 会议纪要 · 周报 · ADR 决策记录]
L6[🧪 D6 · 测试与运维【新增】<br/>测试规范 · CI · HIL · 监控 · 发布管理]
L0 --> L1 --> L2 --> L3 --> L4 --> L5
L3 --> L6
L4 --> L6
classDef existed fill:#6B3FA0,stroke:#6B3FA0,color:#fff
classDef new fill:#DFA66D,stroke:#DFA66D,color:#fff
class L0,L1,L2,L5 existed
class L3,L4,L6 new
3.2 三个新增层(D3 / D4 / D6)详解
D3 · 架构级(新增 · 填补现有空白)
定位:跨产品/跨栈的系统级架构文档。来源主要是 old-arch-doc/ 整合。
| 子目录 | 内容 | 来源 |
|---|---|---|
D3-architecture/system/ |
全局 System Architecture v7.0 | 迁 old-arch-doc/deployment/System_Architecture.md |
D3-architecture/backend/ |
C# 后端架构 / Controllers / WebSocket / AI Agent | 整合 old-arch-doc/deployment/Backend_Architecture.md |
D3-architecture/frontend/ |
Vue 3 前端架构 / Pinia / Components | 整合 old-arch-doc/deployment/Frontend_Architecture.md |
D3-architecture/dspalgo/ |
DSP 算法库架构 v7.0 · 数据流 · 模块注册 | 整合 old-arch-doc/deployment/DSPAlgo_Architecture_v6.md(实为 v7) |
D3-architecture/data-model/ |
全局数据结构 · 参数协议 · 持久化 schema | 迁 old-arch-doc/doc_ref/DataStructure_Reference.md · data_model_and_arch_v2.md |
D3-architecture/protocol/ |
WebSocket 协议 · 参数协议 · gRPC schema | 迁 old-arch-doc/doc_ref/Protocol_Design.md · api/websocket_api.md |
D3-architecture/deployment-topology/ |
部署拓扑 · 进程模型 · 端口约定 | 新建(本次 07_web M6.1 部署方案挂这儿) |
D4 · 实现级(新增 · 面向代码工程师)
定位:与代码仓库 1:1 mirror 的模块实现文档。工程师"写模块 = 写文档"。
| 子目录 | 子项目 | 对应代码路径 |
|---|---|---|
D4-implementation/backend-csharp/ |
TuningTool.Backend(.NET 8) | AlgoDepartment/04_development/backend_csharp/ |
D4-implementation/frontend-vue3/ |
TuningTool 前端(Vue 3) | AlgoDepartment/04_development/frontend_vue3/ |
D4-implementation/dsp-algo/ |
DSP 算法 DLL(C 原生 · 9 大模块) | AlgoDepartment/04_development/dsp_algo/ |
D4-implementation/pysidecar/ |
Python 侧车(FastAPI) | AlgoDepartment/04_development/pysidecar/ |
D4-implementation/algorithms/ |
算法源码库(03_algorithms/) | AlgoDepartment/03_algorithms/ |
D4-implementation/web-astro/ |
对外网站(Astro) | AlgoDepartment/07_web/xisound-website/ |
每个子项目下的标准模板(10 份 · 与 D2 产品 12 份对齐但偏代码视角):
| # | 模板 | 内容 |
|---|---|---|
| 01 | README.md | 项目入口 · 快速启动 |
| 02 | architecture.md | 模块级架构(D3 的下探) |
| 03 | api-internal.md | 内部 API(函数签名 / DI 注入) |
| 04 | data-flow.md | 数据流向图 |
| 05 | module-list.md | 模块清单(如 DSP 9 大模块) |
| 06 | config.md | 配置文件 schema |
| 07 | dependencies.md | 依赖树 · 版本锁 |
| 08 | build.md | 本地构建 · 产物位置 |
| 09 | debugging.md | 调试工作流 · 常见坑 |
| 10 | migration.md | 版本升级 · 数据迁移 |
D6 · 测试与运维(新增 · 贯穿研发-发布-运营)
定位:测试规范 + CI/CD + 监控告警 + 发布管理 四合一。
| 子目录 | 内容 |
|---|---|
D6-testing/unit/ |
各栈单测规范(xUnit / Vitest / Google Test / pytest) |
D6-testing/integration/ |
集成测试(已有 05_system_integration/) |
D6-testing/e2e/ |
端到端(Playwright / Selenium) |
D6-testing/hil/ |
硬件在环(XiAmp / XiBox 车规 bring-up) |
D6-cicd/ |
GitHub Actions / GitLab CI / Jenkins pipeline |
D6-ops/monitoring/ |
Prometheus / Grafana / 告警规则 |
D6-ops/release/ |
版本号规范 · 灰度策略 · 回滚剧本 |
D6-ops/incident/ |
事故响应 · Postmortem 模板 |
3.3 七层 → 14 产品 · 二维矩阵
每个产品在每层都可能有文档(非全量 · 按需):
| 产品 | D0 战略 | D1 中心 | D2 产品 | D3 架构 | D4 实现 | D5 执行 | D6 测试 |
|---|---|---|---|---|---|---|---|
| P1 XiStudio | × | × | ✅ 12 | ✅ 多栈 | ✅ frontend + backend | 按需 | ✅ 单测+E2E |
| P2 XiDSP | × | × | ✅ 12 | ✅ dspalgo | ✅ dsp-algo 9 模块 | 按需 | ✅ HIL |
| P3 XiAmp(硬件) | × | × | ✅ 12 | ✅ hw+firmware | 硬件侧链 | 按需 | ✅ 车规 |
| P4 XiBox(硬件) | × | × | ✅ 12 | ✅ hw+firmware | 硬件侧链 | 按需 | ✅ 车规 |
| P5 XiAlgo(算法库) | × | × | ✅ 12 | ✅ algorithms | ✅ 9+ 算法模块 | 按需 | ✅ 单测 |
| P6 XiTune | × | × | ✅ 12 | ✅ 多栈 | ✅ frontend + backend | 按需 | ✅ 单测 |
| P7 XiTest | × | × | ✅ 12 | ✅ 多栈 | ✅ frontend + backend | 按需 | ✅ 单测 |
| P8 XiMind(规划) | × | × | ✅ 12 | 规划 | 规划 | × | 规划 |
| P9 XiForge | × | × | ✅ 12 | ✅ 多栈 | ✅ frontend + backend | 按需 | ✅ 单测 |
| P10 XiVST(规划) | × | × | ✅ 12 | 规划 | 规划 | × | 规划 |
4. old-arch-doc/ 33 份整理计划
4.1 映射表(33 份 → D3 + D4)
| old-arch-doc/ 路径 | 新位置 | 归类 |
|---|---|---|
api/dsp_interface.md |
D3-architecture/protocol/dsp-interface.md | 协议 |
api/parameter_protocol.md |
D3-architecture/protocol/parameter-protocol.md | 协议 |
api/websocket_api.md |
D3-architecture/protocol/websocket.md | 协议 |
architecture/system_overview.md |
D3-architecture/system/overview.md(合并到 System_Architecture v7) | 系统架构 |
architecture/dsp_pipeline.md |
D3-architecture/dspalgo/pipeline.md | DSP 架构 |
architecture/module_interaction.md |
D3-architecture/system/module-interaction.md | 系统架构 |
deployment/System_Architecture.md |
D3-architecture/system/architecture-v7.md(主文档 · 1280 行) | 系统架构 |
deployment/Backend_Architecture.md |
D3-architecture/backend/architecture.md | 后端架构 |
deployment/Frontend_Architecture.md |
D3-architecture/frontend/architecture.md | 前端架构 |
deployment/DSPAlgo_Architecture_v6.md |
D3-architecture/dspalgo/architecture-v7.md(实为 v7 · 2440 行) | DSP 架构 |
deployment/ModuleCustomization_Design.md |
D4-implementation/dsp-algo/module-customization.md | DSP 实现 |
doc_ref/DSPAlgo_Architecture.md ~ v5/v6 |
归档到 _legacy_arch_drafts/ 不上架 · 仅保留 v7 |
归档 |
doc_ref/DataStructure_Reference.md |
D3-architecture/data-model/data-structure-reference.md | 数据模型 |
doc_ref/data_model_and_arch_v2.md |
D3-architecture/data-model/data-model-v2.md | 数据模型 |
doc_ref/Protocol_Design.md |
D3-architecture/protocol/design.md | 协议 |
doc_ref/awe_module_structure_analysis.md |
D4-implementation/dsp-algo/module-analysis/awe.md | DSP 实现 |
doc_ref/{Gain,GEQ,Mixer,Dynamics,Delay,Spatial,VoiceLogic,SoundDesign,ChannelMap,Mixing}*_Design.md |
D4-implementation/dsp-algo/modules/{name}.md | DSP 9 大模块 |
doc_ref/NewModules_Overview.md |
D4-implementation/dsp-algo/modules/overview.md | DSP 实现 |
doc_ref/Backend_Architecture.md(与 deployment 重复) |
合并后删除 | 去重 |
doc_ref/Frontend_Architecture.md(与 deployment 重复) |
合并后删除 | 去重 |
doc_ref/System_Architecture.md · System_Architecture_v6.md |
归档到 _legacy_arch_drafts/ |
归档 |
4.2 整理执行步骤(分 3 批 · 每批一次 commit)
| 批次 | 内容 | 工作量 |
|---|---|---|
| 整理批 1 | 建 D3-architecture/ + D4-implementation/ 骨架目录 + index.md 每个子目录 + 本方案所指引的 mkdocs.yml nav 结构 | 约 20 份 index/骨架 |
| 整理批 2 | 迁移 old-arch-doc/ 中定稿版(System v7 / DSPAlgo v7 / Backend / Frontend / DataStructure / Protocol + 9 大 DSP 模块 = 约 15 份)· 补齐 frontmatter 对齐 v1.1 规范 · 不改实质内容 | 15 份迁移 |
| 整理批 3 | 归档剩余 v5/v6 草稿到 _legacy_arch_drafts/ · 补 README · mkdocs 排除 |
10 份归档 |
执行完 3 批后,old-arch-doc/ 目录可以删除(或改名为 _legacy_arch_drafts/)。
5. 对外文档(external/)补充扩展
对外已有 28 份(产品 10 + 支持 6 + 下载 6 + Demo 6)。本方案建议新增开发者文档子站:
| 新增节点 | 内容 |
|---|---|
external/developer/ |
开发者专区(v1.1 启用) |
external/developer/quickstart.md |
5 分钟快速上手 |
external/developer/sdk-reference/ |
稳定 SDK API 参考(从 D3/D4 脱敏而来) |
external/developer/integration-examples/ |
集成示例(车载 / 消费 / 专业) |
external/developer/plugin-guide/ |
XiVST 插件开发指南(规划) |
external/developer/changelog-public.md |
对外变更日志 |
单源多发:D3/D4 中 @public 标记的章节 → 自动生成 external/developer/ 对应页。
6. 命名 / 目录 / 工具链规范
6.1 命名规范(沿用 v1.1 基础上强化)
| 维度 | 规则 |
|---|---|
| 文件名 | 小写连字符(kebab-case · dsp-pipeline.md)· 旧 DSPAlgo_Architecture_v6.md 改 architecture-v7.md |
| 目录名 | 同上 · kebab-case · 前缀 D3- / D4- / D6- 明确层级 |
| 文档编号 | D<n>-<center>-<category>-<seq>(如 D3-ARCH-SYS-001 / D4-IMPL-DSP-009) |
| 版本号 | SemVer(v1.0 / v1.1-draft / v2.0-alpha)· 不再用 _v5 _v6 后缀 |
6.2 与代码目录的 mirror 关系
代码路径 ↔ 文档路径
04_development/backend_csharp/Controllers/ D4-implementation/backend-csharp/controllers/
04_development/frontend_vue3/src/components/ D4-implementation/frontend-vue3/components/
04_development/dsp_algo/dll/ D4-implementation/dsp-algo/dll/
工程纪律:PR modify 代码 → 必须同步更新对应 D4 文档(CI 自动检查)。
6.3 工具链推荐
| 工具 | 用途 |
|---|---|
| MkDocs + Material | 内部站构建(现有) |
| Astro 5.x + Starlight | 对外 developer 子站(建议 · 比现有 xisound-website 的 Astro 4 升级到 5 或另起独立实例) |
| Mermaid | 架构图 / 数据流 / 时序图(沿用 xyL0-xyL5 classDef) |
| PlantUML | 复杂 UML(可选 · MkDocs 插件支持) |
| mermaid-js/mermaid-cli | 本地渲染大图 |
| markdownlint / prettier | Lint + 格式化 |
7. 执行路线图(Rollout Plan)
7.1 三期六批
| 期 | 批 | 内容 | 产出数 | 周期估算 |
|---|---|---|---|---|
| I 基建期 | 整理批 1 | D3/D4/D6 骨架 + nav + 本方案落地 | 25 份骨架 | 1-2 天 |
| 整理批 2 | old-arch-doc/ 定稿 15 份迁移整合 | 15 份迁移 | 2-3 天 | |
| 整理批 3 | 草稿归档 _legacy_arch_drafts/ |
归档+1 README | 1 天 | |
| II 填充期 | 实现批 1 | D4-backend-csharp 10 份标准模板(对齐 04_development/backend_csharp 实际代码) | 10 份 | 3-5 天 |
| 实现批 2 | D4-frontend-vue3 / D4-dsp-algo / D4-pysidecar / D4-web-astro 各 10 份 × 4 栈 = 40 份 | 40 份 | 8-12 天 | |
| III 扩展期 | 扩展批 | D6 测试与运维 20 份 · external/developer 子站 10 份 | 30 份 | 5-7 天 |
总计约 120 份新增文档 · 2-3 个月分批完成。
7.2 决策矩阵(需要您拍板的 5 项)
| # | 拍板项 | 选项 A | 选项 B | 选项 C | 推荐 |
|---|---|---|---|---|---|
| Q1 | D3/D4/D6 在 nav 里的位置 | D3/D4/D6 与 D0-D2 同级 | D3/D4 放 D1-B-rd 下作为子节点 | 新顶级 🔧 Tech Internal 独立组 |
A |
| Q2 | old-arch-doc/ 最终归宿 | 全部迁入 D3/D4(按映射表) | 保留原目录并在 site 中建"旧稿"入口 | 全部删除只保留 v7 版本 | A |
| Q3 | D4 文档与代码的同步机制 | 手工 PR review · 人工检查 | pre-commit hook 强制校验 | CI job 扫描 · 不一致报警 | C |
| Q4 | 对外 developer 子站技术栈 | 继续用 MkDocs Material | 新起 Astro Starlight(开发者文档首选) | GitBook / Docusaurus | B |
| Q5 | 实现批 1-2 由谁主笔 | 每栈 owner 工程师各写各的 | 文档工程专职撰写 + 工程师 review | AI 辅助生成 + 工程师校对 | C(AI + 人校) |
7.3 里程碑(若按推荐方案推进)
gantt
title 技术开发文档体系 v1.0 · 3 个月路线图
dateFormat YYYY-MM-DD
section I 基建期
本方案评审拍板 :milestone, m1, 2026-05-06, 0d
整理批 1 骨架 :a1, 2026-05-07, 2d
整理批 2 迁移 :a2, after a1, 3d
整理批 3 归档 :a3, after a2, 1d
section II 填充期
实现批 1 backend :b1, after a3, 4d
实现批 2 四栈并行 :b2, after b1, 10d
section III 扩展期
扩展批 D6+developer :c1, after b2, 6d
v1.0 定稿发布 :milestone, m2, after c1, 0d
8. 风险与依赖
8.1 主要风险
| 风险 | 应对 |
|---|---|
| 工程师不愿写文档 | 纳入代码 review checklist · CI 强制校验 · D4 模板预置骨架降低写作成本 |
| old-arch-doc/ 内容与当前代码脱节 | 迁移时标 v1.0-draft · 以 2026-05-06 代码为基准 · 发现脱节立即 issue |
| 敏感内容泄漏 | 双轨边界 R1-R3 硬规则 · PR 自查清单新增"敏感度审查"项 |
| 文档与代码双维护负担 | AI 辅助(Claude/Copilot)生成草稿 · 工程师只校对 |
8.2 依赖
- 组织:产品 / 研发 / 商务 / 交付 / 运营 5 个中心 owner 认领本方案
- 工具:MkDocs 1.6+ · Material 9.7+(已有)· 新增 Astro Starlight(规划)
- CI/CD:GitHub Actions / GitLab Runner(待部署)
9. 拍板结果(2026-05-06 · 用户确认)
O1-O10 全部拍板通过
用户于 2026-05-06 一次性拍板通过全部 10 项决策,方案正式从草案升级为 v1.0 · published。
拍板原文:O1=Y, O2=Y, O3=Y, O4=A, O5=A, O6=C, O7=B, O8=C, O9=Y, O10=Y。
9.1 拍板矩阵
| 拍板项 | 结果 | 具体含义 | 落地动作 |
|---|---|---|---|
| O1 | ✅ Y | 双轨分离(内部 D0-D6 vs 对外 external/) | §2 双轨设计生效 |
| O2 | ✅ Y | 七层分治 · 新增 D3 架构 / D4 实现 / D6 测试运维 | §3 七层架构生效 |
| O3 | ✅ Y | D4 文档与代码仓库 1:1 mirror | §6.2 mirror 规则生效 |
| O4 | ✅ A | old-arch-doc/ 33 份全部迁入 D3/D4(按 §4.1 映射表) | 整理批 2 启动 |
| O5 | ✅ A | D3/D4/D6 nav 与 D0-D2 同级(顶级节点) | mkdocs.yml nav 新增 3 个顶级节点 |
| O6 | ✅ C | 文档-代码同步机制:CI job 扫描 · 不一致报警 | 后续 CI/CD 规划落地 |
| O7 | ✅ B | 对外 developer 子站技术栈:Astro Starlight | 扩展批落地 |
| O8 | ✅ C | 实现批主笔模式:AI 辅助生成 + 工程师校对 | 实现批 1-2 工作流生效 |
| O9 | ✅ Y | 先做整理批 1 基建期,再推进 07_web 的 M6.1 部署方案 | 本批次首先执行整理批 1 |
| O10 | ✅ Y | 认可 3 个月约 120 份文档总量 | Phase 4 目标锁定 |
9.2 生效的关键约定
-
顶级 nav 结构(O5=A):
-
old-arch-doc/ 去留(O4=A):完整按 §4.1 映射表迁入 D3/D4,迁移完成后目录整体改名为
_legacy_arch_drafts/仅保留 v5/v6 草稿。 -
开发者子站技术栈(O7=B):沿用但独立于现有
07_web/xisound-website的 Astro 4;新建07_web/developer-starlight/(或同级独立实例)基于 Astro 5 + @astrojs/starlight。 -
主笔模式(O8=C):所有 D4 实现级文档先由 AI 辅助(Claude / Copilot / Codex)基于代码仓库生成草稿,再由对应栈的 owner 工程师校对后合入。
9.3 下一步
- ✅ 本方案升级 v1.0 published(本次 commit 完成)
- ✅ todo-list.md 新增 Phase 4 启动记录 + O1-O10 拍板表 + 3 期 6 批路线
- 🟡 整理批 1 启动中:建 D3-architecture / D4-implementation / D6-testing-ops 三个顶级骨架目录 + 各子目录 index.md + mkdocs.yml nav 挂接
- 🔴 整理批 2 待启动:old-arch-doc/ 定稿 15 份迁入 D3/D4
- 🔴 整理批 3 待启动:v5/v6 草稿归档
- 🔴 任务 B 待启动:07_web M6.1 部署方案(挂入 D3-architecture/deployment-topology/)
10. 附录 · 与现有 221 份文档的关系
- 保持不动:D0-D2(已有 221 份 v1.0+ · 不重写)
- 净增:D3(25)+ D4(60)+ D6(30)+ external/developer(10)≈ 125 份新增
- 整合:old-arch-doc/ 33 份通过迁移进 D3/D4(不重复计数)
- 归档:旧草稿 v5/v6/v7 进
_legacy_arch_drafts/
最终 Xisound 文档体系规模:221 + 125 = 约 346 份(3 个月目标)。
版本历史
| 版本 | 日期 | 变更 |
|---|---|---|
| v1.0-draft | 2026-05-06 | 首次发布草案 · 待评审拍板 10 项 |
| v1.0 | 2026-05-06 | 用户一次性拍板通过 O1-O10 全部 10 项 · 方案正式生效 · Phase 4 启动 |
技术开发文档体系方案 · v1.0 · 2026-05-06 · © Xisound Inc.