文档编号与命名规范 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 里记录完整编号:
附录 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