chore(docs): docs/ 目录全面重新编号 + 重组
**重构前**(旧编号 02-11): - docs/02-产品需求/ → 00 产品规划/PRD - docs/03-技术架构/ → 01-05 子目录散落 - docs/04-原型设计/ → 01-02 产品设计(HTML 原型) - docs/05-原型设计/ → screens/ - docs/06-测试素材/ → 02-E2E / 03-功能 / 04-版本测试 - docs/07-项目管理/ → 任务说明书/日报/计划 - docs/08-安全审计/ → 审计报告 - docs/09-堡垒运维/ → toolbox / deploy - docs/10-项目管理/ → 任务说明书(重复) - docs/11-历史归档/ → deploy-nas-archived **重构后**(新编号 00-07,语义化): - docs/00-产品开发流程与文档管理规范.md - docs/00-版本迭代总览.md - docs/01-产品文档/ (PRD/原型/认证/会话/AI 服务/坐席/集成) - docs/02-技术文档/ (技术方案/架构图/重构记录/前端改造/实现配置) - docs/03-测试文档/ (E2E/功能用例/版本报告/缺陷单) - docs/04-运维文档/ (部署运维/运维指南) - docs/05-运营文档/ (品牌推广/用户手册) - docs/06-安全审计/ (审计报告) - docs/07-项目管理/ (任务说明书/日报/计划/看板) **净收益**: - 目录编号与产品文档管理规范对齐(按文档阶段 01-07 编号) - 消除 02-产品需求 与 10-项目管理 的编号重叠 - 子目录按文档类型分组(如 01-产品文档/00-产品规划、01-产品文档/01-认证与登录) - 把运维/安全/项目管理从 0X 散落改为 04/06/07 合计 494 文件 + 78495 行 / - 14076 行
This commit is contained in:
@@ -0,0 +1,153 @@
|
||||
# 任务说明书模板
|
||||
|
||||
> **版本**: v1.0 | **日期**: 2026-07-04
|
||||
|
||||
---
|
||||
|
||||
## 📋 基本信息
|
||||
|
||||
| 项目 | 内容 |
|
||||
|------|------|
|
||||
| **任务名称** | [任务名称] |
|
||||
| **任务ID** | #[编号] |
|
||||
| **优先级** | 🔴P0 / 🟠P1 / 🟡P2 |
|
||||
| **类型** | 功能开发 / Bug修复 / 安全加固 / 文档完善 / 测试修复 / 部署优化 |
|
||||
| **状态** | 待开始 / 进行中 / 已完成 / 阻塞 / 延后 |
|
||||
| **负责人** | [负责人] |
|
||||
| **创建日期** | YYYY-MM-DD |
|
||||
| **计划完成日期** | YYYY-MM-DD |
|
||||
|
||||
---
|
||||
|
||||
## 📥 输入项来源
|
||||
|
||||
### 产品需求
|
||||
| 来源文档 | 相关章节 | 说明 |
|
||||
|----------|----------|------|
|
||||
| `01-产品文档/01-01产品需求/[PRD文件名].md` | §X | 需求描述、用户故事、验收标准 |
|
||||
| `01-产品文档/01-01产品需求/[需求评估报告].md` | §X | 需求评估结论 |
|
||||
|
||||
### 技术方案
|
||||
| 来源文档 | 相关章节 | 说明 |
|
||||
|----------|----------|------|
|
||||
| `02-技术文档/[技术方案文件名].md` | §X | API接口、数据库设计、实现步骤 |
|
||||
|
||||
### 原型设计
|
||||
| 来源文档 | 页面 | 说明 |
|
||||
|----------|------|------|
|
||||
| `01-产品文档/01-02产品设计/[原型文件名].html` | [页面名] | 交互设计、组件状态 |
|
||||
|
||||
### 需了解的现有代码(历史现状)
|
||||
| 模块/文件 | 说明 | 需了解的内容 |
|
||||
|-----------|------|-------------|
|
||||
| `[现有模块文件路径]` | 现有功能模块 | 状态管理、业务逻辑、接口调用 |
|
||||
|
||||
---
|
||||
|
||||
## 📤 输出成果要求
|
||||
|
||||
### 交付物清单
|
||||
|
||||
| # | 交付物 | 类型 | 说明 |
|
||||
|---|--------|------|------|
|
||||
| 1 | [交付物名称] | 代码/文档/配置 | [说明] |
|
||||
| 2 | [交付物名称] | 代码/文档/配置 | [说明] |
|
||||
|
||||
### 代码要求
|
||||
- 遵循项目代码规范(见 `07-代码评审/`)
|
||||
- 所有新增代码通过 ESLint / Pylint 检查
|
||||
- 单元测试覆盖率 ≥ 80%
|
||||
|
||||
### 文档要求
|
||||
- 更新相关技术文档
|
||||
- 更新 API 接口文档
|
||||
- 更新部署文档(如有变更)
|
||||
|
||||
---
|
||||
|
||||
## 🔧 验证方式
|
||||
|
||||
### 功能验证
|
||||
| 验证项 | 验证方法 | 预期结果 |
|
||||
|--------|----------|-----------|
|
||||
| 功能正常运行 | 手动测试 | 功能符合需求 |
|
||||
| 接口正常 | API测试 | 返回正确 |
|
||||
| 页面正常 | UI测试 | 显示正确 |
|
||||
|
||||
### 安全验证
|
||||
| 验证项 | 验证方法 | 预期结果 |
|
||||
|--------|----------|-----------|
|
||||
| 权限控制 | 越权测试 | 无法访问未授权资源 |
|
||||
| 输入验证 | 异常输入测试 | 正确拦截/提示 |
|
||||
|
||||
### 性能验证
|
||||
| 验证项 | 验证方法 | 预期结果 |
|
||||
|--------|----------|-----------|
|
||||
| 响应时间 | 性能测试 | < 200ms (API) |
|
||||
| 并发能力 | 压力测试 | 50+ 并发正常 |
|
||||
|
||||
---
|
||||
|
||||
## ✅ 完成标准
|
||||
|
||||
### 验收条件
|
||||
|
||||
- [ ] 代码合入主干分支
|
||||
- [ ] 所有测试通过(CI/CD 绿灯)
|
||||
- [ ] 功能测试通过
|
||||
- [ ] 安全测试通过
|
||||
- [ ] 文档已更新
|
||||
- [ ] 相关任务看板已更新
|
||||
|
||||
### 产出确认
|
||||
|
||||
- [ ] 代码已提交并通过 Code Review
|
||||
- [ ] 单元测试新增/修复完成
|
||||
- [ ] 集成测试通过
|
||||
- [ ] 部署验证通过(如需要)
|
||||
- [ ] 文档更新已完成
|
||||
|
||||
---
|
||||
|
||||
## 📊 工作分解
|
||||
|
||||
### 子任务
|
||||
|
||||
| 子任务 | 负责人 | 预估工时 | 状态 |
|
||||
|--------|--------|----------|------|
|
||||
| [子任务1] | [负责人] | [工时] | [状态] |
|
||||
| [子任务2] | [负责人] | [工时] | [状态] |
|
||||
| [子任务3] | [负责人] | [工时] | [状态] |
|
||||
|
||||
---
|
||||
|
||||
## 📞 依赖与阻塞
|
||||
|
||||
### 前置依赖
|
||||
| 依赖任务 | 依赖说明 | 状态 |
|
||||
|----------|----------|------|
|
||||
| [任务ID] | [依赖说明] | 已完成/进行中 |
|
||||
|
||||
### 阻塞因素
|
||||
| 阻塞项 | 影响范围 | 解决方案 |
|
||||
|--------|----------|-----------|
|
||||
| [阻塞项] | [影响] | [解决方案] |
|
||||
|
||||
---
|
||||
|
||||
## 📈 变更记录
|
||||
|
||||
| 日期 | 变更内容 | 变更人 | 说明 |
|
||||
|------|----------|--------|------|
|
||||
| YYYY-MM-DD | 创建任务 | [人] | 初始版本 |
|
||||
| YYYY-MM-DD | [变更] | [人] | [说明] |
|
||||
|
||||
---
|
||||
|
||||
## 📎 附件
|
||||
|
||||
- 相关需求文档链接
|
||||
- 技术方案链接
|
||||
- 原型图链接
|
||||
- 测试用例链接
|
||||
|
||||
Reference in New Issue
Block a user