在 AI 编程时代,如何让 AI 编码助手更准确地理解需求、生成符合规范的代码?MumuSpec 提供了一套解决方案。它是一个文档体系,最近发布了 CLI 工具(v0.1.0),并已发布到npm。
MumuSpec CLI 的核心价值在于:
- 生成 14 份 Spec 文档模板:搭好完整的目录结构
- 提供校验和维护命令:追踪文档完整性、变更影响面和版本冻结
- 五轮工作流:从需求采集到实施计划的完整流程
当前版本还很早期,覆盖了基本的使用流程。本文将详细介绍其安装、命令和使用流程。
安装
依赖 Node.js ≥ 18。全局安装:
npm install -g mumuspec
命令一览
所有命令分为四组:项目初始化、五轮工作流、维护与校验、角色视图。
项目初始化
| 命令 | 作用 |
|---|---|
create |
生成 Spec 项目骨架(14 份模板 + AGENTS.md) |
status [dir] |
查看 Spec 填写进度 |
console [dir] [out] |
生成 Spec 可视化控制台 HTML |
五轮工作流
| 命令 | 轮次 | 产出 |
|---|---|---|
elicit [dir] |
R1·采集 | 02 需求采集 |
propose [dir] |
R2·提案 | 03 立项提案 + 04 PRD |
anchor [dir] |
R3·锚定 | 05 用户故事 ↔ 09 API 契约 |
design [dir] |
R4·设计 | 06 FSD + 07 NFR + 08 架构 + 10 数据 + 11 安全 |
close [dir] |
R5·收口 | 12 实施计划 + 13 测试策略 + 14 追溯矩阵 |
维护与校验
| 命令 | 作用 |
|---|---|
validate [dir] |
门禁校验:检查文档完整性、AC-API 追溯、冻结状态 |
impact [dir] |
变更影响分析:改这份文档会波及哪些 |
sync [dir] |
变更联动:更新关联文档 |
freeze [dir] |
版本冻结:打 Git tag + 锁定当前 Spec |
角色视图
| 命令 | 作用 |
|---|---|
view --role [dir] |
按角色筛选需要关注的文档 |
典型使用流程
新项目初始化
mumuspec create my-project
cd my-project
mumuspec status
status 输出每份文档的填写状态。刚创建时是 0/14。
然后按五轮工作流逐步填写:
mumuspec elicit # 把需求素材整理到 02
mumuspec propose # 写立项提案和 PRD
mumuspec anchor # 写用户故事,同时对齐 API 契约
mumuspec design # 出技术设计
mumuspec close # 出计划、测试策略、追溯矩阵
每一轮完成后再跑下一轮,不用一次全写完。
日常变更管理
改了某个 Spec 文档后,运行校验:
mumuspec validate
validate 的输出是按文档逐条检查,例如:
🔍 MumuSpec 门禁校验
✅ 01 写作总则
✅ 04 产品需求 PRD
❌ 05 用户故事 (内容不足)
❌ 06 功能规格 FSD (内容不足)
⚠️ AC-API 追溯: 05 有 AC 但 09 未关联 US 编号
📊 通过 9/14,未通过 5/14
如果改了某份核心文档(比如 05-用户故事),跑一下影响分析:
mumuspec impact 05-user-stories
输出被波及的文档。然后用 sync 联动更新:
mumuspec sync 05-user-stories
里程碑冻结:一个迭代的 Spec 定稿后:
mumuspec freeze
自动打 Git tag,锁定当前 Spec 版本。
按角色查看
不同角色关注不同的文档子集。指定 role 参数:
mumuspec view --role dev # 开发者:US → FSD → API → 数据模型 → 实施计划
mumuspec view --role pm # PM:立项提案 + PRD + 用户故事
mumuspec view --role qa # QA:用户故事 AC + 测试策略 + 追溯矩阵
mumuspec view --role arch # 架构师:NFR + 架构选型 + 安全设计 + 数据模型
AGENTS.md:AI 编码助手的工作流
mumuspec create 同时生成 AGENTS.md,定义了 AI 编码助手在本项目中的工作流程:
- 接到任务 → 读取相关 Spec 文档理解需求
- 基于 Spec 中的 AC 确认验收标准生成代码
- 严格按 API 契约和数据模型自检
- 对照 Spec 逐条验证 AC 提交 PR → 关联 Spec 编号
苏米注:Spec 文档同时作为 AI Agent 的输入源。这意味着,只要你按照 MumuSpec 的规范写好文档,AI 编码助手就能更准确地理解你的意图,生成符合规范的代码。这是 Spec-Driven Development 的核心理念。
v0.1.0 的边界
当前版本做的事情:
- 生成模板、校验完整性、追踪影响面、角色视图、版本冻结
- 五轮工作流的命令提供阶段标记和上下文提示,不自动生成 Spec 内容
当前版本没做的事情:
- 五轮工作流命令的具体行为(每个命令应该做哪些检查、给哪些提示)还需要在实际使用中迭代
- Delta 变更机制在文档体系中定义了,但 CLI 层面还没落地
- Fitness Functions 的自动运行还未接入
- 没有配置文件(mumuspec.config.yaml),项目级别设置通过命令行参数传入
后续版本会逐步补全这些功能。
相关链接
Any Tool, Any Team. MumuCoding for Every Builder.
声明:本站原创文章文字版权归本站所有,转载务必注明作者和出处;本站转载文章仅仅代表原作者观点,不代表本站立场,图文版权归原作者所有。如有侵权,请联系我们删除。