D1 · Training · Doc Standards
文档规范培训材料
Xisound Documentation Standards Training · Skeleton
3
核心规范
2
天课程
1
实操 PR
文档规范培训材料
摘要
面向全员的文档规范培训（2 天精简版）· 确保所有员工掌握 Xisound 文档体系的基本写作与提交规范。 核心三规范：MD 写作 v1.1 / 文档编号命名 / PR 自查清单。 骨架版说明：仅给出课程大纲，详细示例、反面案例、练习题待补充。
1. 培训对象
- 必修：所有会写文档的员工（研发 / 产品 / 商务 / 交付 / 运营）
- 推荐：管理者（理解文档体系便于审核）
2. 三大核心规范
| # | 规范 | 参考文档 |
|---|---|---|
| S1 | MD 写作规范 v1.1 | md-writing-spec |
| S2 | 文档编号与命名 | doc-numbering |
| S3 | PR 自查清单 | checklist |
3. 两天课程
| Day | 主题 |
|---|---|
| D1 上午 | MD 写作规范（frontmatter / Admonition / Mermaid） |
| D1 下午 | 文档编号命名实战 |
| D2 上午 | PR 自查清单 + 品牌色彩 v1.1 |
| D2 下午 | 实操：提交一个合格文档 PR |
4. 合格产出
结业标准
- 独立提交 1 个文档 PR 并通过 Review
- 笔试：frontmatter 全字段、Admonition 8+1 种、产品名 14 个唯一拼写
5. 配套资源
版本历史
| 版本 | 日期 | 变更 |
|---|---|---|
| v1.0-draft | 2026-05-06 | 首次发布骨架版 · 练习题与反面案例待补充 |
文档规范培训材料 · v1.0-draft · 2026-05-06 · © Xisound Inc.