1.5 KiB
1.5 KiB
name, description, type, originSessionId
| name | description | type | originSessionId |
|---|---|---|---|
| docs 文件命名规则 | docs 目录下 .md 文件的分类前缀命名规范(编号前缀 + 分类前缀) | feedback | 5f751a38-a1d3-40a9-bfb3-723b1ab129bf |
docs/ 目录下所有 .md 文件使用分类前缀 + 中文描述的命名规范。前缀表示文档类别,描述部分避免与前缀重复。
命名规则:
- 核心文档:
01-~08-编号前缀(按 README 索引顺序)- 01-用户需求、02-产品需求、03-功能列表、04-用户故事、07-系统架构、08-数据库设计、11-工程规范、09-API契约
- 设计文档:
设计-前缀(如 设计-Apple风格.md、05-设计-UI.md、06-设计-UX.md) - 评审文档:
评审-前缀(位于 review/ 目录,如 评审-需求综合.md、评审-复评.md) - 管理文档:
管理-前缀(如 12-管理-项目.md、管理-部署实施.md、管理-开发入门.md) - 运维文档:
运维-前缀(如 运维-安全审计.md、运维-故障排除.md、运维-性能基准.md) - 测试文档:
测试-前缀(如 10-测试-方案.md、测试-单元.md、测试-端到端.md)
Why: 用户要求按分类对 docs/ 文件进行系统化命名,便于快速识别文档类型。
How to apply: 创建新文档时根据其类别添加对应前缀。描述部分使用中文,避免与前缀重复(如 "测试-单元.md" 而非 "测试-单元测试.md")。仅 UI/UX 等通用缩写可在描述中保留英文。