Skip to content

Commit b6798f8

Browse files
committed
feat:修复文档规范
1 parent f841c17 commit b6798f8

8 files changed

Lines changed: 96 additions & 1132 deletions

STATUS.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@
2626

2727
| 版本 | 发布状态 | 发布日期 | 需求数 | 进度 |
2828
|------|---------|---------|--------|------|
29-
| [v1.4.0](#v140) | 📋 规划中 | 2026-01-15 | 1 | 0/1 未开始 |
3029
| [v1.5.0](#v150) | 📋 规划中 | 2026-02-28 | 1 | 0/1 未开始 |
3130
| [v1.6.0](#v160) | 📋 规划中 | 2026-03-31 | 1 | 0/1 未开始 |
31+
| [v1.4.0](#v140) | ❌ 已取消 | 2025-12-16 | 1 | 已取消 |
3232
| [v1.3.0](#v130) | ✅ 已完成 | 2025-12-12 | 1 | 1/1 完成 |
3333
| [v1.2.0](#v120) | 🚧 开发中 | 2025-12-15 | 3 | 3/3 进行中 |
3434
| [v1.1.0](#v110) | ✅ 已发布 | 2025-12-03 | 1 | 1/1 完成 |
@@ -39,20 +39,23 @@
3939

4040
## v1.4.0
4141

42-
**发布状态**: 📋 规划中
43-
**发布日期**: 2026-01-15
42+
**发布状态**: ❌ 已取消
43+
**取消日期**: 2025-12-16
4444
**版本类型**: 次版本(MINOR)
4545

4646
| 需求标题 | 状态 | 优先级 | 详细 |
4747
|---------|------|--------|------|
48-
| 短ID支持(ObjectId压缩编码) | 📋 规划中 | P0 | [详细](./plans/short-id-direct-replacement.md) |
48+
| 短ID支持(ObjectId压缩编码) | ❌ 已取消 | P0 | [方案](./plans/requirements/req-short-id-objectid-compression-v1.4.md) \| [分析](./reports/monSQLize/analysis/objectid-compression-feasibility-analysis-v1.4.md) |
4949

50-
**进度**: 1个需求 | 0个已完成
50+
**进度**: 1个需求 | 已取消
5151

52-
**变更摘要**:
53-
- ObjectId压缩编码(Base62),24字符→16字符
54-
- 零依赖,纯JS实现
55-
- 100%无损转换,保留时间戳和可排序性
52+
**取消原因**:
53+
- ❌ 性能严重下降(批量查询-1500%,聚合-3000%)
54+
- ❌ MongoDB生态完全不兼容(所有官方工具失效)
55+
- ❌ 存储空间不减反增(+42%,与初衷相反)
56+
- ❌ 技术债务高(长期维护负担重)
57+
58+
**详细分析**: [可行性分析报告](./reports/monSQLize/analysis/objectid-compression-feasibility-analysis-v1.4.md)
5659

5760
---
5861

plans/README.md

Lines changed: 84 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -9,57 +9,102 @@
99

1010
```
1111
plans/
12-
├── TEMPLATE.md # 需求文档模板
1312
├── README.md # 本文件
14-
├── req-xxx.md # 新功能需求
15-
├── bug-xxx.md # Bug 修复
16-
├── opt-xxx.md # 性能优化
17-
├── ref-xxx.md # 代码重构
18-
├── sec-xxx.md # 安全加固
19-
├── db-xxx.md # 数据库变更
20-
└── api-xxx.md # API 开发
13+
├── TEMPLATE.md # 需求文档模板
14+
├── requirements/ # 新功能需求
15+
│ └── req-xxx-v{版本}.md
16+
├── bugs/ # Bug 修复
17+
│ └── bug-xxx-v{版本}.md
18+
├── optimizations/ # 性能优化
19+
│ └── opt-xxx-v{版本}.md
20+
├── refactoring/ # 代码重构
21+
│ └── ref-xxx-v{版本}.md
22+
├── security/ # 安全加固
23+
│ └── sec-xxx-v{版本}.md
24+
├── database/ # 数据库变更
25+
│ └── db-xxx-v{版本}.md
26+
├── api/ # API 开发
27+
│ └── api-xxx-v{版本}.md
28+
└── scripts/ # 脚本开发
29+
└── script-xxx-v{版本}.md
2130
```
2231

32+
🔴 **强制规则**
33+
- ❌ 禁止在 plans/ 根目录直接创建文档(除 README.md 和 TEMPLATE.md)
34+
- ✅ 所有文档必须按类型分类到对应子目录
35+
- ✅ 所有文档文件名必须包含版本号(-v{版本号}.md)
36+
2337
---
2438

2539
## 🏷️ 文件命名规范
2640

27-
### 命名格式
41+
### 命名格式(强制版本号后置)
2842

29-
`{类型前缀}-{功能描述}.md`
43+
🔴 **强制格式**: `{类型前缀}-{功能描述}-v{版本号}.md`
3044

31-
### 类型前缀
45+
**示例**:
46+
```
47+
req-watch-feature-v1.4.md # 新功能需求(v1.4实施)
48+
bug-cache-memory-leak-v1.3.md # Bug修复(v1.3修复)
49+
opt-query-performance-v1.5.md # 性能优化(v1.5实施)
50+
```
51+
52+
**版本号规则**:
53+
- ✅ 必须添加版本号 - 所有文档都必须有版本号
54+
- ✅ 版本号后置 - 版本号必须在文件名末尾(-v{版本号}.md)
55+
- ✅ 使用实施版本 - 版本号对应该需求首次计划或实施的版本
56+
- ✅ 格式标准 - vX.Y 或 vX.Y.Z(如 v1.4、v1.4.1)
57+
- ✅ 短横线连接 - 使用 -v1.4.md 而不是 _v1.4.md
58+
59+
**禁止格式**:
60+
```
61+
❌ req-watch-feature.md # 缺少版本号
62+
❌ req-v1.4-watch-feature.md # 版本号在中间
63+
❌ v1.4-req-watch-feature.md # 版本号在开头
64+
❌ req-watch-feature_v1.4.md # 使用下划线
65+
✅ req-watch-feature-v1.4.md # 正确格式
66+
```
3267

33-
| 前缀 | 说明 | 示例 |
34-
|------|------|------|
35-
| req- | 新功能需求 | req-watch-feature.md |
36-
| bug- | Bug 修复 | bug-cache-memory-leak.md |
37-
| opt- | 性能优化 | opt-query-performance.md |
38-
| ref- | 代码重构 | ref-transaction-manager.md |
39-
| sec- | 安全加固 | sec-sql-injection-fix.md |
40-
| db- | 数据库变更 | db-add-index.md |
41-
| api- | API 开发 | api-new-endpoints.md |
68+
### 类型前缀(必须使用)
4269

43-
### 命名规则
70+
| 前缀 | 说明 | 保存目录 | 命名示例 |
71+
|------|------|---------|---------|
72+
| req- | 新功能需求 | plans/requirements/ | req-watch-feature-v1.4.md |
73+
| bug- | Bug 修复 | plans/bugs/ | bug-cache-memory-leak-v1.3.md |
74+
| opt- | 性能优化 | plans/optimizations/ | opt-query-performance-v1.5.md |
75+
| ref- | 代码重构 | plans/refactoring/ | ref-transaction-manager-v1.4.md |
76+
| sec- | 安全加固 | plans/security/ | sec-sql-injection-fix-v1.6.md |
77+
| db- | 数据库变更 | plans/database/ | db-add-index-v1.4.md |
78+
| api- | API 开发 | plans/api/ | api-new-endpoints-v1.5.md |
79+
| script- | 脚本开发 | plans/scripts/ | script-data-migration-v1.4.md |
80+
81+
### 功能描述命名规则
4482

4583
- ✅ 全小写英文
4684
- ✅ 连字符分隔
47-
- ✅ 20个字符以内
85+
- ✅ 20个字符以内(不含版本号)
4886
- ✅ 描述准确简洁
49-
- ❌ 禁止纯编号(如 req-001.md)
50-
- ❌ 禁止中文(如 req-监听功能.md)
87+
- ❌ 禁止纯编号(如 req-001-v1.4.md)
88+
- ❌ 禁止中文(如 req-监听功能-v1.4.md)
89+
- ❌ 禁止无版本号(如 req-watch-feature.md)
5190

5291
---
5392

5493
## 📝 创建需求文档
5594

56-
### 步骤1:复制模板
95+
### 步骤1:确定版本号和类型
96+
97+
- **类型**: 根据需求选择类型前缀(req-/bug-/opt-等)
98+
- **版本号**: 使用计划实施的版本号(如 v1.4、v1.5)
99+
100+
### 步骤2:复制模板
57101

58102
```bash
59-
cp plans/TEMPLATE.md plans/req-your-feature.md
103+
# 复制到对应子目录
104+
cp plans/TEMPLATE.md plans/requirements/req-your-feature-v1.4.md
60105
```
61106

62-
### 步骤2:填充内容
107+
### 步骤3:填充内容
63108

64109
必须填充的章节:
65110
- ✅ 需求概述
@@ -69,17 +114,17 @@ cp plans/TEMPLATE.md plans/req-your-feature.md
69114
- ✅ 影响范围
70115
- ✅ 验证方式
71116

72-
### 步骤3:添加到 STATUS.md
117+
### 步骤4:添加到 STATUS.md
73118

74119
在对应版本表格添加一行:
75120

76121
```markdown
77122
| 需求标题 | 状态 | 优先级 | 详细 |
78123
|---------|------|--------|------|
79-
| 监听功能 | 🚧 开发中 | P1 | [详细](plans/req-watch-feature.md) |
124+
| 监听功能 | 🚧 开发中 | P1 | [详细](plans/requirements/req-watch-feature-v1.4.md) |
80125
```
81126

82-
### 步骤4:更新状态
127+
### 步骤5:更新状态
83128

84129
开发进度更新:
85130
- 💡 提议 → 📋 计划中 → 🚧 开发中 → ✅ 已完成
@@ -95,11 +140,19 @@ CHANGELOG.md(版本摘要)
95140
96141
STATUS.md(版本需求列表)
97142
98-
plans/req-xxx.md(需求详细)
143+
plans/{类型}/xxx-v{版本}.md(需求详细)
99144
```
100145

101146
### 反向追溯(开发视角)
102147

148+
```
149+
plans/{类型}/xxx-v{版本}.md(需求详细)
150+
151+
STATUS.md(更新实施状态)
152+
153+
CHANGELOG.md(记录变更摘要)
154+
```
155+
103156
```
104157
plans/req-xxx.md
105158

0 commit comments

Comments
 (0)