name: dev-docs description: 为大型任务创建全面的战略计划和开发文档。在启动跨多个会话的大型任务时调用。 allowed-tools: Bash, Read, Write, Glob, Grep, TodoWrite
开发文档系统
为大型任务创建一个结构化的文档系统,以跨会话维护上下文。
何时调用
- 当启动一个大型、多会话任务时
- 当需要跨上下文压缩跟踪进度时
- 当处理需要文档化的复杂实现时
- 在进行重大重构或功能开发之前
用法
/dev-docs [任务名称]
指令
当此命令运行时:
-
创建开发文档目录结构:
dev/active/[任务名称]/ ├── plan.md # 战略实施计划 ├── context.md # 关键文件、决策、依赖项 └── tasks.md # 详细任务清单 -
生成 plan.md 包含:
- 任务概述和目标
- 高层实施策略
- 关键架构决策
- 风险评估和缓解
- 成功标准
-
生成 context.md 包含:
- 要修改的关键文件列表
- 发现的重要代码模式和约定
- 外部依赖项及其版本
- 设计决策和理由
- 相关文档链接
-
生成 tasks.md 包含:
- 详细、可操作的任务清单
- 每个任务的估计复杂度
- 任务之间的依赖关系
- 进度跟踪复选框
-
用初始任务更新 TodoWrite
模板结构
plan.md
# [任务名称] - 实施计划
## 概述
[简要描述我们正在构建的内容]
## 目标
- [ ] 目标 1
- [ ] 目标 2
## 策略
[高层方法]
## 架构决策
- 决策 1: [理由]
## 风险
| 风险 | 缓解措施 |
| ---- | -------- |
| | |
## 成功标准
- [ ] 标准 1
context.md
# [任务名称] - 上下文
## 关键文件
- `路径/到/文件.ts` - [用途]
## 代码模式
- 模式 1: [描述]
## 依赖项
- package@版本 - [为什么需要]
## 决策日志
| 日期 | 决策 | 理由 |
| ---- | ---- | ---- |
| | | |
tasks.md
# [任务名称] - 任务
## 阶段 1: 设置
- [ ] 任务 1 (S)
- [ ] 任务 2 (M)
## 阶段 2: 实施
- [ ] 任务 3 (L)
## 阶段 3: 测试
- [ ] 任务 4 (S)
图例: (S)小, (M)中, (L)大
注意事项
- 在会话压缩之前运行
/update-dev-docs以捕获进度 - 在发现新信息时保持 context.md 更新
- 在完成任务时勾选 tasks.md 中的任务