Agent Skills
返回列表
SDD 文档构建器

SDD 文档构建器

开发编程 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中：

请根据 https://skillhub.cn/install/skillhub.md，安装 @user_db7ebc1c/sdd-builder。

技能介绍

它解决什么问题

不少代码库缺一份可信的 SDD：入口散在 HTTP、MQ、定时任务里，业务流程靠口头交接，文档又常写成结论式描述，缺少代码位置和可反证依据。sdd-builder 把文档生成拆成人机协作的证据驱动流程，让 AI 只负责检索、归纳、断言和验证，关键判断仍由人工确认。

技能如何工作

核心能力是把项目知识库、业务信息、代码证据、SDD 草稿和验证报告串成可暂停的阶段流：

  • 前置知识库：扫描 rules/、architecture/、domain-knowledge/，输出代码规范、架构关系和领域概念，并标注代码位置。
  • 阶段一到阶段五：先收集业务输入和图片，再进入代码探索，形成 ENTRY-* 与 FLOW-* 断言池；随后生成 README.md 工作稿，自动执行证据和断言验证。
  • 最终交付：剥离断言内容，保留证据化正文，并支持人工纠偏和可选 README.purified.md 提纯。

适用边界：它适合已有代码库但缺少结构化文档的场景，也适合需要反复迭代的技术说明。若业务背景完全缺失、代码证据不足或要求一次生成完全准确，仍需人工补齐输入。

使用场景

  • 接手旧 Java 服务后，需要梳理 HTTP、MQ、定时任务入口并生成可验证的 SDD。
  • 项目缺少架构说明和领域术语，希望先扫描代码生成 rules、architecture、domain-knowledge。
  • 写完 SDD 草稿后，需要检查每条业务结论是否有代码位置，并剥离断言生成最终文档。
  • 业务文档多次迭代后，希望把已确认版本进一步提纯为 README.purified.md。

适合人员

  • 维护微服务后端的工程师：需要把分散入口和调用链整理成可交接的技术文档。
  • 接手遗留系统的架构师：需要基于代码证据补齐架构、领域知识和代码规范说明。
  • 负责技术交付的工程师：需要在 SDD 草稿完成后验证结论并输出无断言终稿。
  • 编写业务说明的工程师：需要把多轮业务补充沉淀为结构化文档和图片清单。