OpenSpec 完全使用指南：约束驱动 AI 编码

OpenSpec 完全使用指南：约束驱动 AI 编码 | 极客日志

痛点	描述
📉 理解偏差	花了两段话描述功能，AI 写出来的代码却跑偏了
🔄 重复解释	纠偏、重来，几轮下来上下文窗口消耗大半
💨 记忆蒸发	对话关闭后，所有讨论、决策、设计全部消失
⏸️ 中断丢失	被打断后回来，AI 完全不知道你之前做到哪了

npm install -g @fission-ai/openspec@latest

cd your-project && openspec init

openspec/
├── specs/ # 系统当前行为的"源真相"（Source of Truth）
├── changes/ # 每个变更的独立工作目录
└── config.yaml # 项目配置

schema: spec-driven
context:|
  技术栈：TypeScript、React 18、Node.js、PostgreSQL
  API 风格：RESTful，文档在 docs/api.md
  测试框架：Vitest + React Testing Library
  代码规范：参考 .eslintrc.js
rules:
  proposal:
    - 必须包含回滚方案
    - 标注影响的模块范围
  specs:
    - 使用 Given/When/Then 格式描述测试场景

Please read openspec/config.yaml and help me fill it out with details about my project, tech stack, and conventions

openspec config profile openspec update

你描述需求 → AI 直接写代码 → 发现理解不一致 → 返工

写规格 → AI 理解规格 → 基于规格写代码 → 基于规格验收

原则	说明
🧘 灵活，而非死板	没有"规划阶段不许写代码"这种锁定。写到一半发现 specs 不对？回去改就是了
🔄 迭代，而非瀑布	不要求一次把所有事情想清楚。先写个大概，边做边完善
📄 简单，而非复杂	就是几个 Markdown 文件，没有数据库、没有服务端、没有 Dashboard
🏗️ 存量优先	从第一天起就为"改存量系统"设计，而不是只能在空白项目上玩

openspec/
├── specs/ ← "系统现在是什么样的"
│   ├── auth/
│   ├── payments/
│   └── ...
└── changes/ ← "我们打算改什么"
    ├── add-dark-mode/
    └── fix-login-bug/

概念	含义	回答的问题
Specs（主规格）	系统当前行为的权威描述——"源真相"	系统现在是怎么运作的？
Changes（变更）	正在进行的修改——每个功能/Bug 修复独立一个文件夹	我们打算怎么改？

## Purpose
用户认证模块，管理登录、登出和会话维护。

### Requirement: Login Authentication
系统 MUST 在用户提供有效凭证时签发 JWT token。
系统 MUST 在凭证无效时返回 401 错误，且不泄露是用户名还是密码错误。
系统 SHOULD 在连续 5 次失败后触发临时锁定。
系统 MAY 支持"记住我"功能以延长 token 有效期。

关键字	含义
MUST	必须实现，不实现就是 Bug
SHOULD	强烈建议，除非有充分理由可以不做
MAY	可选的增强功能

#### Scenario: Successful Login
Given 用户名 "alice" 存在且密码正确
When 用户提交登录请求
Then 系统返回 200 和有效的 JWT token
And token 有效期为 24 小时

#### Scenario: Invalid Password
Given 用户名 "alice" 存在但密码错误
When 用户提交登录请求
Then 系统返回 401
And 错误信息不区分"用户不存在"和"密码错误"

proposal.md → specs/ → design.md → tasks.md
为什么做？ 做什么？ 怎么做？ 具体步骤

工件	回答的问题	内容
proposal.md	为什么要做这件事？	动机、范围（做什么和不做什么）、预期收益
specs/	系统行为会怎么改变？	用 Delta Specs 描述新增、修改、删除了哪些行为
design.md	技术上怎么实现？	架构决策、组件设计、技术选型的理由
tasks.md	具体要干哪几件事？	带复选框的实现清单，AI 在 `/opsx:apply` 时逐条执行

## ADDED Requirements
### Requirement: Theme Switching
系统 MUST 提供深色/浅色主题切换功能。
系统 SHOULD 支持跟随操作系统主题设置。

## MODIFIED Requirements
### Requirement: Page Background (MODIFIED)
- 原：系统 MUST 使用固定白色背景（#FFFFFF）
- 新：系统 MUST 根据当前主题设置显示对应的背景色

## REMOVED Requirements
### Requirement: Fixed Color Scheme (REMOVED)
- 原：系统 MUST 使用预设的固定配色方案
- 原因：被新的主题系统取代

场景	规格详细程度
日常开发（Lite Spec）	简短的行为描述、清晰的范围界定、基本的验收条件
高风险变更（Full Spec）	完整的 Given/When/Then 场景、边界条件分析、错误处理路径

You: /opsx:propose 用户可以通过 GitHub OAuth 登录，登录后自动创建账号，支持关联已有邮箱账号
AI: ✓ Created openspec/changes/add-github-oauth/
✓ proposal.md — scope & intent
✓ specs/auth.md — delta specs for authentication
✓ design.md — OAuth flow, token handling, account linking
✓ tasks.md — 8 implementation tasks
Ready for review!

You: /opsx:explore 我们应该用 WebSocket 还是 SSE 来实现实时通知？请分析当前的架构，评估两种方案
AI: Let me investigate your codebase...
Comparison:
• WebSocket: bidirectional, but requires nginx upgrade config
• SSE: simpler, works through existing HTTP stack
Recommendation: SSE for your use case.

You: /opsx:apply add-github-oauth
AI: Reading tasks.md... Found 8 tasks, 0 completed.
Working on task 1: Install passport-github2 dependency
✓ Added to package.json, ran npm install
Working on task 2: Create OAuth strategy configuration
✓ Created src/auth/github-strategy.ts
... All 8 tasks complete!

You: /opsx:archive add-github-oauth
AI: ✓ All 8 tasks completed
✓ Syncing delta specs to openspec/specs/auth.md
✓ Archived to openspec/archive/2026-02-27_add-github-oauth/
Change closed.

You: /opsx:new add-logout-button
AI: Created openspec/changes/add-logout-button/
Ready to create: proposal

You: /opsx:continue add-logout-button
AI: Creating proposal.md...
✓ proposal.md created
Next artifact: specs
You: （审查 proposal，发现范围需要调整，手动编辑）
You: /opsx:continue add-logout-button
AI: Creating specs/...
✓ specs/session.md created (delta)
Next artifact: design

You: /opsx:new add-logout-button
AI: Created openspec/changes/add-logout-button/
You: /opsx:ff
AI: Creating all planning artifacts...
✓ proposal.md
✓ specs/
✓ design.md
✓ tasks.md
Ready for implementation!

场景	选择
需求清晰、能一口气描述完	`ff`
需求还在打磨、想每步审查	`continue`
赶时间	`ff`
复杂变更、需要精细控制	`continue`

You: /opsx:verify add-logout-button
AI: Verifying implementation against specs...
✅ Completeness: 4/4 tasks done, all scenarios covered
⚠️ Correctness: WARNING — logout doesn't clear localStorage
✅ Coherence: Design patterns consistent
1 issue found. Recommend fixing before archive.

维度	检查内容
完整性	所有任务是否完成？需求场景是否覆盖？
正确性	实现是否匹配规格意图？边界条件是否处理？
一致性	代码结构是否反映设计决策？命名和模式是否统一？

You: /opsx:sync add-logout-button
AI: Merging delta specs into main specs...
✓ openspec/specs/session.md updated
Change remains active (not archived).

You: /opsx:bulk-archive
AI: Found 3 completed changes:
• add-logout-button (4/4 tasks)
• fix-session-timeout (3/3 tasks)
• update-user-profile (6/6 tasks)
⚠️ Conflict in specs/session.md detected → Resolved by checking actual implementation
✓ All 3 changes archived.

You: /opsx:onboard
AI: Welcome to OpenSpec! Let's walk through the workflow using your actual codebase...

openspec list # 查看所有活跃变更
openspec view # 交互式仪表盘
openspec show add-dark-mode # 查看某个变更的详情
openspec status add-dark-mode # 查看工件完成进度
openspec validate --all --strict # 检查所有变更和规格的格式
openspec archive add-dark-mode # 从终端归档
openspec config profile # 切换 Profile

/opsx:propose → 审查 → /opsx:apply → /opsx:verify → /opsx:archive

You: /opsx:propose 在用户设置页面添加深色模式开关，支持跟随系统主题，选择结果持久化到 localStorage
AI: ✓ Created openspec/changes/add-dark-mode/
✓ proposal.md — scope & intent
✓ specs/ui-theme.md — delta specs
✓ design.md — CSS variables approach, theme context
✓ tasks.md — 6 implementation tasks
Ready for review!
You: （扫了一遍 tasks.md，拆分合理，specs 覆盖了跟随系统和手动切换两种场景）
You: /opsx:apply add-dark-mode
AI: Working through tasks...
✓ Created ThemeContext with system preference detection
✓ Added CSS variables for light/dark themes
✓ Implemented toggle switch in Settings page
✓ Added localStorage persistence
✓ Updated existing components to use theme variables
✓ Added transition animations
All 6 tasks complete!
You: /opsx:verify add-dark-mode
AI: ✅ Completeness: 6/6 tasks, all scenarios covered
✅ Correctness: Matches spec intent
✅ Coherence: Consistent use of CSS variables
No issues found.
You: /opsx:archive add-dark-mode
AI: ✓ Synced delta specs → openspec/specs/ui-theme.md
✓ Archived to openspec/archive/2026-02-27_add-dark-mode/
Change closed.

/opsx:new → /opsx:ff → /opsx:apply → /opsx:verify → /opsx:archive

/opsx:explore → /opsx:new → /opsx:continue → ... → /opsx:apply → /opsx:archive

You: /opsx:explore 首页加载时间超过 3 秒，用户反馈很多。帮我分析一下瓶颈在哪，有哪些优化方向
AI: Investigating your codebase...
Found performance bottlenecks:
1. Homepage fetches 5 API endpoints sequentially (not parallel)
2. Product images are unoptimized PNGs (avg 2.3MB each)
3. No code splitting — main bundle is 1.8MB
4. SSR is disabled, full client-side rendering
Recommended priority:
1. Parallelize API calls (quick win, ~40% improvement)
2. Image optimization pipeline (medium effort, big impact)
3. Code splitting (one-time setup, ongoing benefit)
4. SSR (largest effort, evaluate ROI separately)
You: 先做第 1 和第 2 个吧，第 3 个后续再说
You: /opsx:new homepage-performance-fix
You: /opsx:continue homepage-performance-fix

# 功能 A
/opsx:propose feature-a → /opsx:apply feature-a
# 功能 B（同时进行）
/opsx:propose feature-b → /opsx:apply feature-b
# 全部完成后批量归档
/opsx:bulk-archive

/opsx:verify → 定位问题 → 手动修复或追加任务 → /opsx:apply → /opsx:verify → /opsx:archive

You: /opsx:verify add-dark-mode
AI: Verifying implementation against specs...
✅ Completeness: 6/6 tasks done
⚠️ Correctness: WARNING — Theme doesn't persist after page refresh
✅ Coherence: Design patterns consistent
1 issue found: localStorage write missing

You: 发现 localStorage 写入逻辑缺失，请补充
AI: Fixing the issue...
✓ Added localStorage.setItem('theme', selectedTheme) in ThemeContext
✓ Added loadSavedTheme() on app initialization
Fix complete!

You: /opsx:continue add-dark-mode
AI: All planning artifacts exist. You can:
- Edit tasks.md manually to add new tasks
- Or describe what needs to be added
You: 在 tasks.md 里追加两个任务：
1. 添加 localStorage 读取逻辑
2. 添加主题切换后的持久化写入
AI: ✓ Updated tasks.md with 2 new tasks
Ready for /opsx:apply

You: /opsx:apply add-dark-mode
AI: Reading tasks.md... Found 2 new tasks, 0 completed.
Working on task 1: Add localStorage read logic
✓ Added loadSavedTheme() in App.tsx
Working on task 2: Add persistence on theme change
✓ Added useEffect hook in ThemeContext
All tasks complete!

You: /opsx:verify add-dark-mode
AI: ✅ Completeness: 8/8 tasks done
✅ Correctness: Theme persists correctly after refresh
✅ Coherence: No issues found
Ready for archive!

You: /opsx:archive add-dark-mode
AI: ✓ Synced delta specs → openspec/specs/ui-theme.md
✓ Archived to openspec/archive/2026-03-11_add-dark-mode/
Change closed.

You: /opsx:list
AI: Active changes:
• add-dark-mode (6/6 tasks) — Ready for verify
• fix-login-bug (2/5 tasks) — In progress
• new-feature (0/4 tasks) — Planning complete

openspec list

You: /opsx:show fix-login-bug
AI: Change: fix-login-bug
Status: In progress (2/5 tasks completed)
Artifacts:
✓ proposal.md
✓ specs/auth.md
✓ design.md
✓ tasks.md (2 checked, 3 pending)
Pending tasks:
☐ Task 3: Add rate limiting to login endpoint
☐ Task 4: Implement account lockout after 5 failures
☐ Task 5: Add unit tests for lockout logic

openspec status fix-login-bug

You: /opsx:apply fix-login-bug
AI: Reading tasks.md... Found 3 tasks pending.
Working on task 3: Add rate limiting to login endpoint
✓ Added express-rate-limit middleware
... All 3 tasks complete!

You: /opsx:continue fix-login-bug
AI: Last completed artifact: specs
Next artifact: design.md
Creating design.md...
✓ design.md created
Next artifact: tasks

You: 帮我读一下 openspec/changes/fix-login-bug/specs/auth.md
AI: Reading specs...
Current delta specs for auth module:
- ADDED: Account lockout after 5 failed attempts
- MODIFIED: Login error response (no distinction between "user not found" and "wrong password")
Based on these specs, the implementation should...

You: /opsx:sync fix-login-bug
AI: Merging delta specs into main specs...
✓ openspec/specs/auth.md updated
Change remains active (not archived).

编辑 specs/ → /opsx:sync → 更新 tasks.md → /opsx:apply → /opsx:verify

You: /opsx:verify fix-login-bug
AI: Verifying implementation against specs...
⚠️ Completeness: WARNING — Missing scenario coverage
The following scenario is not tested:
- Scenario: Account Unlock After Timeout
Recommendation: Add this scenario to specs and implement corresponding logic.

## ADDED Requirements
### Requirement: Account Lockout (MODIFIED)
系统 MUST 在连续 5 次登录失败后锁定账户。
系统 MUST 在锁定 30 分钟后自动解锁。← 新增

#### Scenario: Account Lock After Failed Attempts
Given 用户连续 5 次输入错误密码
When 第 5 次登录请求提交
Then 系统返回 401
And 账户被锁定 30 分钟

#### Scenario: Account Unlock After Timeout ← 新增场景
Given 账户因多次失败被锁定
When 30 分钟过去
Then 账户自动解锁
And 用户可以重新尝试登录

You: /opsx:sync fix-login-bug
AI: Merging delta specs into main specs...
✓ openspec/specs/auth.md updated
Change remains active.

## Tasks
- [x] Task 1: Install rate limiting library
- [x] Task 2: Create login attempt counter
- [x] Task 3: Implement account lockout logic
- [ ] Task 4: Add automatic unlock after 30 minutes ← 新增
- [ ] Task 5: Add unit tests for unlock logic ← 新增

You: 在 tasks.md 里追加两个任务：
1. 添加 30 分钟后自动解锁逻辑
2. 添加解锁场景的单元测试
AI: ✓ Updated tasks.md with 2 new tasks

You: /opsx:apply fix-login-bug
AI: Reading tasks.md... Found 2 new tasks.
Working on task 4: Add automatic unlock logic
✓ Added scheduled job to clear lockouts
Working on task 5: Add unit tests
✓ Created auth-unlock.test.ts with 3 test cases
All tasks complete!

You: /opsx:verify fix-login-bug
AI: ✅ Completeness: 5/5 tasks done, all scenarios covered
✅ Correctness: Implementation matches updated specs
✅ Coherence: No issues found
Ready for archive!

You: /opsx:new user-registration-module
AI: Created openspec/changes/user-registration-module/
Ready to create: proposal

You: 这是我们的 PRD 文档，请帮我生成 proposal.md：
[粘贴 PRD 内容或上传文件]
AI: Analyzing requirements...
✓ Created proposal.md with:
- Problem statement: User registration friction
- Scope: Email registration, verification, welcome flow
- Out of scope: Social login, SSO (future phases)
- Expected impact: 30% reduction in signup drop-off

You: /opsx:continue user-registration-module
AI: Creating specs/...
✓ specs/registration.md created (delta)
Generated 8 requirements and 12 scenarios based on the proposal. Please review for accuracy.

You: （阅读 specs/registration.md，发现需要调整）
You: 第 3 个场景需要修改，密码强度要求应该是：
- 至少 8 个字符
- 包含大小写字母和数字
而不是现在的 6 个字符
AI: ✓ Updated specs/registration.md

You: /opsx:ff user-registration-module
AI: Creating remaining artifacts...
✓ design.md — Database schema, API endpoints, validation logic
✓ tasks.md — 12 implementation tasks
Ready for /opsx:apply!

# Proposal: User Registration Module
## Problem
当前注册流程转化率仅 45%，主要流失点在邮箱验证环节。

## Scope
### In Scope
- 邮箱注册表单
- 邮箱验证邮件发送
- 验证码校验接口
- 欢迎邮件流程
### Out of Scope
- 社交账号登录（后续迭代）
- SSO 企业登录（后续迭代）

## Expected Impact
- 注册转化率提升至 65%
- 验证邮件打开率 > 80%

You: /opsx:continue user-registration-module
AI: Reading proposal.md...
✓ Creating specs/registration.md
Generated 8 requirements and 12 scenarios

You: /opsx:ff user-registration-module
AI: ✓ design.md created
✓ tasks.md created — 12 tasks
Ready for /opsx:apply!

You: 请读取这个需求文档并帮我创建 OpenSpec 工件：
https://docs.company.com/prd/user-registration
AI: Fetching and analyzing document...
✓ Created openspec/changes/user-registration-module/
✓ proposal.md — extracted from PRD
✓ specs/registration.md — 8 requirements, 12 scenarios
✓ design.md — technical approach
✓ tasks.md — 12 implementation tasks
Ready for review!

You: （审查生成的工件，调整 specs 中的边界条件）
You: specs 里需要增加一个场景：
当邮箱已经被注册时，应该提示"该邮箱已注册"而不是"注册失败"
AI: ✓ Updated specs/registration.md
Added Scenario: Duplicate Email Registration

PRD 内容	OpenSpec 工件
问题陈述/背景	proposal.md — Problem
功能范围	proposal.md — Scope
功能列表	specs/ — Requirements
用户故事/用例	specs/ — Scenarios
技术方案	design.md
任务分解	tasks.md
验收标准	specs/ — Scenarios

做法	说明
📝 先写规格再写代码	花 5 分钟写规格，可能节省 1 小时返工
🎯 渐进式严格	日常开发用 Lite Spec，高风险变更用 Full Spec
🔄 及时归档	功能完成后立即归档，保持 specs 最新
🔍 归档前 verify	跑一次 `/opsx:verify` 抓住遗漏
📁 配置 context	一次配置，AI 永远知道你的技术栈
🧩 小步快跑	一个变更聚焦一个功能，不要贪大

坑	建议
🚫 跳过 specs 直接写代码	失去规格驱动的意义
🚫 规格写得太细	描述行为，不要描述实现细节
🚫 长期不归档	specs 会过时，失去参考价值
🚫 一个大变更包含太多功能	拆分成小变更，便于审查和回滚
🚫 忽略 context 配置	每次都要重复交代技术栈

┌─────────────────────────────────────────────────────────┐
│ OpenSpec 工作流 │
├─────────────────────────────────────────────────────────┤
│ │
│ 需求清晰 需求模糊 │
│ ↓ ↓ │
│ /opsx:propose /opsx:explore │
│ ↓ ↓ │
│ 审查工件 /opsx:new │
│ ↓ ↓ │
│ /opsx:apply /opsx:continue/ff │
│ ↓ ↓ │
│ /opsx:verify /opsx:apply │
│ ↓ ↓ │
│ /opsx:archive /opsx:verify │
│ ↓ │
│ /opsx:archive │
│ │
└─────────────────────────────────────────────────────────┘

OpenSpec 完全使用指南：约束驱动 AI 编码

OpenSpec 完全使用指南

一、为什么需要 OpenSpec

AI 编码的真正瓶颈不是代码，是对齐

OpenSpec 的解决思路

二、安装与初始化

前置要求

安装

初始化项目

配置项目上下文（强烈推荐）

启用扩展命令

三、核心理念

为什么要先写"规格"再写代码？

四个设计原则

两个核心概念：Specs 和 Changes

Specs 长什么样？

需求 - 用 RFC 2119 关键字表达意图强度

场景 - Given/When/Then 格式

工件（Artifacts）：从"为什么"到"怎么做"

Delta Specs：改存量代码的秘密武器

渐进式严格：不需要一步到位

四、命令详解

核心命令（Core Profile，默认可用）

/opsx:propose — 需求清晰时，一步到位

/opsx:explore — 不确定的时候，先探索

/opsx:apply — 按清单执行实现

/opsx:archive — 收尾归档

扩展命令（需启用 Expanded Profile）

/opsx:new — 只建骨架，不急着填内容

/opsx:continue — 一步一步来，每步都能审查

/opsx:ff — 快进生成所有剩余工件

/opsx:verify — 归档前的质量检查

/opsx:sync — 只同步规格，不归档

/opsx:bulk-archive — 并行开发后的批量收尾

/opsx:onboard — 交互式上手教程

CLI 工具命令

五、实战场景

场景一：需求清晰，直接开干

场景二：需求模糊，需要边探索边明确

场景三：并行开发多个功能

场景四：已标记完成但未归档的 change 发现 Bug 如何修复

场景五：重新开启客户端，如何继续工作

场景六：发现未完成的 change 有场景遗漏，怎么处理

场景七：有明确的需求文档，怎么开始

路径 A：让 AI 从需求文档生成工件（推荐）

路径 B：手动创建 proposal，再让 AI 生成后续

路径 C：需求文档是外部链接或文件

六、最佳实践

✅ 推荐做法

❌ 避免的坑

工作流总结

附录

相关资源

常见问题

微信扫一扫，关注极客日志

更多推荐文章

相关免费在线工具

`/opsx:propose` — 需求清晰时，一步到位

`/opsx:explore` — 不确定的时候，先探索

`/opsx:apply` — 按清单执行实现

`/opsx:archive` — 收尾归档

`/opsx:new` — 只建骨架，不急着填内容

`/opsx:continue` — 一步一步来，每步都能审查

`/opsx:ff` — 快进生成所有剩余工件

`/opsx:verify` — 归档前的质量检查

`/opsx:sync` — 只同步规格，不归档

`/opsx:bulk-archive` — 并行开发后的批量收尾

`/opsx:onboard` — 交互式上手教程