@culeo/specx
v0.1.6
Published
Install specx skills to AI coding agents (Claude Code, Codex, etc.)
Maintainers
Readme
specx
企业级 AI 研发流程 — 需求 → 澄清 → 规格 → 设计 → 任务 → 执行 → 归档
specx 是一套企业级研发流程 skill 系列,核心理念是先签合同再施工:以规格说明书为蓝图,原子化执行,可追溯可回滚。
🎯 核心理念
| | 传统开发 | specx | |---|---|---| | 核心资产 | 代码 | 规格说明书(Spec) | | 开发模式 | 边做边改 | 先签合同再施工 | | AI 协作 | AI 自由发挥 | AI 照"蓝图"执行 | | 交付风险 | 不可控、难审查 | 原子化、可回滚 |
📦 Skill 系列
| Skill | 功能 | 状态 |
|-------|------|------|
| specx-demystify | 需求分析 & 领域拆解 | ✅ 完成 |
| specx-clarify | 需求澄清 & 规格输出 | ✅ 完成 |
| specx-design | 实现规划 & 详细设计 | ✅ 完成 |
| specx-create-design-template | 生成项目专属设计模板 | ✅ 完成 |
| specx-writing-plans | 设计文档转任务清单 | ✅ 完成 |
| specx-executing-plans | 执行任务清单 | ✅ 完成 |
| specx-archive | 归档沉淀到 wiki | ✅ 完成 |
| specx-create-rule | 创建/维护框架规范 | ✅ 完成 |
| specx-docs-align | 文档对齐检查 | ✅ 完成 |
🔄 完整流程
需求输入(PRD / 需求文档)
│
▼
┌─────────────────────┐
│ specx-demystify │ ← Step 1:拆解需求
│ • MECE 领域划分 │ 产出:原子化子需求
│ • MoSCoW 优先级 │
│ • 依赖关系分析 │
└──────────┬──────────┘
▼
┌─────────────────────┐
│ specx-clarify │ ← Step 2:需求澄清
│ • 用户场景 │ 产出:01-clarify.md
│ • 功能要点 & 边界 │ 02-spec.md
│ • Q&A 迭代 │
└──────────┬──────────┘
▼
┌─────────────────────┐
│ specx-design │ ← Step 3:实现规划
│ • 整体架构 │ 产出:03-design.md
│ • 各平台详细设计 │ (按项目模板)
│ • 可复用组件 │
└──────────┬──────────┘
▼
┌─────────────────────┐
│ specx-writing-plans │ ← Step 4:任务拆解
│ • 任务清单 │ 产出:04-tasks.md
│ • 并行组 & 依赖 │
│ • MoSCoW 优先级 │
└──────────┬──────────┘
▼
┌─────────────────────┐
│ specx-executing-plans│ ← Step 5:执行
│ • 原子任务执行 │ 产出:代码
│ • 小 PR 产出 │
└──────────┬──────────┘
▼
┌─────────────────────┐
│ specx-archive │ ← Step 6:归档
│ • 提炼到 wiki │ 产出:docs/specx/wiki/
│ • 知识沉淀 │
└─────────────────────┘📂 目录结构
docs/specx/
├── spaces/ # 需求空间(每个需求独立目录)
│ └── {yyyyMMdd}-{需求摘要}/
│ ├── raws/ # 原始需求来源(多源分类)
│ │ ├── P001-{需求名称}.md # 产品需求文档
│ │ ├── U001-{用户反馈}.md # 用户输入/语料
│ │ └── ...
│ ├── t-01-{子需求名}/
│ │ ├── 00-子需求.md # 子需求原始描述(由 demystify 产出)
│ │ ├── 01-clarify.md # 澄清记录
│ │ ├── 02-spec.md # 规格说明书
│ │ ├── 03-design.md # 设计方案
│ │ └── 04-tasks.md # 任务清单
│ └── t-02-{子需求名}/
│ └── ...
├── wiki/ # 项目知识库(归档沉淀)
├── rules/ # 框架规范
└── templates/ # 项目专属模板🧩 关键约定
- 文件名规范:
00-子需求.md/01-clarify.md/02-spec.md/03-design.md/04-tasks.md - wiki 知识沉淀:
docs/specx/wiki/,由specx-archive维护 - 框架规范:
docs/specx/rules/,clarify 时跳过已有规范,不重复提问 - 项目模板:
docs/specx/templates/,首次 design 时生成
🚀 快速开始
# 全局安装
npm install -g @culeo/specx
# 交互式安装(选择 AI 工具 + 选择用户/项目级)
specx install
# 指定目标安装
specx install --claude # 装到 Claude Code(用户级)
specx install --codex # 装到 Codex(用户级)
specx install --claude --codex # 装到两边
# 项目级安装(.claude/skills/)
specx install --claude --project
# 非交互式:装到所有已检测的工具
specx install --all
# 查看已安装的 specx skills
specx list
# 查看可用 skills
specx available
# 卸载
specx uninstall --claude
specx uninstall --codex --project📝 License
Internal use only.
