# OpenSpec - 规范驱动开发 ## 概述 OpenSpec 是一个规格驱动开发（Spec-Driven Development, SDD）框架，让你在写程式码之前先写规格，确保开发方向正确、减少返工。 ## 何时使用 *规划新功能时 *需要记录功能规格时 *变更提案管理 *团队协作开发 *使用者提到"spec"、"规格"、"SDD"时 ## 快速参考 ### CLI directive (dash spec) Instructions | ---|--- Initialize OpenSpec `dash spec init .` | `dash spec list.` | 列出活动变更 `dash spec view.` | `dash spec show.` | 显示变更详情 `dash spec validate.` | `dash spec archive.` | 归档完成的变更 `dash spec status.` | 快速状态总览 ### OpenSpec Native Directive Instructions | ---|--- `openspec init` | `openspec list` | 列出变更 `openspec view` | 互动式仪表板 `openspec show ` | 显示详情 `openspec validate ` | `openspec archive ` | 归档变更 ## SDD Workflow（五步循环） 1. SPEC(规格化) └──定义功能规格→ openspec/specs/feature-name.md 2. Proposal (proposal) a. └──建立变更提案→ openspec/changes/change-name.md 3. 实施（实作） └──根据规格实作程式码 4. 验证（验证） └──确认实作符合规格 5. ARCHIVE（归档） └──完成后归档变更 → dash spec archive.change-name ## 文件结构项目/ └── openspec/ ├── specs/ #功能规格 │ ├── auth.md │ └── dashboard.md ├──changes/ #活动变更提案 │ └── add-login-feature.md └──archive/ #已归档的变更 └── 2026-01-setup-project.md ## 规格文件格式 --- title: 使用者认证状态：活动创建时间：2026-01-17 --- #使用者认证 ## Overview 实作使用者登入/登出功能。 ## Functional Requirements a. 1. 支援Email+密码登入 2. Support Google OAuth 3. 记住登入状态 ## API规格 - 发布/api/auth/登录 - POST /api/auth/logout - 获取 /api/auth/me ## 相关变更 - [[添加登录功能]] ## 更改文件格式 --- title: 新增登入功能类型：功能状态：进行中规格：身份验证创建时间：2026-01-17 --- # Added login ## 变更内容实作Email+密码登入功能。 ## 影响范围 - `src/auth/` 目录 - `src/api/routes/auth.ts` ##测试计画 1. 单元测试：登入逻辑 2. 整合测试：API 端点 3. E2E测试：登入流程 ## 清单 - []实作登入表单 - [] 实作 API 端点 - []撰写测试 - [ ] Update the file ## 最佳实践 ### 1\. 先写规格再写程式码 *规格是开发的蓝图 *减少返工和误解 *便于团队沟通 ### 2\.保持规格更新 *实作后更新规格 *记录变更历史 *定期审视过期规格 ### 3\.善用变更提案 *每个功能一个变更 *明确定义范围 *完成后及时归档 ### Integration with dash-devtools 4\. * `dash validate.` 自动验证规格 * `dash health.` 显示规格健康度 * `dash spec status.` 快速总览 ## 与 dash-devtools 集成 ### 验证整合 #自动侦测openspec/并验证破折号验证。 #检查项目： # - 目录结构完整性 # - 规格档案格式 #-过期变更提醒 ###健康评分 #显示规格健康度破折号健康。 #评分项目： #-规格覆盖率 #-变更处理率 #-格式正确性 ## 安装 #安装OpenSpec CLI npm install -g @fission-ai/openspec@latest #验证安装 openspec --version #在专案中初始化 CD 你的项目破折号规范初始化。 ## 故障排除 ### openspec未安装 npm install -g @fission-ai/openspec@latest ###规格格式错误确保每个 .md 档案都有 YAML frontmatter： --- title: 规格标题状态：活动 --- #内容... ### 过期变更警告使用 `dash spec archive.` 归档已完成的变更。 ## 相关资源 * [OpenSpec GitHub]() * [规格驱动开发]() * [dash-devtools]()

开放规范

包含技能