chore(skills): add development docs writer
This commit is contained in:
130
.codex/skills/write-development-docs/assets/CONCEPT.md
Normal file
130
.codex/skills/write-development-docs/assets/CONCEPT.md
Normal file
@@ -0,0 +1,130 @@
|
||||
# <功能名> 概念文档
|
||||
|
||||
更新时间:<YYYY-MM-DD>
|
||||
|
||||
## 功能一句话
|
||||
|
||||
用一句话说明这个能力解决什么问题、服务谁、交付什么结果。
|
||||
|
||||
## 背景与问题
|
||||
|
||||
- 当前现状:
|
||||
- 用户痛点:
|
||||
- 业务影响:
|
||||
- 为什么现在需要做:
|
||||
|
||||
## 目标与非目标
|
||||
|
||||
### 目标
|
||||
|
||||
- [G1]
|
||||
- [G2]
|
||||
- [G3]
|
||||
|
||||
### 非目标
|
||||
|
||||
- [NG1] 本轮不做:
|
||||
- [NG2] 本轮不改变:
|
||||
- [NG3] 后续再评估:
|
||||
|
||||
## 用户与场景
|
||||
|
||||
- 目标用户:
|
||||
- 使用入口:
|
||||
- 核心场景:
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
- 异常场景:
|
||||
-
|
||||
|
||||
## 功能能力
|
||||
|
||||
- [C1] 输入能力:
|
||||
- [C2] 处理能力:
|
||||
- [C3] 输出能力:
|
||||
- [C4] 状态与权限:
|
||||
- [C5] 边界与降级:
|
||||
|
||||
## 方案设计
|
||||
|
||||
### 前端
|
||||
|
||||
- 页面/组件:
|
||||
- 交互状态:
|
||||
- 展示规则:
|
||||
- 降级处理:
|
||||
|
||||
### 后端
|
||||
|
||||
- 接口/服务:
|
||||
- 权限与校验:
|
||||
- 持久化:
|
||||
- 降级处理:
|
||||
|
||||
### 算法与规则
|
||||
|
||||
- 输入:
|
||||
- 流程:
|
||||
- 输出:
|
||||
- 解释:
|
||||
|
||||
### 数据与契约
|
||||
|
||||
- 核心字段:
|
||||
- 状态枚举:
|
||||
- 兼容策略:
|
||||
- 版本/审计:
|
||||
|
||||
## 算法与公式
|
||||
|
||||
当前功能不涉及显式数学公式。
|
||||
|
||||
如涉及公式,使用如下格式:
|
||||
|
||||
```text
|
||||
metric = input_a + input_b
|
||||
```
|
||||
|
||||
变量说明:
|
||||
|
||||
- metric:
|
||||
- input_a:
|
||||
- input_b:
|
||||
|
||||
## 测试方案
|
||||
|
||||
后端:
|
||||
|
||||
-
|
||||
|
||||
前端:
|
||||
|
||||
-
|
||||
|
||||
集成:
|
||||
|
||||
-
|
||||
|
||||
手工验证:
|
||||
|
||||
-
|
||||
|
||||
## 指标与验收
|
||||
|
||||
- [A1] 功能验收:
|
||||
- [A2] 性能指标:
|
||||
- [A3] 质量指标:
|
||||
- [A4] 安全/权限指标:
|
||||
- [A5] 可观测性:
|
||||
|
||||
## 风险与开放问题
|
||||
|
||||
- 风险:
|
||||
- 已处理依赖:
|
||||
- 待确认:
|
||||
- 降级策略:
|
||||
|
||||
## 本轮实现记录
|
||||
|
||||
-
|
||||
71
.codex/skills/write-development-docs/assets/TODO.md
Normal file
71
.codex/skills/write-development-docs/assets/TODO.md
Normal file
@@ -0,0 +1,71 @@
|
||||
# <功能名> 开发 TODO
|
||||
|
||||
更新时间:<YYYY-MM-DD>
|
||||
|
||||
## 使用规则
|
||||
|
||||
- 每个 TODO 必须对应 `CONCEPT.md` 中的目标、能力、方案或验收点。
|
||||
- 只有完成并验证后,才能把 `[ ]` 改成 `[x]`。
|
||||
- 勾选时在任务后补充简短证据,例如文件、接口、命令或验证结果。
|
||||
- 如果需求发生变化,先更新 `CONCEPT.md`,再调整本 TODO。
|
||||
|
||||
## 1. 调研与边界
|
||||
|
||||
- [ ] [CONCEPT: 背景与问题] 阅读相关页面、接口、服务、测试和历史文档,记录当前实现事实。
|
||||
证据:
|
||||
- [ ] [CONCEPT: 目标与非目标] 确认本轮开发范围,写清楚不做项。
|
||||
证据:
|
||||
- [ ] [CONCEPT: 风险与开放问题] 标记无法立即确认的依赖、风险和假设。
|
||||
证据:
|
||||
|
||||
## 2. 契约与设计
|
||||
|
||||
- [ ] [CONCEPT: 功能能力] 定义输入、输出、状态、权限和边界条件。
|
||||
证据:
|
||||
- [ ] [CONCEPT: 方案设计] 明确前端、后端、算法、数据的职责边界。
|
||||
证据:
|
||||
- [ ] [CONCEPT: 算法与公式] 补全公式、变量解释或明确当前不涉及公式。
|
||||
证据:
|
||||
- [ ] [CONCEPT: 指标与验收] 把验收标准转成可验证的检查点。
|
||||
证据:
|
||||
|
||||
## 3. 后端实现
|
||||
|
||||
- [ ] [CONCEPT: 后端] 新增或调整 schema、service、endpoint、权限和持久化逻辑。
|
||||
证据:
|
||||
- [ ] [CONCEPT: 数据与契约] 保持响应结构、状态枚举和兼容策略清晰。
|
||||
证据:
|
||||
|
||||
## 4. 算法/规则实现
|
||||
|
||||
- [ ] [CONCEPT: 算法与规则] 实现核心处理流程、规则判断或计算逻辑。
|
||||
证据:
|
||||
- [ ] [CONCEPT: 结果解释] 输出可读解释、证据链、贡献项或降级原因。
|
||||
证据:
|
||||
|
||||
## 5. 前端实现
|
||||
|
||||
- [ ] [CONCEPT: 前端] 新增或调整页面、组件、服务 API 和视图模型。
|
||||
证据:
|
||||
- [ ] [CONCEPT: 前端] 实现加载、空态、错误态、权限态和刷新。
|
||||
证据:
|
||||
- [ ] [CONCEPT: 前端] 对齐现有企业后台风格,避免营销页或花哨卡片感。
|
||||
证据:
|
||||
|
||||
## 6. 测试与验证
|
||||
|
||||
- [ ] [CONCEPT: 测试方案] 补充后端 service/API 定向测试,容器内运行,超时控制在 60s 内。
|
||||
证据:
|
||||
- [ ] [CONCEPT: 测试方案] 补充前端视图模型、路由、组件或构建验证。
|
||||
证据:
|
||||
- [ ] [CONCEPT: 指标与验收] 记录验证命令、结果和未覆盖风险。
|
||||
证据:
|
||||
|
||||
## 7. 文档收尾
|
||||
|
||||
- [ ] [CONCEPT: 指标与验收] 回看所有验收点,确认均有实现或验证证据。
|
||||
证据:
|
||||
- [ ] [CONCEPT: 风险与开放问题] 更新剩余风险、后续任务和明确不做项。
|
||||
证据:
|
||||
- [ ] [CONCEPT: 功能一句话] 确认最终实现没有偏离原始目标。
|
||||
证据:
|
||||
Reference in New Issue
Block a user