doc:输出1.2.0版本需求文档

This commit is contained in:
ShaoHua
2026-04-07 00:21:15 +08:00
parent 141b3112a4
commit 18d37fdd24
13 changed files with 485 additions and 45 deletions
+2
View File
@@ -10,6 +10,7 @@ description: 强制文档同步规范:每次变更代码(如新增功能、
- **代码即文档,文档随代码**:文档不是静态的,它必须真实反映当前代码的状态。
- **及时性**:在提交代码变更的同时(或紧随其后),必须完成相关文档的更新。
- **准确性**:确保文档中的示例代码、接口说明、安装步骤与实际代码完全一致。
- **协作友好(局部修改)**:当并行处理多个任务/需求时,更新文档应尽量只修改与本任务直接相关的段落/小节,避免对不相关内容做无意义的重排、改写或格式化;如必须调整非关联内容,应拆分为独立的变更说明清楚原因与影响范围。
## 更新范围
@@ -30,3 +31,4 @@ description: 强制文档同步规范:每次变更代码(如新增功能、
3. [ ] 是否有新增的功能模块?(更新产品需求文档和技术栈说明)
4. [ ] 是否调整了开发环境或依赖?(更新 README)
5. [ ] 是否在 [版本记录.md](docs/版本记录.md) 中记录了本次变更?
6. [ ] 文档变更是否保持“局部修改”,只影响与本任务相关的段落/小节?(避免无关重排/改写)
+43
View File
@@ -0,0 +1,43 @@
---
alwaysApply: false
description: 强制任务拆分输出规范:阅读完所有文档后,先产出拆分后的任务 Markdown,并按可并行执行拆分为多个带序号的 md 文件,统一放入 docs/project 下的新建文件夹。
---
# 任务拆分输出规范(必须遵守)
## 适用时机
- 当需求需要先通读项目/产品/技术文档再开始实现时,必须先输出任务拆分文档,再开始写代码或改配置。
## 输出要求
- **先读完所有相关文档**:包括但不限于 `docs/``docs/project/` 下与本次需求相关的内容。
- **先写任务拆分,再动手实现**:任务拆分产出是后续执行的入口与对齐依据。
- **新增一个专属文件夹**:在 `d:\Proj\6.Hua.Todo\docs\project` 下新建一个文件夹存放本次任务拆分文档。
- 文件夹命名建议:`任务拆分-<主题>-<日期或版本>`(保持可检索、避免与既有文档冲突)。
- **可并行的任务要拆成不同 md**:能同步执行(相互无依赖/弱依赖)的任务,必须拆到不同的 Markdown 文件中,便于并行推进与分工。
- **文件必须带序号**:同一文件夹下的 md 文件按执行顺序编号,序号从小到大。
- 文件名建议:`01-xxx.md``02-xxx.md``03-xxx.md`
- **每个任务文件至少包含**
- 目标/范围(做什么、不做什么)
- 前置条件(依赖哪些结论/接口/文档)
- 验收标准(怎么判断完成,包含可执行的验证点)
- 风险与回滚(如有)
## 推荐结构(模板)
- `00-总览.md`
- 背景与目标
- 关键决策与约束
- 并行分组说明(哪些文件可同步做)
- `01-<并行任务A>.md`
- `02-<并行任务B>.md`
- `03-<串行任务C>.md`
## 最小检查清单
1. [ ] 是否确认已阅读完所有相关文档?
2. [ ] 是否在 `docs/project` 下新建了本次专属文件夹?
3. [ ] 是否产出 `00-总览.md`(或等价总览文件)?
4. [ ] 是否将可并行任务拆分为不同 md 文件?
5. [ ] 是否所有 md 文件都带有连续序号?