用途
sdd 是一套规范驱动开发(Spec-Driven Development)工作流,面向那些把规范文件同时用作产品规格与使用手册的项目。它的核心原则是:没有规范就不写代码。规范既是工作的蓝图,也是最终成果的说明书。
主要能力
该工作流围绕一个固定循环展开:
- Spec(编写规范):在规范文件(docs/specs/*.md)中,以任务形式描述需要构建的内容。
- Build(构建):实现该任务。
- Document(文档化):任务完成后,将任务标记为 [x],并在任务正文内添加 Implemented: 要点;同时根据实际实现情况,更新 # Tasks 上方的功能描述。
规范结构
每个规范文件包含两部分:
- 功能描述(顶部):说明产品做什么、如何使用。
- 任务日志(底部):以 # Tasks 开头,其下的故事分组使用 ## 标题。
功能描述即手册。读者应当无需阅读任务,就能理解有哪些可用功能以及如何使用它们。
使用方式
资料中给出了一个智能水壶应用的示例,展示该工作流的推进过程:
第一步 — 编写规范:先创建包含任务的规范文件,此时还没有代码,只有规范。例如在“Brewing — Smart Kettle”文件中列出 KTL-001 基础煮沸与自动关机、KTL-002 茶饮预设、KTL-003 定时煮沸等任务。此时还没有功能描述,因为什么都还没构建。
第二步 — 构建并文档化 KTL-001:实现煮沸功能后,任务被标记为 [x] 并附带 Implemented: 块,同时在 # Tasks 上方出现功能描述(如 ## Boiling 一节)。
第三步 — 构建并文档化 KTL-002:茶饮预设属于另一个功能,因此获得自己的章节(## Tea presets)。此时 KTL-003 仍未完成,因此还没有“Scheduling”章节,它会在任务完成后出现。
何时新建章节、何时更新已有章节
- 新功能 → 新建章节:KTL-001 创建了 ## Boiling,KTL-002 创建了 ## Tea presets。
- 扩展现有功能 → 更新该章节:如果某个任务为煮沸功能增加了温度选择,应更新 ## Boiling,而不是新建章节。
规则是:章节对应功能,而不是对应任务。
任务内容
关于如何编写任务——格式以及正文中应包含什么——由 mdtask 技能定义,它是唯一的来源。sdd 只补充节奏:任务即规范,先于代码编写,构建完成后进行文档化(见上述循环)。
适用场景
适用于使用规范文件作为产品规格与手册的项目,尤其是在编写规范、依据规范实现任务等场景中。
限制
资料未提供关于平台、收费、价格、效果等方面的信息,暂未提供。