第4章 文档命名规范
文件命名规则 · 版本号命名规则 · 日期格式规范
统一的文档命名是信息架构的基石。清晰的命名规则能够提升检索效率、避免版本混乱,并支持自动化工具链。本章从文件命名规则、版本号命名规则和日期格式规范三个维度展开,配合示例与内联示意图。
1. 文件命名规则
推荐采用项目代号_文档类型_描述_版本号的范式。全部使用小写字母,单词间以下划线连接,禁止使用空格及特殊字符。
| 元素 | 规范 | 示例 |
|---|---|---|
| 项目代号 | 2~8位字母/数字,无空格 | tms, docarch |
| 文档类型 | 使用标准缩写 (sd: 概要设计, dd: 详细设计, um: 用户手册) | sd, dd, um, api |
| 描述 | 简明关键词,不超过20字符 | auth-module, data-migration |
| 版本号 | v+主版本.次版本 (见版本号规则) | v1.2, v2.0 |
图4-1 文件命名范式:tms_sd_auth-module_v1.2.md
命名示例
tms_sd_auth-module_v1.2.md— 项目tms,概要设计,认证模块docarch_um_user-guide_v2.0.pdf— 文档架构项目,用户手册api-gw_dd_rate-limit_v0.5.docx— API网关详细设计,限流模块
2. 版本号命名规则
采用语义化版本风格:主版本.次版本.修订号(可选)。主版本号在重大变更时递增,次版本号在功能新增时递增,修订号用于补丁或微小修正。文档草稿阶段可使用 v0.x。
| 版本示例 | 含义 |
|---|---|
| v0.1 | 内部草稿,首次创建 |
| v0.9 | 评审前最终草稿 |
| v1.0 | 首次正式发布 |
| v1.2 | 次要更新(新增章节) |
| v2.0 | 重大重构或架构变更 |
图4-2 版本号递进路径:从草稿到正式发布
版本号嵌入文件名
# 推荐格式 tms_sd_auth-module_v1.2.docx # 内部评审版本 tms_sd_auth-module_v0.9-review.docx # 带修订号 (补丁) tms_um_quickstart_v1.0.1.pdf
3. 日期格式规范
所有文档元数据、修订记录及文件名中的日期,统一采用 ISO 8601 扩展格式:YYYY-MM-DD。避免使用中文格式或斜杠分隔。
| 场景 | 正确示例 | 错误示例 |
|---|---|---|
| 修订记录日期 | 2025-03-27 | 2025/03/27 或 2025年3月27日 |
| 文件名内嵌日期 | tms_sd_review_2025-03-27_v0.9 | tms_sd_review_20250327_v0.9 |
| 文档封面日期 | 2025-03-27 | 27-03-2025 |
图4-3 日期格式:统一使用连字符 YYYY-MM-DD
日期在文件名中的使用
当日期作为文件名一部分时,建议放在版本号之前,例如:
tms_sd_review_2025-03-27_v0.9.docx docarch_um_2025-04-01_v2.1.pdf
避免使用 20250327 等紧凑格式,连字符可读性更优。