优化竞品分析的文档结构

This commit is contained in:
2026-05-02 12:17:02 +08:00
parent 0e8778a8dc
commit 0cfb264da6
3 changed files with 10 additions and 7 deletions

View File

@@ -10,7 +10,8 @@ docs/
├── README.md # 本文件 — 目录标准与使用规范
├── architecture/ # 架构级方案(分层、模块、技术选型、组件架构)
├── conventions/ # 项目约定编码规范、命名、Git 工作流)
── specs/ # 系统级技术规范API 设计、数据模型、接口协议)
── specs/ # 系统级技术规范API 设计、数据模型、接口协议)
└── reference/ # 参考分析文档(竞品拆解、行业研究、设计参考)
```
## 文档命名规范
@@ -28,7 +29,7 @@ docs/
---
id: DOC-NNN
title: 文档标题(中文)
type: architecture | convention | spec
type: architecture | convention | spec | reference
status: draft | review | stable | deprecated
created: YYYY-MM-DD
updated: YYYY-MM-DD
@@ -38,7 +39,7 @@ related_changelogs: [CL-xxx, CL-xxx]
字段说明:
- `id`:与文件名编号一致
- `type`architecture架构、convention规范、spec技术规范
- `type`architecture架构、convention规范、spec技术规范、reference参考分析
- `status`draft草稿、review审查中、stable已定稿、deprecated已废弃
- `related_changelogs`:关联的 changelog 锚点 ID 列表,用于溯因
@@ -54,6 +55,7 @@ related_changelogs: [CL-xxx, CL-xxx]
| 调整了目录结构或模块划分 | 更新 architecture 文档 |
| 设计或修改了 UI/交互标准 | 创建/更新 architecture 文档 |
| 定义了 API 接口、数据模型、通信协议 | 创建/更新 specs 文档 |
| 完成了竞品分析、行业调研、设计参考的深度研究 | 创建/更新 reference 文档 |
| 约定被废弃或替换 | 标记为 deprecated写明替代文档编号 |
## 更新与维护