Simon
facc04aa65
本提交为 .git 对象库损坏后的重建提交，内容等价于原先三个本地提交 （5e2fd4c2 / 57a53c98 / 5d7e1873）的累积结果，未做任何额外改动。 一、docs 结构整改（整改 #14） 根因：重构时新结构为 untracked 文件，执行 git stash（未带 -u）未纳入， 随后 git reset 拉回 HEAD 旧 tracked 树，导致旧树复活、新旧两棵目录 树并存于 docs/，共 791 文件、双分类体系冲突。 修复动作： - b2 同名异主题文件改名迁移保全 9 个 - C 类 39 个孤立文件按主题正确归类 - A/B1 类 222 个重复文件删除（新结构已有内容副本） - 9 个旧独有空目录删除 - 270 处内部引用按 verified 映射改写 - 整改记录 #14 登记于 04-运维文档/部署运维 结果：docs 791 → 569 文件，顶层仅规范 8 类 + 治理文件，单树恢复。 残留：约 20 处指向从未存在文件的陈旧死链，归入独立文档卫生任务。 二、compose 双目录对齐（消除踩坑 A） - docker-compose.yml：nginx 前端挂载全部由根目录 frontend-*/dist 改为 src/frontend-*/dist（h5 / agent / admin / terminal） - docker-compose.dev.yml：dev 服务 build context 与卷同步改 src/ - 效果：本地 docker compose up 不再把根目录 stale dist 挂回， 与线上一致，分叉隐患消除（已 docker compose config 校验通过） 防复发铁律： - 重构须提交；仓库修复须 git stash -u 或先 commit - 新结构须 git add 并提交，避免再次 untracked 复活 - H5 改动只动 src/frontend-h5/，禁改根目录遗留 frontend-*/
154 lines
3.9 KiB
Markdown
154 lines
3.9 KiB
Markdown
# 任务说明书模板
|
||
|
||
> **版本**: 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 | [变更] | [人] | [说明] |
|
||
|
||
---
|
||
|
||
## 📎 附件
|
||
|
||
- 相关需求文档链接
|
||
- 技术方案链接
|
||
- 原型图链接
|
||
- 测试用例链接
|
||
|