wurenzhi/makemd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
888d3844f33f6e0de2d7cf8f42f13665c104414b
makemd/docs/00_Business/TASKS_IMPROVEMENT_PLAN.md

250 lines
8.4 KiB
Markdown
Raw Normal View History

refactor(terminology): 统一术语标准并优化代码类型安全 - 将B2B统一为TOB术语 - 将状态值统一为大写格式 - 优化类型声明，避免使用any - 将float类型替换为decimal以提高精度 - 新增术语标准化文档 - 优化路由结构和菜单分类 - 添加TypeORM实体类 - 增强加密模块安全性 - 重构前端路由结构 - 完善任务模板和验收标准
2026-03-20 09:43:50 +08:00
# Tasks 目录改进计划
> **审查日期**: 2026-03-20
> **审查范围**: docs/00_Business/tasks 目录（51个任务文档）
> **审查标准**: 术语一致性、格式规范性、内容完整性、依赖关系准确性
---
## 一、问题汇总
### 1.1 术语不一致问题 🔴 P0
| 问题类型 | 涉及文件 | 具体问题 | 影响 |
|---------|-----------|-----------|------|
| B2B/B2C vs TOB/TOC | BE-TOB001~003, AI-TOB001~003 | 使用 `B2B / TOB` 混用 | 术语混乱 |
| merchant_id vs tenantId | 多个文档 | 字段命名不一致 | 代码实现困惑 |
| Admin vs ADMIN | 21_customer_service.md, 15_auth.md | 角色命名大小写不一致 | 权限系统混乱 |
### 1.2 任务ID格式不一致 🟡 P1
| 问题类型 | 示例 | 标准格式 | 影响 |
|---------|-------|---------|------|
| 核心服务任务ID重复 | BE-CS001 (核心服务) vs BE-CS001 (客户服务) | BE-CORE-XXX | 任务追踪混乱 |
| 文档任务ID格式 | BE-DOC001 | BE-DOC-XXX | 格式不统一 |
### 1.3 文档格式不一致 🟡 P1
| 问题类型 | 涉及文件 | 具体问题 | 影响 |
|---------|-----------|-----------|------|
| 缺少"完成时间"列 | 04_finance.md, 05_inventory.md 等 | 表格列不完整 | 信息不完整 |
| 缺少数据库表结构 | 大部分backend任务 | 无表结构定义 | 开发困难 |
| 缺少API端点定义 | 大部分backend任务 | 无API定义 | 开发困难 |
| 依赖关系描述不统一 | 所有文档 | 文字/箭头/代码块混用 | 可读性差 |
### 1.4 内容完整性问题 🟡 P1
| 问题类型 | 涉及文件 | 具体问题 | 影响 |
|---------|-----------|-----------|------|
| 缺少验收标准 | 所有任务 | 无明确的验收标准 | 质量控制困难 |
| 缺少测试要求 | 所有任务 | 无测试用例要求 | 质量保障不足 |
| 缺少风险提示 | 所有任务 | 无风险识别 | 项目风险高 |
### 1.5 状态标记问题 🟢 P2
| 问题类型 | 涉及文件 | 具体问题 | 影响 |
|---------|-----------|-----------|------|
| 所有任务标记为completed | 所有任务 | 实际可能未完成 | 进度追踪不准确 |
---
## 二、改进任务表
### P0 - 立即修复（阻塞问题）
| 任务ID | 问题描述 | 涉及文件 | 改进方向 | 预计耗时 |
|-------|---------|-----------|---------|---------|
| IMP-P0-001 | 统一 B2B/B2C 为 TOB/TOC | BE-TOB001~003, AI-TOB001~003 | 全局替换术语 | 1h |
| IMP-P0-002 | 统一 merchant_id 为 tenantId | 所有backend任务 | 全局替换字段名 | 2h |
| IMP-P0-003 | 统一角色命名（Admin → ADMIN） | 21_customer_service.md, 15_auth.md | 统一为大写 | 0.5h |
| IMP-P0-004 | 修复核心服务任务ID冲突 | 20_core_service.md, 21_customer_service.md | 重命名 BE-CS001~004 为 BE-CORE-XXX | 0.5h |
### P1 - 短期改进（重要问题）
| 任务ID | 问题描述 | 涉及文件 | 改进方向 | 预计耗时 |
|-------|---------|-----------|---------|---------|
| IMP-P1-001 | 统一文档表格格式（添加完成时间列） | 04_finance.md, 05_inventory.md 等20个文件 | 补充缺失列 | 2h |
| IMP-P1-002 | 统一依赖关系描述格式 | 所有任务文档 | 统一使用箭头图示 | 3h |
| IMP-P1-003 | 为所有任务添加验收标准 | 所有任务文档 | 添加验收标准章节 | 8h |
| IMP-P1-004 | 为所有任务添加测试要求 | 所有任务文档 | 添加测试要求章节 | 6h |
| IMP-P1-005 | 为P0/P1任务添加风险提示 | 所有P0/P1任务 | 添加风险提示章节 | 4h |
| IMP-P1-006 | 为backend任务添加数据库表结构 | 所有backend任务 | 添加表结构定义 | 12h |
| IMP-P1-007 | 为backend任务添加API端点定义 | 所有backend任务 | 添加API端点章节 | 10h |
### P2 - 中期优化（改进问题）
| 任务ID | 问题描述 | 涉及文件 | 改进方向 | 预计耗时 |
|-------|---------|-----------|---------|---------|
| IMP-P2-001 | 修正任务状态标记 | 所有任务文档 | 根据实际情况更新状态 | 4h |
| IMP-P2-002 | 为所有任务添加性能要求 | 所有任务文档 | 添加性能指标 | 6h |
| IMP-P2-003 | 为所有任务添加安全要求 | 所有任务文档 | 添加安全检查项 | 4h |
| IMP-P2-004 | 创建任务文档模板 | docs/00_Business/tasks/ | 创建标准模板 | 2h |
---
## 三、改进实施计划
### 3.1 第一阶段：P0问题修复（1天）
```
Day 1 上午:
├─ IMP-P0-001: 统一 B2B/B2C 为 TOB/TOC (1h)
├─ IMP-P0-002: 统一 merchant_id 为 tenantId (2h)
├─ IMP-P0-003: 统一角色命名 (0.5h)
└─ IMP-P0-004: 修复任务ID冲突 (0.5h)
Day 1 下午:
├─ 验证所有P0修复
└─ 更新相关文档索引
```
### 3.2 第二阶段：P1问题改进（3天）
```
Day 2:
├─ IMP-P1-001: 统一文档表格格式 (2h)
├─ IMP-P1-002: 统一依赖关系描述 (3h)
└─ 开始 IMP-P1-006: 添加数据库表结构 (4h)
Day 3:
├─ 完成 IMP-P1-006: 添加数据库表结构 (8h)
└─ 开始 IMP-P1-007: 添加API端点定义 (4h)
Day 4:
├─ 完成 IMP-P1-007: 添加API端点定义 (6h)
├─ IMP-P1-003: 添加验收标准 (4h)
├─ IMP-P1-004: 添加测试要求 (4h)
└─ IMP-P1-005: 添加风险提示 (4h)
```
### 3.3 第三阶段：P2问题优化（2天）
```
Day 5:
├─ IMP-P2-001: 修正任务状态标记 (4h)
├─ IMP-P2-002: 添加性能要求 (4h)
└─ IMP-P2-003: 添加安全要求 (4h)
Day 6:
├─ IMP-P2-004: 创建任务文档模板 (2h)
└─ 验证所有改进完成
```
---
## 四、改进标准
### 4.1 术语标准
| 旧术语 | 新术语 | 适用范围 |
|-------|-------|---------|
| B2B | TOB | 所有文档、代码、数据库 |
| B2C | TOC | 所有文档、代码、数据库 |
| merchant_id | tenantId | 所有代码、API、数据库 |
| Admin | ADMIN | 角色定义 |
| Manager | MANAGER | 角色定义 |
| Operator | OPERATOR | 角色定义 |
### 4.2 任务ID格式标准
| 模块 | 前缀 | 示例 |
|------|------|------|
| Backend | BE-XXX | BE-P001, BE-O001 |
| Frontend | FE-XXX | FE-P001, FE-O001 |
| Plugin | PL-XXX | PL-C001, PL-A001 |
| AI | AI-XXX | AI-D001, AI-TOB001 |
| Document | BE-DOC-XXX | BE-DOC001 |
| Core Service | BE-CORE-XXX | BE-CORE001 |
| Customer Service | BE-CS-XXX | BE-CS001 |
### 4.3 文档格式标准
#### 标准表格列
| 列名 | 是否必填 | 说明 |
|------|---------|------|
| Task ID | ✅ | 任务唯一标识 |
| 闭环关联 | ✅ | 关闭的业务闭环 |
| 任务描述 | ✅ | 任务简要描述 |
| 输入 | ✅ | 任务输入参数 |
| 输出 | ✅ | 任务输出结果 |
| 触发条件 | ✅ | 任务触发条件 |
| 状态 | ✅ | 任务当前状态 |
| 优先级 | ✅ | P0/P1/P2/P3 |
| 依赖 | ✅ | 依赖的任务ID |
| 预计耗时 | ✅ | 预计完成时间 |
| 负责人 | ✅ | 负责人/团队 |
| 完成时间 | ✅ | 实际完成时间 |
#### 标准章节结构
```markdown
# [模块名称]任务
## 任务列表
[任务表格]
## 相关闭环
[相关闭环列表]
## 依赖关系
[依赖关系描述，统一使用箭头图示]
## 数据库表结构
[表结构定义，backend任务必填]
## API端点
[API端点定义，backend任务必填]
## 验收标准
[验收标准列表]
## 测试要求
[测试用例要求]
## 风险提示
[风险识别和应对措施]
```
---
## 五、改进验收标准
### 5.1 P0改进验收
- [ ] 所有文档中的 B2B/B2C 已替换为 TOB/TOC
- [ ] 所有文档中的 merchant_id 已替换为 tenantId
- [ ] 所有角色命名统一为大写（ADMIN, MANAGER, OPERATOR）
- [ ] 核心服务任务ID冲突已解决
### 5.2 P1改进验收
- [ ] 所有任务文档表格格式统一
- [ ] 所有依赖关系描述统一使用箭头图示
- [ ] 所有任务包含验收标准
- [ ] 所有任务包含测试要求
- [ ] 所有P0/P1任务包含风险提示
- [ ] 所有backend任务包含数据库表结构
- [ ] 所有backend任务包含API端点定义
### 5.3 P2改进验收
- [ ] 所有任务状态标记准确
- [ ] 所有任务包含性能要求
- [ ] 所有任务包含安全要求
- [ ] 已创建任务文档模板
---
## 六、相关文档
| 文档 | 路径 | 说明 |
|------|------|------|
| 术语标准 | [../10_Documents_Global/TERMINOLOGY_STANDARDS.md](../10_Documents_Global/TERMINOLOGY_STANDARDS.md) | 术语定义和替换规则 |
| 项目规则 | [../../.trae/rules/project-specific-rules.md](../../.trae/rules/project-specific-rules.md) | 项目硬性约束 |
| 任务概览 | [../Task_Overview.md](../Task_Overview.md) | 任务总览和状态追踪 |
---
*最后更新: 2026-03-20*
Reference in New Issue Copy Permalink