前言¶
存量项目的文档往往与代码脱节，或者仅停留在表面描述。开发者需要梳理代码时，常常只能依靠零散的注释或回忆，难以快速定位关键逻辑与设计决策。即使花费时间整理，文档与代码也容易再次不同步。SDD 文档构建器通过半自动化工作流，将文档生成过程与代码位置、断言验证绑定，让文档从”事后补充”变成”代码的一部分”。
这是什么¶
SDD 文档构建器是一个从代码库反向生成技术文档的半自动化工作流 Skill。它由社区用户发布，分类为 dev-programming。当需要为既有代码仓库建立结构化的架构、领域或规范文档，或者需要梳理业务流程、术语时，可使用本 Skill。
核心功能¶
SDD 文档构建器包含以下核心流程：
-
前置阶段（可选）
- 扫描代码生成 rules 知识库
- 扫描代码生成 architecture 知识库
- 扫描代码生成 domain-knowledge 知识库 -
文档生成六阶段
- 收集业务信息
- 代码探索与断点处理（循环）
- 文档生成
- 证据与断言验证
- 人工纠偏
- 文档提纯
所有结论均绑定代码位置（文件名+行号），关键设计决策以可证伪断言沉淀，确保文档可追溯、可验证。
安装与启用¶
在 SkillHub 平台安装：
# 通过 SkillHub CLI 安装（假设）
skillhub install @user_db7ebc1c/sdd-builder
安装后，可在支持 SkillHub 的 IDE 中启用。当前支持两种 IDE 模式：
- Cursor（Plan 模式）
- Claude Code（终端模式）
典型用法¶
当需要为存量项目生成或梳理文档时，可在对话中直接调用本 Skill。例如：
- “用 SDD 文档构建器为这个项目生成架构文档”
- “扫描当前代码库，生成业务流程和领域知识库”
- “把现有代码的术语整理成规范文档”
Skill 会按流程依次执行：先收集业务信息，然后进入代码探索与断点处理循环，生成文档后进行证据与断言验证，最后返回给人工纠偏与文档提纯。
适用场景与注意¶
适合以下场景：
- 为既有代码仓库建立结构化的架构/领域/规范文档
- 梳理业务流程文档
- 梳理业务术语
- 生成代码文档或知识库
注意：
- 本 Skill 属于半自动化流程，关键设计决策仍需人工纠偏与提纯
- 所有结论绑定代码位置，需确保代码库在执行过程中未被修改
- 需要配合 Cursor Plan 模式或 Claude Code 终端模式使用
短结尾¶
SDD 文档构建器将文档生成与代码位置、断言验证深度绑定，适合需要为存量项目建立结构化文档的开发者。官方地址：https://api.skillhub.cn/user_db7ebc1c/sdd-builder
