SuperAPI AI 工具集

musubix-sdd-workflow

编程与开发

查看项目

更新于 11-13 04:20

技能介绍

用途

MUSUBIX SDD Workflow 是一个工作流指南型技能,用于在 MUSUBIX 项目中按照规范驱动开发(Specification-Driven Development,SDD)方法论开发功能。当被要求用 MUSUBIX 方法论开发特性、创建需求等任务时适用。

前置准备

开始任何开发任务前,需要:

  • 阅读 steering/ 目录以了解项目背景
  • 检查 steering/rules/constitution.md 中的九条宪法条款
  • 回顾 storage/specs/ 中已有的规格文档

工作流概览

第一阶段:需求定义

创建需求文档(对应宪法第四条 EARS 格式)。需求条目结构包括编号、种别(UBIQUITOUS / EVENT-DRIVEN / STATE-DRIVEN / UNWANTED / OPTIONAL)、优先级(P0/P1/P2)、EARS 形式的需求文以及可追溯性字段(DES-XXX、TEST-XXX)。

EARS 模式包括:

  • Ubiquitous:THE [system] SHALL [requirement]
  • Event-driven:WHEN [event], THE [system] SHALL [response]
  • State-driven:WHILE [state], THE [system] SHALL [response]
  • Unwanted:THE [system] SHALL NOT [behavior]
  • Optional:IF [condition], THEN THE [system] SHALL [response]

随后进行需求评审循环,检查 EARS 格式合规性、完整性与清晰度、可测试性、可追溯性就绪情况,重复直到无问题为止。

第二阶段:设计

创建设计文档(对应宪法第七条设计模式),采用 C4 模型,包含上下文层、容器层、组件层和代码层。文档模板包含可追溯性段落(关联需求编号)、C4 模型(Level 2 容器层,含 PlantUML 图)以及组件设计细节。

设计评审循环检查需求覆盖度、SOLID 原则合规性、设计模式的适当性以及与需求的可追溯性,重复直到无问题。

第三阶段:任务拆解

从设计生成实现任务。每个任务包含关联设计与关联需求编号、任务内容、受入基准(验收标准)和工时估算(建议 4 小时以内)。

任务评审循环检查粒度是否合适(不超过 4 小时)、验收标准是否清晰、可追溯链是否完整,重复直到无问题。

第四阶段:实现

编码与单元测试遵循测试优先(宪法第三条)的 Red-Green-Blue 循环:Red 先写失败测试,Green 写最小代码使测试通过,Blue 在保持测试通过的前提下重构。代码注释中需标注需求编号,例如:

/**
 * @see REQ-INT-001 - Neuro-Symbolic Integration
 */

如任务需要,运行集成测试,验证组件交互并确保端到端流程正确。

第五阶段:文档与完成

更新 CHANGELOG.md,记录新功能、缺陷修复、破坏性变更和迁移说明;必要时更新 README.md、USER-GUIDE.md、API-REFERENCE.md、AGENTS.md 等文档;最后执行 Git 提交与推送:

git add .
git commit -m "feat/fix/chore: description"
git push

可追溯性验证

对应宪法第五条,确保整个流程保持 100% 可追溯:REQ-* → DES-* → TSK-* → 代码 → 测试。

CLI 命令

npx musubix requirements analyze <file>
npx musubix requirements validate <file>
npx musubix design generate <file>
npx musubix design patterns <context>
npx musubix codegen generate <file>
npx musubix trace matrix
npx musubix trace validate

宪法条款清单

  • 第一条 Library-First:是否为独立库?
  • 第二条 CLI Interface:是否暴露 CLI?
  • 第三条 Test-First:是否先写测试?
  • 第四条 EARS Format:需求是否为 EARS 格式?
  • 第五条 Traceability:是否一切可追溯?
  • 第六条 Project Memory:是否检查了 steering/?
  • 第七条 Design Patterns:设计模式是否已记录?
  • 第八条 Decision Records:是否创建了 ADR?
  • 第九条 Quality Gates:是否通过质量检查?

适用场景

适用于需要以结构化、可追溯方式推进功能开发的 MUSUBIX 项目,尤其适合需要严格需求格式、设计文档化、细粒度任务管理和测试优先实践的场景。

限制

资料仅描述工作流与命令形式,未提供具体安装步骤、收费信息、平台兼容性范围或实际效果数据。