Specloom 文档
在 VS Code 内,让一条需求沿可配置的规格驱动流水线,有序走完从规格到交付的每一步。本页覆盖安装、日常使用与进阶能力。
快速开始
- 配置 AI:命令面板运行
Specloom: 配置 AI(引导)(默认使用 Claude Code CLI,需先claude login)。 - 新建工作项:在侧边栏 Specloom 中创建,填写标题与一句话需求。
- 运行流水线:在详情页点击 ▶ 运行流水线——简单档一路自动产出;标准档在每道评审门停下,由你审批通过或驳回修订。
安装与 AI 配置
Specloom 是一个 VS Code 扩展。在 VS Code 扩展面板中安装后,需要配置一个 AI 提供方。默认走 Claude Code CLI,在本机安装并登录:
npm i -g @anthropic-ai/claude-code
claude login
若不想用 CLI,可在设置里把 lifecycle.aiProvider 改为:
vscode-lm:复用 GitHub Copilot 等已授权的 VS Code 语言模型(此模式不支持「直接写文件」)。openai-compatible:对接通义 / 千帆 / 豆包 / DeepSeek 等 OpenAI 兼容端点。
看板与详情面板
左侧活动栏的 Specloom 图标打开「工作项看板」,工作项按五个阶段分组:
💡 需求 → 📖 产品 → 💻 研发 → 🧪 测试 → ✅ 完成
每个工作项一行,右侧显示 SDD 进度小标记与更新日期,例如:
登录功能 ✓规 ✓方 ○码 ○测 · 6/2
含义:✓规=已有规格、✓方=已生成技术方案、○码=代码骨架未生成、○测=测试用例未生成。点任意工作项打开详情面板,可编辑标题/需求/规格、点击进度条圆点切换阶段,并驱动整条 SDD 流水线。
SDD 流水线
详情面板里四个节点横向排列,依规格逐步派生产物:
[规格说明] → [技术方案] → [代码骨架] → [测试用例]
推荐顺序:先生成「规格说明」,之后技术方案 / 代码骨架 / 测试用例都基于规格生成。未生成规格就点后续步骤会提示「请先执行 AI 生成规格」。
| 步骤 | 输入 | 产出 | 自动阶段流转 |
|---|---|---|---|
| 规格说明 | 标题 + 需求描述 | 规格文本 | 需求 → 产品 |
| 技术方案 | 规格说明 | .lifecycle/<id>/design.md | 产品 → 研发 |
| 代码骨架 | 规格说明 | code.md 或直接写工作区文件 | — |
| 测试用例 | 规格说明 | .lifecycle/<id>/tests.md | 研发 → 测试 |
代码骨架直接写入工作区(可选)
设置项 lifecycle.codeGenWriteFiles 开启后,「代码骨架」改用 agent 模式,让 AI 用 Write/Edit 工具直接在当前工作区创建/修改源文件,完成后打开一份「改动总结」。建议在干净的 git 工作区下使用,便于 review 与回滚;每次执行前会弹确认框。
档位与门禁
同一份规格同时支撑两种节奏,你只需选择编织进多少人审:
- 简单档:低风险、边界清晰的需求一键贯穿全程,无需人工交接。
- 标准档:在规格、技术方案、发布等关键节点逐道人审,由人确认通过或驳回。
门禁分三类,可按团队 / 应用为每道工序自由编排:
- 人工评审:停下等人审批通过或驳回。
- 命令校验:跑一条命令 / CI,通过才放行。
- 自动放行:无需停留,直接续跑下一阶段。
进阶能力(可选,默认关)
以下能力把「让 AI 按规范产出 + 自动化 + 度量」做扎实,全部 opt-in,默认关闭即行为不变:
| 能力 | 设置 / 入口 | 一句话 |
|---|---|---|
| 项目级全局约束 Steering | .lifecycle/steering/*.md | 写一次团队规范/技术栈/安全基线,所有阶段的 AI 都遵守。 |
| 事件驱动自动化 Hooks | .lifecycle/hooks.json | 「代码落盘→跑测试」「spec 改→重生过期产物」等事件自动触发。 |
| 原子步骤执行 | atomicSteps | 大变更拆成小步逐个实现 + 校验 + 提交,失败停在该步不整笔废。 |
| 双轮校验防幻觉 | verifyCodeGrounding | 独立 Agent 核对代码引用的符号/依赖是否真实存在。 |
| Spec 自反馈 | specFeedback | 交付后回看规格质量,沉淀改进 backlog 并打分。 |
| AI 效果度量 | 管理看板「AI 效果」 | 采纳/重生率、首次正确率 FPY、规格质量分。 |
数据与产物
打开工作区文件夹时,全部数据存在工作区的 .lifecycle/ 目录,可随 git 提交、团队共享:
<你的项目>/
└── .lifecycle/
├── items.json # 所有工作项(标题/阶段/规格/产物路径…)
└── <工作项id>/
├── design.md # 技术方案
├── code.md # 代码骨架(文档模式)
└── tests.md # 测试用例
删除工作项时,其 .lifecycle/<id>/ 产物目录会被一并清理。未打开任何文件夹时,数据回退存到 VS Code 的 workspaceState(仅本机),AI 产物退化为临时文档(关闭即失,不落盘)。
常见问题
报错「未找到 Claude CLI」
未安装或不在 PATH。执行 npm i -g @anthropic-ai/claude-code 后 claude login,或用 lifecycle.claudeCodePath 指定完整路径。
报错「未找到可用的语言模型」(vscode-lm 模式)
需安装并登录可提供模型的扩展(如 GitHub Copilot)。
点「打开」提示文档不存在
.lifecycle/<id>/ 下的产物被手工删除了,重新「生成」即可。
阶段没自动推进
只有当前正处于对应起始阶段时才会推进(如「技术方案」仅在「产品」阶段才推进到「研发」),以避免覆盖你手工设置的阶段。需要时直接点进度条圆点切换。
产物没落盘,只开了临时文档
当前没打开工作区文件夹,请在扩展宿主窗口打开一个文件夹后重试。