关于 design-doc
用于编写结构化技术设计文档的技能，说明系统行为、实现方案和验收标准。它依据参考模板引导整理背景、起草内容、澄清问题并完成审阅。
主要功能
- 01结构化设计文档流程
- 02基于模板的章节指引
- 03可测试的验收标准
- 04实现与测试纲要
- 05范围与非目标定义
适用场景
- 01记录新功能的设计
- 02将系统需求整理为实现方案
- 03检查验收标准是否可验证
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/design-doc确认已加载。
附带文件references/template.mdREADME.md
详细介绍
技术设计文档技能
创建结构化的技术设计文档，说明系统行为、实现方案和验收标准。
工作流
- 收集背景信息：了解功能／系统范围、约束条件和目标
- 起草结构：使用
references/template.md中的模板 - 填写各部分：逐一完善各部分，并根据需要提出澄清问题
- 审阅：确保验收标准可测试，且实现大纲可执行
模板
完整的模板结构和各部分指南请参阅 references/template.md。
核心部分：
- 背景与动机：问题陈述、目标、非目标
- 实现考量：约束条件和设计原则
- 高层行为：端到端的系统行为
- 特定领域的部分：根据功能类型（发现、验证、API、状态、渲染）调整
- 错误处理与 UX：错误呈现和恢复
- 面向未来：为扩展性进行设计
- 实现大纲：分步实施方案
- 测试方案：单元、集成、手动测试
- 验收标准：可测试的“完成”条件
写作指南
- 使用
---作为章节标题下划线（Setext 风格） - 使用现在时描述行为（“加载”“验证”“返回”）
- 描述具体：写“最多 100 个字符”，而不是“合理的长度”
- 非目标与目标同样重要——可防止范围蔓延
- 验收标准必须可验证，而非主观判断
评论
支持 Markdown