Tricoder/doc/规范/文档规范.md

文档规范

版本号：v0.1.1 最后更新：2026-04-04 14:30

1. 目的

本规范用于约束项目文档的命名、头部元信息和更新方式，保证后续讨论内容可以随时沉淀为一致、可追踪的正式文档。

2. 文件命名规则

• 文档文件名必须使用中文。
• 文档文件名应直接表达主题，避免使用含糊名称。
• 文件扩展名统一为 .md。

示例：

• 音频优先移动信号实验室方案.md
• 算法链分层设计.md
• 实验编排接口规范.md

3. 文档头部必填项

每份正式文档开头必须包含以下字段：

• 文档标题
• 版本号
• 最后更新日期

推荐格式：

# 文档标题

版本号：v0.1.0
最后更新：2026-04-04 14:30

4. 版本号规则

• 版本号采用 v主版本.次版本.修订版本 格式。
• 大范围结构调整或结论变化时，提升主版本或次版本。
• 小幅补充、修正措辞或补充细节时，提升修订版本。

示例：

• v0.1.0：初稿
• v0.2.0：新增章节或明显调整结构
• v0.2.1：小修订

5. 日期时间规则

• 最后更新 使用 YYYY-MM-DD HH:mm 格式。
• 时间使用项目当前使用者所在时区。
• 每次修改文档内容时，必须同步更新 最后更新。

6. 内容风格

• 以中文为主。
• 优先写清目标、边界、结构、约束和下一步。
• 尽量避免空泛描述，优先使用可落地的定义、流程和数据结构。
• 当文档涉及工程实现时，应说明适用范围和不适用范围。

7. 推荐章节结构

按需选择，但建议优先包含以下内容：

1. 目的
2. 背景
3. 核心定义
4. 系统结构或流程
5. 约束与边界
6. 实施建议
7. 后续工作

8. 兼容说明

• 现有历史文档如果暂未改名，可暂时保留。
• 从本规范生效起，新文档必须遵守本规范。
• 是否批量整理历史英文文档，后续单独决策。