文档编号与命名规范 v1.0
本规范定位
规定 Xisound 公司所有文档的文件名格式、编号规则、类型代码、版本号约定。
所有 .md / .pdf / .docx / .pptx / .xlsx 文件入库前必须按本规范命名。
1. 文档编号总格式
示例:
D0-00-STRAT-001-公司愿景与使命 v1.0.md
D1-B-SPEC-003-软件开发规范 v2.1.md
D2-P1-PRD-001-XiStudio产品需求文档 v1.0.md
D3-MEET-20260115-产品周会纪要.md
2. 层级代码
| 层级 | 含义 | 可见范围 |
|---|---|---|
D0 |
公司级(Company) | 全员可见 |
D1 |
中心级(Division) | 中心内部 |
D2 |
业务级(Business / Product) | 项目组 |
D3 |
执行级(Execution / Daily) | 个人/小组 |
3. 中心 / 产品代码
3.1 D0 公司级 · 子模块代码
| 代码 | 子模块 | 状态 |
|---|---|---|
00 |
愿景与战略 | ✅ 启用 |
01 |
品牌与 VI | ✅ 启用 |
02 |
制度与文化 | ✅ 启用 |
03 |
融资与法务 | ✅ 启用 |
04 |
公关与市场(PR / 展会 / 媒体 / IR) | 🟡 Phase 2 启用 |
05 |
跨中心通用规范 | ✅ 启用 |
3.2 D1 中心级 · 六大中心代码
| 代码 | 中心 |
|---|---|
A |
产品中心 |
B |
研发中心 |
C |
商务中心 |
D |
交付中心 |
E |
战略中心 |
F |
运营中台 |
3.3 D2 业务级 · 九大产品代码
| 代码 | 产品 | 层 |
|---|---|---|
P1 |
XiStudio | L4 |
P2 |
XiDSP | L0 |
P3 |
XiAmp | L1 |
P4 |
XiBox | L1 |
P5 |
XiAlgo | L3 |
P6 |
XiTune | L2 |
P7 |
XiTest | L2 |
P8 |
XiMind | L5 |
P9 |
XiForge | L4 |
4. 类型代码
| 代码 | 类型 | 英文 | 说明 |
|---|---|---|---|
STRAT |
战略类 | Strategy | 愿景、战略规划、路线图 |
SPEC |
规范/规格类 | Specification | 产品规格书、技术规范 |
PRD |
产品需求 | Product Requirement | 需求文档 |
TECH |
技术文档 | Technical | 架构设计、API 文档 |
PROC |
流程文档 | Process | 操作流程、SOP |
TMPL |
模板文档 | Template | 可复用的模板 |
MEET |
会议纪要 | Meeting | 各类会议记录 |
RPT |
报告 | Report | 周报、月报、季报 |
MAN |
手册 | Manual | 用户手册、操作手册 |
POL |
制度政策 | Policy | 公司制度、章程 |
ADR |
决策记录 | Decision Record | 技术/管理决策存档 |
5. 版本号规则
v0.x → 草稿阶段(未发布)
v1.0 → 首次正式发布
v1.x → 小版本更新(bug 修复、勘误、增量)
v2.0 → 重大修订(结构调整、内容重写)
v3.0 → 三年级大版本(品牌升级、战略换挡)
规则:
- 版本号与文件名同步,每次重大更新都改文件名
- 草稿文件保留在
drafts/子目录,v0.x禁止入库主流程 - 历史版本归档在
archive/目录,不删除源文件 - 重大修订(v2.0)的 PR 必须附变更说明(CHANGELOG)
6. 示例对照
| 原始需求 | 规范命名 |
|---|---|
| 算法部要写一份 XiDSP 的芯片设计文档 | D2-P2-TECH-001-XiDSP芯片设计文档 v1.0.md |
| 产品中心 PRD 模板 | D1-A-TMPL-001-PRD模板 v1.0.md |
| 2026-01-15 的产品周会纪要 | D3-MEET-20260115-产品周会纪要.md |
| 研发中心的软件开发规范(已更新到第二版第一次修订) | D1-B-SPEC-003-软件开发规范 v2.1.md |
| Xisound 3 年战略规划 | D0-00-STRAT-002-3年战略规划 v1.0.md |
7. 特殊情况处理
7.1 临时性文档
短期临时文档(不计入长期归档)可在 tmp/ 目录使用简单命名,不强制遵循编号规则,但必须在 30 天内归档或删除。
7.2 翻译文档
翻译版本在版本号前加语言代码:
D0-00-STRAT-001-公司愿景与使命 v1.0.md # 中文原版
D0-00-STRAT-001-Vision and Mission v1.0-en.md # 英文版
D0-00-STRAT-001-企業ビジョン v1.0-ja.md # 日文版
7.3 多文件组成的文档包
产品文档包(P1-P9)可以用目录组织,目录名用编号前缀,内部文件用相对简单的名字:
D2-products/P1-xistudio/
├── index.md # 产品总览
├── overview.md # P1-01
├── prd.md # P1-02
├── spec-sheet.md # P1-03
├── tech-arch.md # P1-04
├── api-reference.md # P1-05
└── ...
8. MkDocs 站点路径映射
8.1 目录路径规则
在 MkDocs 文档站中,为了 URL 美观和维护,文件路径使用英文 kebab-case,编号只体现在目录前缀上:
| 长格式编号 | 实际文件路径 |
|---|---|
D0-00-STRAT-001-公司愿景与使命 v1.0.md |
docs/D0-company/00-vision/vision-mission.md |
D1-B-SPEC-036-技术文档写作规范 v1.0.md |
docs/D0-company/05-standards/md-writing-spec.md |
D2-P1-PRD-001-XiStudio产品需求文档 v1.0.md |
docs/D2-products/P1-xistudio/prd.md |
8.2 frontmatter 里保留完整编号
为了可追溯性,在文档的 frontmatter 里记录完整编号:
---
title: Xisound 公司愿景与使命
doc_id: 01.00.001 # IA-v3 编号 (P2.8 之后)
legacy_doc_id: D0-00-STRAT-001 # 旧 D-system 编号 (追溯)
version: v1.0
...
---
8.3 IA-v3 doc_id 编码规则(P2.8 · 2026-05-13 启用)
重要更新
P2.8 之后,doc_id 不再使用旧的 D[0-3]-... 格式(那是 v1.0 规划文档的内容编号方式,与 IA-v3 的目录结构严重错位)。新格式与目录路径严格 1:1 同构,看到 doc_id 就能立即定位到目录。
8.3.1 总格式
- 3 段 · 点号
.分隔 · 全数字(仅 P1-P11 产品代码 + A/B/C/D/F 部门代码 + FD format-demo 代码保留字母) - 位数固定:L1 = 2 位、L2 = 2 位(或 P/字母代码)、SEQ = 3 位
- 看到 doc_id 立刻能映射到 docs/ 目录路径
8.3.2 L1 编码(一级 IA 目录前缀)
| IA 目录 | L1 |
|---|---|
00-home/ |
00 |
01-strategy/ |
01 |
02-products/ |
02 |
03-platform/ |
03 |
04-departments/ |
04 |
05-standards/ |
05 |
06-customer/ |
06 |
07-engineering/ |
07 |
08-implementation/ |
08 |
09-testing-ops/ |
09 |
99-archive/ |
99 |
8.3.3 L2 编码(二级目录前缀,与目录名严格对应)
纯数字段(直接取目录的 NN- 前缀):
| 路径 | L2 |
|---|---|
01-strategy/00-vision/ |
00 |
01-strategy/01-brand/ |
01 |
01-strategy/02-policies/ |
02 |
01-strategy/03-finance/ |
03 |
01-strategy/04-pr-market/ |
04 |
01-strategy/05-strategy-center/ |
05 |
03-platform/10-architecture/ |
10 |
03-platform/20-backend/ |
20 |
03-platform/30-frontend/ |
30 |
03-platform/40-dsp-algo/ |
40 |
03-platform/50-data-model/ |
50 |
03-platform/60-protocol/ |
60 |
03-platform/70-deployment/ |
70 |
06-customer/10-demos/ |
10 |
06-customer/20-downloads/ |
20 |
06-customer/30-products/ |
30 |
06-customer/40-support/ |
40 |
08-implementation/10-dsp-algo/ |
10 |
08-implementation/20-backend-csharp/ |
20 |
08-implementation/30-frontend-vue3/ |
30 |
08-implementation/40-pysidecar/ |
40 |
08-implementation/50-web-astro/ |
50 |
08-implementation/60-algorithms/ |
60 |
99-archive/legacy-v1-spec/ |
LV1S |
99-archive/legacy-v1-product-matrix/ |
LV1P |
99-archive/legacy-v1-doc-system/ |
LV1D |
99-archive/work-cline/ |
WC |
字母段(保留作为身份标识,已被 §3.2 / §3.3 规范定义):
| 路径 | L2 | 来源 |
|---|---|---|
02-products/P1-xistudio/ |
P1 |
§3.3 产品代码 |
02-products/P2-xidsp/ |
P2 |
§3.3 |
02-products/P3-xiamp/ |
P3 |
§3.3 |
02-products/P4-xibox/ |
P4 |
§3.3 |
02-products/P5-xialgo/ |
P5 |
§3.3 |
02-products/P6-xitune/ |
P6 |
§3.3 |
02-products/P7-xitest/ |
P7 |
§3.3 |
02-products/P8-ximind/ |
P8 |
§3.3 |
02-products/P9-xiforge/ |
P9 |
§3.3 |
02-products/P10-xivst/ |
P10 |
§3.3 |
02-products/P11-xiprobe/ |
P11 |
§3.3 |
04-departments/a-product/ |
A |
§3.2 中心代码(大写) |
04-departments/b-rd/ |
B |
§3.2 |
04-departments/c-business/ |
C |
§3.2 |
04-departments/d-delivery/ |
D |
§3.2 |
04-departments/f-ops/ |
F |
§3.2 |
05-standards/format-demo/ |
FD |
format-demo 缩写 |
无二级目录的(顶层 .md):L2 段省略或写作 00,由具体实现脚本决定(推荐:省略 L2,doc_id 退化为 2 段 [L1].[SEQ])
| 路径 | doc_id |
|---|---|
00-home/index.md |
00.001 |
05-standards/md-writing-spec.md |
05.005(按字母序连续编号) |
07-engineering/adr-tmpl.md |
07.002 |
09-testing-ops/index.md |
09.001 |
8.3.4 SEQ 编码(文件序号)
按文件路径在所属 L2 目录内的字母序自动连续编号,从 001 开始,3 位数字。
约定:
- index.md 永远是 001
- 其他文件按文件名(含 NN- 前缀)字母序自动从 002 开始递增
8.3.5 完整示例
| 路径 | 新 doc_id(IA-v3) | 旧 doc_id(legacy) |
|---|---|---|
00-home/index.md |
00.001 |
D0-HOME-001 |
01-strategy/00-vision/index.md |
01.00.001 |
D0-00-VISION-INDEX-001 |
01-strategy/00-vision/vision-mission.md |
01.00.002 |
D0-00-STRAT-001 |
02-products/P1-xistudio/index.md |
02.P1.001 |
D2-P1-INDEX-001 |
02-products/P1-xistudio/00-overview.md |
02.P1.002 |
D2-P1-OVERVIEW-001 |
02-products/P1-xistudio/10-prd.md |
02.P1.003 |
D2-P1-PRD-001 |
02-products/P11-xiprobe/30-architecture.md |
02.P11.002 |
D2-P11-TECH-001 |
03-platform/10-architecture/00-overview.md |
03.10.002 |
D3-ARCH-001 |
04-departments/B-rd/00-charter.md |
04.B.002 |
D1-B-CHARTER-001 |
04-departments/B-rd/quality/8d-problem-solving.md |
04.B.012(quality/ 子目录扁平化进 L2) |
— |
05-standards/md-writing-spec.md |
05.010 |
D0-05-DOC-NUM-001 |
05-standards/format-demo/01-format-demo-styleA-stripe.md |
05.FD.002 |
— |
08-implementation/10-dsp-algo/modules/mixer.md |
08.10.013(modules/ 子目录扁平化进 L2) |
— |
99-archive/legacy-v1-spec/md-style-guide.md |
99.LV1S.006 |
— |
8.3.6 三级目录处理(扁平化)
02-products/P*/_dev/、04-departments/b-rd/quality/、08-implementation/10-dsp-algo/modules/ 等三级目录的文件不引入 L3 段,而是把它们当作 L2 的内部文件,按全路径字母序在 L2 内连续编号。
为什么不加 L3: - 保持 doc_id 总是 3 段(最多 3 段),简洁好记 - 三级目录数量有限(quality/、modules/、_dev/ 等),扁平化后不会冲突 - 工程化优先:业务上"04.B.012 是部门 B 内的某文档"已足够定位,不必精确到三级目录
8.3.7 frontmatter 双字段示例
---
doc_id: 02.P1.003 # IA-v3 编号 (P2.8 之后) ⭐ 新主键
legacy_doc_id: D2-P1-PRD-001 # 旧 D-system 编号 (P2.8 之前的)
title: XiStudio 产品需求文档
...
---
新增文档时只填 doc_id,无需填 legacy_doc_id(仅迁移文档保留,作为追溯历史用)。
8.4 编号生命周期
- doc_id 不可变:一旦分配,doc_id 永久绑定该文档(即使将来移动目录也保留原 doc_id 不变)
- 目录调整时:新位置的 doc_id 仍按原值,但物理路径与 doc_id 可能不再 1:1 同构(接受这种"历史包袱")
- 新增文档:按 §8.3 规则生成新 doc_id,从该 L2 目录当前最大 SEQ 加 1
- 删除文档:doc_id 不复用(避免历史链接歧义)
附录 A · 参考
- V1.0 规划原始定义:
AlgoDepartment/06_docs/Xisound-羲音 初创公司文档体系架构规划 V1.0.md§6 - MD 写作规范:md-writing-spec.md
doc-numbering.md · v1.0 · 2026-05-05 · Xisound AlgoDepartment