Skip to content

指南导览

本页按真实研发链路组织官网指南。Spec-First 的核心不是固定阶段列表,而是把 CLI、宿主 runtime、workflow 入口和项目内产物连成可验证的工程闭环。

入门

页面适合场景
安装指南安装 spec-first CLI,初始化 Claude Code 或 Codex runtime assets
快速开始doctorinit 到 setup、graph bootstrap 和第一个 workflow 的最短路径
首次工作流走查用一个小需求看清 requirements、plan、task pack、work、review 如何衔接
完整示例端到端示例:CLI 引导改进的 ideate→brainstorm→plan→work→review→compound 全链路

准备阶段(Codebase)

进入主链 workflow 前,先把环境、graph 和规范基线准备好。

text
spec-first doctor / init


spec-mcp-setup            准备 MCP、helper tools、provider config、setup facts


spec-graph-bootstrap      编译 graph readiness、provider status、impact envelope


spec-standards(可选)     生成项目规范候选、glue map、standards preview
页面适合场景
MCP Setup安装并验证 MCP servers、graph providers、helper CLIs(agent-browser/ast-grep 等)
Graph Bootstrap编译 graph readiness facts、provider status 和 impact capability envelope
Project Standards为 brownfield 项目建立规范、shared standards 和复用能力基线
Update(运行时漂移修复)检查 CLI 与 runtime assets 是否需要刷新

主链工作流

主链不是强制线性状态机,按当前最匹配的节点进入即可。

text
spec-ideate(可选)        基于代码事实生成候选方向


spec-brainstorm           把方向收敛为需求、边界、验收标准


spec-plan                 拆成实施单元、文件范围、风险和验证方式


spec-work / spec-debug    在计划边界内改代码、定位 bug、补测试


spec-code-review          按 diff 触发 always-on + 条件 reviewer


spec-compound             沉淀可复用经验
页面适合场景
Workflow 命令总览逐个理解 21 个公开 workflow skill 的输入、分支、产物和交接方式
Ideate 指南需要发散候选方向或判断想法质量
Brainstorm 指南目标还不够清楚,需要形成 requirements brief
Plan 指南目标已定,需要设计工程路径和验证方式
Work 指南已有 plan 或 task pack,需要执行最小可验证改动
Debug 指南测试失败、stack trace 或异常行为需要先复现再决定修复
Code Review 指南合并前对 diff、PR 做结构化代码评审
App 一致性审查移动 App 在运行时验证前需要静态审查 PRD、Figma、source、路由、架构
Compound 指南问题已稳定解决,需要沉淀可复用经验
Sessions 指南跨会话回看历史尝试、决策与失败

工程实践

页面适合场景
三种开发模式判断单仓单项目、单仓多模块、多仓工作区下 .spec-first 的权威边界
产物目录与 Git 边界判断哪些文档、runtime copies 和 .spec-first/ facts 应该提交或忽略
.gitignore 参考init 自动维护的 managed block 内容、典型产物树和多仓特殊处理
Skill Audit维护 skills/ source assets,审查 trigger、边界、治理投递、runtime drift
Todo 与任务系统大计划需要可交接、可 hash、可 validate 的执行任务包
LFG 自主执行历史/辅助说明,当前主路径优先使用安装后的 host workflow

帮助

页面适合场景
常见问题快速确认入口、review 拆分、当前数量事实