| name | ddoc |
| description | 产品文档工具——正向(需求→文档)或逆向(代码→文档)两种模式。触发场景:(1) 为已有产品还原/补全文档,(2) 为新功能/模块编写产品文档,(3) 用户说"写文档"、"还原文档"、"doc"、"产品文档" |
| argument-hint | [forward|reverse] [范围] [输入源] |
| allowed-tools | ["Read","Grep","Glob","Write","Edit","Bash"] |
| effort | high |
| paths | ["**/*.ts","**/*.js","**/*.py","**/*.go","**/*.rs","**/*.md"] |
ddoc
阅读顺序
首次使用:
- 阅读 CONTEXT.md(命令用途、适用场景、两种模式概述)
- 阅读 quick.md(快速执行规则、核心步骤)
- 根据任务类型查阅 references/INDEX.md 找到对应详细文档
快速查询:
- 不确定用哪个模式 → CONTEXT.md
- 知道模式但忘记步骤 → quick.md
- 需要详细规则或模板 → references/INDEX.md
触发时询问
先检查关键词自动设置模式:
reverse、逆向、还原文档、从代码 → 逆向模式
forward、正向、写文档、从需求 → 正向模式
未匹配时,询问用户以下问题(上下文已明确的跳过):
- 模式:正向(有需求,要写文档)还是逆向(有代码,要还原文档)?
- 范围:整个产品 / 特定模块 / 特定功能?
- 输入:代码库路径(逆向)或需求描述(正向)
- 输出结构:领域驱动(推荐,有 3 个以上业务域时)还是分层(工具类产品或小项目)?
核心原则
- 代码是锚点(逆向模式):每条描述必须可追溯到代码或可观测行为
- 约束优先(正向模式):用五约束维度从需求中提取约束
- 写对优先于写全:无法确认的内容标注
[待确认],不编造
- 两层完整性检查:结构检查(有没有?)+ 深度检查(够不够?)
文件结构
skills/ddoc/
├── SKILL.md # 本文件:入口 + 阅读顺序
├── CONTEXT.md # 命令用途、适用场景、两种模式概述
├── quick.md # 快速执行规则、核心步骤、常见问题
└── references/
├── INDEX.md # 任务到文档的路由表
├── forward-mode.md # 正向模式详细步骤(六步设计法)
├── reverse-mode.md # 逆向模式详细步骤(AI1+AI2+逆向Spec)
├── constraints.md # 五约束维度详解
├── completeness.md # 两层完整性检查详解
├── output-structure.md # 输出结构(领域驱动 vs 分层)
└── templates.md # 提示词模板、文档模板、反模式速查