Skip to content

README_zh.md

Latest commit

 

History

History
150 lines (106 loc) · 5 KB

README_zh.md

File metadata and controls

150 lines (106 loc) · 5 KB

Superspec（中文说明）

规格驱动开发 + 超级能力

Superspec 是一个面向 AI 编程 CLI 的代理技能，将 spec-kit 项目治理与 obra/superpowers 代理能力 统一到一个开发工作流中。它兼容所有支持 spec-kit 的编程代理， 包括 Claude Code、 Codex CLI 等。

Spec-kit 提供文档结构和治理（宪章、规格、计划、任务）。 Superpowers 提供深度澄清（头脑风暴）、智能任务拆解（计划编写）和工程执行纪律（TDD、子代理驱动开发、代码审查）。

架构概览

AI助力: 端到端开发工作流（SDD）

工作流编排 6 个阶段——从项目定义到工程实现——spec-kit 负责治理文档，superpowers 提供智能澄清、任务拆解和执行能力。

安装

快速安装

# 克隆仓库
git clone https://github.com/your-org/superspec.git

# 安装到代理的技能目录（选择其一）：
# Claude Code
ln -sf "$(pwd)/superspec" ~/.claude/skills/superspec
# Codex CLI
ln -sf "$(pwd)/superspec" ~/.codex/skills/superspec
# 其他代理（通用约定）
ln -sf "$(pwd)/superspec" ~/.agents/skills/superspec

手动安装

将整个 superspec/ 目录复制到代理的技能目录。各平台常见路径：

代理 技能目录
Claude Code ~/.claude/skills/superspec
Codex CLI ~/.codex/skills/superspec
其他 ~/.agents/skills/superspec 或查阅代理文档

可选：安装 Superpowers

Superspec 可以独立工作，但安装 superpowers 技能可获得增强能力：

# 安装 obra/superpowers（具体方式请参见其仓库）
# 技能应放置在 ~/.agents/skills/ 或 .agents/skills/

命令列表

命令 说明
/superspec.status 显示当前进度并建议下一步操作
/superspec.constitution 创建或更新项目治理原则
/superspec.specify 创建功能规格（含用户故事）
/superspec.brainstorm 深入探索边界情况，完善规格文档
/superspec.plan 创建技术实现方案
/superspec.tasks 生成分阶段任务清单
/superspec.execute 以 TDD + 子代理编排方式执行实现
/superspec.review 对照规格进行代码审查
/superspec.checklist 生成上下文相关的检查清单

可中断恢复

所有项目状态以纯文本（Markdown + YAML）持久化在 .specify/ 目录中。 会话中断时——代理超时、用户离开、CLI 崩溃——不会丢失任何进度。 在新会话中运行 /superspec.status 即可查看中断点：

Superspec 项目状态
==================
宪章: 已完成
功能:
  001-user-auth    [####------] 执行中 (阶段 5/6) — 11/19 任务完成
  002-photo-upload [##--------] 头脑风暴 (阶段 2/6) — 2 个待解决问题

建议下一步: /superspec.execute 001

每个命令会自动检测之前的进度并从中断点恢复——跳过已完成的工作，从未解决的问题或未完成的任务继续。

快速开始

1. 初始化项目治理

/superspec.constitution 我的项目

创建 .specify/ 目录结构，并引导你定义核心原则、技术栈和质量门禁。

2. 编写第一个功能规格

/superspec.specify "用户邮箱密码登录认证"

在 .specify/specs/001-user-authentication/spec.md 创建功能规格，包含用户故事、需求和成功标准。

3. 头脑风暴边界情况

/superspec.brainstorm .specify/specs/001-user-authentication/spec.md

代理逐个提出探索性问题，发现你可能没有想到的边界条件、错误场景、安全隐患和用户体验陷阱。

4. 规划与执行

/superspec.plan                  # 创建技术实现方案
/superspec.tasks                 # 生成任务拆解
/superspec.execute               # 以 TDD 纪律和检查点方式实现
/superspec.review                # 对照规格验证实现

工作流

宪章 → 规格 → 头脑风暴 → 计划 → 任务 → 执行 → 审查
                ↑     ↓
                └─────┘（反复迭代直到规格完善）

每个阶段都有明确的门禁——在推进前验证前置条件。人工检查点确保你控制推进节奏。

Superpowers 集成

当安装了 obra/superpowers 技能时，superspec 会自动检测并使用：

Superspec 命令 增强来源 降级方案
brainstorm brainstorming 技能 内置提问协议
tasks writing-plans 技能 基于模板的拆解
execute executing-plans + subagent-driven-development + test-driven-development 顺序执行+手动确认
review requesting-code-review 技能 内置审查清单

详见 superpowers-bridge.md。

许可证

MIT