简介

​OpenSpec​ 是一个革命性的规范驱动开发框架，旨在通过规范驱动的方法协调人类和AI编程助手，确保在编写任何代码之前就达成一致意见。该框架无需API密钥，提供轻量级的工作流程，使AI辅助开发更加可预测和可审查。

🔗 ​GitHub地址​：

https://github.com/Fission-AI/OpenSpec

📋 ​核心价值​：

规范驱动 · AI编程 · 可预测性 · 无需API密钥 · 轻量级工作流

​项目背景​：

• ​AI编程挑战​：AI编程助手的不确定性

• ​规范需求​：开发规范管理需求

• ​协作问题​：人机协作挑战

• ​质量保证​：代码质量保证需求

• ​开源生态​：开源开发工具生态

​项目特色​：

• 🚀 ​轻量级​：简单工作流程

• 🔓 ​无需密钥​：无需API密钥

• 🤝 ​协作友好​：人机协作优化

• 📊 ​可预测性​：可预测输出

• 🔍 ​可审查​：完全可审查

​技术亮点​：

• ​规范驱动​：规范优先开发

• ​变更管理​：结构化变更管理

• ​工具集成​：广泛工具集成

• ​增量采用​：渐进式采用

• ​团队协作​：团队协作支持

---

主要功能

1. ​核心功能体系​

OpenSpec提供了一套完整的规范驱动开发解决方案，涵盖规范管理、变更跟踪、任务管理、AI集成、团队协作、质量保证、进度跟踪、文档生成、版本控制、审查流程、工具支持、配置管理、部署支持、扩展能力等多个方面。

​规范管理功能​：

规范创建:
- AI生成: AI自动生成规范
- 手动编辑: 手动编辑规范
- 模板支持: 规范模板支持
- 格式标准: 标准化格式
- 质量检查: 自动质量检查

规范组织:
- 分层结构: 分层规范组织
- 分类管理: 按功能分类
- 版本控制: 版本历史管理
- 依赖管理: 规范依赖关系
- 搜索检索: 快速搜索检索

规范特性:
- 可读性: 人类可读格式
- 机器可读: 机器可解析
- 一致性: 格式一致性
- 完整性: 内容完整性
- 可维护性: 易于维护更新

​变更管理功能​：

变更流程:
- 提案创建: 变更提案创建
- 审查批准: 审查批准流程
- 实施跟踪: 实施过程跟踪
- 归档管理: 完成变更归档
- 历史记录: 变更历史记录

变更类型:
- 功能新增: 新功能添加
- 功能修改: 现有功能修改
- 功能删除: 功能删除
- 缺陷修复: 缺陷修复变更
- 优化改进: 性能优化改进

变更特性:
- 可追溯性: 完全可追溯
- 透明度: 过程透明
- 审计性: 可审计记录
- 状态跟踪: 状态跟踪管理
- 影响分析: 影响分析支持

​任务管理功能​：

任务创建:
- 自动生成: AI自动生成任务
- 手动添加: 手动添加任务
- 模板使用: 任务模板使用
- 优先级设置: 优先级设置
- 依赖管理: 任务依赖关系

任务跟踪:
- 状态管理: 任务状态管理
- 进度跟踪: 进度跟踪更新
- 分配管理: 任务分配管理
- 时间估计: 时间估算管理
- 完成验证: 完成验证检查

任务特性:
- 可操作性: 明确可操作
- 可测量: 进度可测量
- 可验证: 结果可验证
- 可分配: 任务可分配
- 可优先级: 优先级管理

2. ​高级功能​

​AI集成功能​：

集成方式:
- 原生支持: 原生工具集成
- 斜杠命令: 斜杠命令支持
- 自然语言: 自然语言交互
- API集成: API接口集成
- 插件系统: 插件扩展集成

支持工具:
- Claude Code: Claude集成
- Cursor: Cursor编辑器
- OpenCode: OpenCode支持
- GitHub Copilot: Copilot集成
- 多种其他: 多种AI工具

集成特性:
- 无缝集成: 无缝工具集成
- 命令支持: 丰富命令支持
- 上下文感知: 上下文感知
- 智能响应: 智能响应处理
- 错误处理: 错误处理机制

​团队协作功能​：

协作方式:
- 规范共享: 共享规范库
- 变更评审: 变更评审协作
- 任务分配: 任务分配协作
- 进度同步: 进度同步更新
- 知识共享: 知识经验共享

协作工具:
- 版本控制: Git集成
- 评论系统: 评论反馈
- 通知系统: 变更通知
- 权限管理: 访问权限管理
- 审计日志: 操作审计日志

协作特性:
- 实时协作: 实时协作支持
- 异步协作: 异步协作能力
- 冲突解决: 冲突解决机制
- 历史追踪: 历史变更追踪
- 责任明确: 责任明确分配

​质量保证功能​：

质量检查:
- 规范验证: 规范格式验证
- 一致性检查: 一致性检查
- 完整性验证: 完整性验证
- 冲突检测: 冲突检测机制
- 标准符合: 标准符合性检查

质量工具:
- 静态分析: 静态分析工具
- 自动化测试: 自动化测试集成
- 代码审查: 代码审查支持
- 性能监控: 性能监控集成
- 安全扫描: 安全扫描集成

质量特性:
- 预防为主: 质量预防为主
- 持续改进: 持续改进机制
- 度量指标: 质量度量指标
- 报告生成: 质量报告生成
- 趋势分析: 质量趋势分析

---

安装与配置

1. ​环境准备​

​系统要求​：

最低要求:
- 操作系统: Windows/macOS/Linux
- Node.js: Node.js 20.19.0+
- 内存: 4GB RAM
- 存储: 2GB 可用空间
- 网络: 互联网连接(可选)

推荐要求:
- 操作系统: 现代操作系统
- Node.js: Node.js 20+
- 内存: 8GB+ RAM
- 存储: 10GB+ SSD
- 网络: 稳定网络连接

生产要求:
- 版本控制: Git版本控制
- 代码编辑器: 现代编辑器
- AI工具: 支持AI工具
- 开发环境: 完整开发环境
- 备份系统: 数据备份系统

开发要求:
- 开发工具: 代码编辑器
- 调试工具: 调试开发工具
- 测试环境: 测试环境准备
- 文档工具: 文档查看工具
- 版本控制: Git版本控制

​软件依赖​：

必需依赖:
- Node.js: Node.js运行时
- npm: npm包管理器
- Git: Git版本控制

可选依赖:
- AI工具: 各种AI编程助手
- 编辑器: 代码编辑器
- 构建工具: 项目构建工具
- 测试框架: 测试框架工具
- 文档工具: 文档生成工具

开发依赖:
- TypeScript: TypeScript支持
- 构建工具: 项目构建工具
- 测试工具: 测试工具集
- 代码检查: 代码检查工具
- 格式化工具: 代码格式化

2. ​安装步骤​

​全局安装​：

# 使用npm全局安装
npm install -g @fission-ai/openspec@latest

# 验证安装
openspec --version

# 或使用yarn
yarn global add @fission-ai/openspec@latest

# 或使用pnpm
pnpm add -g @fission-ai/openspec@latest

​项目初始化​：

# 进入项目目录
cd your-project

# 初始化OpenSpec
openspec init

# 初始化过程:
# 1. 选择支持的AI工具
# 2. 配置斜杠命令
# 3. 创建目录结构
# 4. 生成AGENTS.md文件

​开发安装​：

# 克隆项目
git clone https://github.com/Fission-AI/OpenSpec.git
cd OpenSpec

# 安装依赖
pnpm install

# 构建项目
pnpm run build

# 开发模式运行
pnpm run dev

# 或CLI开发
pnpm run dev:cli

​Docker安装​：

# 使用Docker(如果支持)
# 参考Docker文档

# 或使用容器化部署
# 根据具体需求配置

​更新安装​：

# 更新全局包
npm update -g @fission-ai/openspec

# 或重新安装
npm install -g @fission-ai/openspec@latest

# 项目内更新
openspec update

3. ​配置说明​

​基础配置​：

// OpenSpec基础配置
{
  "version": "1.0.0",
  "aiTools": ["claude", "cursor", "github-copilot"],
  "specFormat": "markdown",
  "validation": {
    "enabled": true,
    "strict": false,
    "autoFix": true
  },
  "workflow": {
    "autoArchive": false,
    "notifications": true,
    "backup": true
  }
}

​AI工具配置​：

// AI工具配置
{
  "claude": {
    "enabled": true,
    "slashCommands": true,
    "autoDetect": true
  },
  "cursor": {
    "enabled": true,
    "slashCommands": true,
    "integration": "native"
  },
  "githubCopilot": {
    "enabled": true,
    "slashCommands": true,
    "path": ".github/prompts/"
  },
  "otherTools": {
    "fallback": "AGENTS.md",
    "compatibility": true
  }
}

​目录结构配置​：

// 目录结构配置
{
  "paths": {
    "specs": "openspec/specs",
    "changes": "openspec/changes",
    "archive": "openspec/archive",
    "templates": "openspec/templates"
  },
  "filePatterns": {
    "proposal": "proposal.md",
    "tasks": "tasks.md",
    "design": "design.md",
    "specDelta": "specs/**/spec.md"
  },
  "autoCreate": {
    "directories": true,
    "files": true,
    "templates": true
  }
}

​验证规则配置​：

// 验证规则配置
{
  "validationRules": {
    "specFormat": {
      "requirementPattern": "### Requirement:",
      "scenarioPattern": "#### Scenario:",
      "shallMustRequired": true
    },
    "completeness": {
      "minScenarios": 1,
      "descriptionRequired": true,
      "acceptanceCriteria": true
    },
    "consistency": {
      "namingConventions": true,
      "formatConsistency": true,
      "terminology": true
    }
  }
}

---

使用指南

1. ​基本工作流​

使用OpenSpec的基本流程包括：环境准备 → 工具安装 → 项目初始化 → AI工具配置 → 变更提案 → 规范审查 → 任务实施 → 变更归档 → 规范更新 → 团队协作 → 质量保证 → 进度跟踪 → 维护更新 → 社区参与。整个过程设计为完整的规范驱动开发工作流。

2. ​基本使用​

​变更提案使用​：

提案步骤:
1. 需求提出: 提出变更需求
2. AI协助: AI创建提案
3. 提案生成: 自动生成提案文件
4. 初步审查: 初步提案审查
5. 迭代完善: 迭代完善提案

提案内容:
- 问题描述: 问题背景描述
- 解决方案: 解决方案概述
- 影响分析: 影响范围分析
- 优先级: 变更优先级
- 时间估计: 初步时间估计

提案管理:
- 状态跟踪: 提案状态跟踪
- 版本管理: 提案版本管理
- 评论反馈: 评论反馈收集
- 批准流程: 批准流程管理
- 历史记录: 提案历史记录

​规范审查使用​：

审查步骤:
1. 规范生成: AI生成初始规范
2. 人工审查: 人工审查规范
3. 修改完善: 修改完善规范
4. 达成一致: 达成一致意见
5. 最终确认: 最终规范确认

审查内容:
- 完整性: 规范完整性
- 准确性: 内容准确性
- 一致性: 前后一致性
- 可实施性: 可实施性
- 可测试性: 可测试性

审查工具:
- 差异对比: 差异对比工具
- 评论系统: 评论注释系统
- 批准工作流: 批准工作流
- 版本对比: 版本对比功能
- 审计跟踪: 审计跟踪记录

​任务实施使用​：

实施步骤:
1. 任务分解: 分解实施任务
2. 任务分配: 分配具体任务
3. 代码实现: 代码实现任务
4. 进度更新: 更新任务进度
5. 完成验证: 验证任务完成

任务管理:
- 任务列表: 任务清单管理
- 优先级: 任务优先级设置
- 依赖关系: 任务依赖关系
- 进度跟踪: 进度状态跟踪
- 完成验证: 完成验证检查

实施支持:
- AI辅助: AI辅助实施
- 代码生成: 代码生成支持
- 测试生成: 测试用例生成
- 文档生成: 文档自动生成
- 质量检查: 质量自动检查

3. ​高级用法​

​团队协作使用​：

协作流程:
1. 角色分配: 团队成员角色分配
2. 权限设置: 协作权限设置
3. 工作分配: 工作任务分配
4. 进度同步: 工作进度同步
5. 问题解决: 协作问题解决

协作工具:
- 版本控制: Git集成协作
- 实时通信: 实时通信工具
- 项目管理: 项目管理集成
- 文档协作: 文档协作工具
- 评审系统: 代码评审系统

协作最佳实践:
- 定期同步: 定期进度同步
- 明确责任: 责任明确分配
- 透明沟通: 沟通透明开放
- 冲突解决: 冲突解决机制
- 知识共享: 知识经验共享

​质量保证使用​：

质量流程:
1. 质量标准: 制定质量标准
2. 自动检查: 自动质量检查
3. 人工审查: 人工质量审查
4. 问题修复: 质量问题修复
5. 持续改进: 持续改进机制

质量工具:
- 静态分析: 代码静态分析
- 自动化测试: 自动化测试
- 性能测试: 性能测试工具
- 安全扫描: 安全扫描工具
- 代码覆盖: 代码覆盖率检查

质量指标:
- 缺陷密度: 缺陷密度指标
- 测试覆盖: 测试覆盖率
- 通过率: 测试通过率
- 性能指标: 性能指标数据
- 安全指标: 安全指标数据

​集成开发使用​：

集成方式:
1. 工具集成: 开发工具集成
2. 流程集成: 开发流程集成
3. 系统集成: 系统平台集成
4. API集成: API接口集成
5. 自定义集成: 自定义集成开发

集成点:
- IDE集成: 开发环境集成
- CI/CD集成: 流水线集成
- 项目管理: 项目管理工具
- 文档系统: 文档管理系统
- 监控系统: 监控系统集成

集成考虑:
- 兼容性: 系统兼容性
- 性能影响: 性能影响评估
- 安全性: 安全考虑
- 可维护性: 可维护性设计
- 可扩展性: 可扩展性设计

---

应用场景实例

案例1：新功能开发

​场景​：企业系统新功能开发

​解决方案​：使用OpenSpec规范驱动新功能开发。

​实施方法​：

1. ​需求分析​：分析功能需求

2. ​规范创建​：创建功能规范

3. ​变更提案​：提交变更提案

4. ​审查批准​：审查批准规范

5. ​开发实施​：按规范开发

​开发价值​：

• ​需求明确​：需求明确清晰

• ​减少返工​：减少开发返工

• ​质量提升​：开发质量提升

• ​进度可控​：进度可控可预测

• ​团队协作​：团队协作顺畅

案例2：遗留系统改造

​场景​：遗留系统现代化改造

​解决方案​：使用OpenSpec管理遗留系统改造。

​实施方法​：

1. ​现状分析​：分析现有系统

2. ​目标定义​：定义改造目标

3. ​增量改造​：增量式改造规划

4. ​规范驱动​：规范驱动改造

5. ​验证保证​：验证改造效果

​改造价值​：

• ​风险降低​：改造风险降低

• ​质量保证​：改造质量保证

• ​进度透明​：进度透明可控

• ​知识传承​：知识经验传承

• ​成本控制​：改造成本控制

案例3：团队协作开发

​场景​：分布式团队协作开发

​解决方案​：使用OpenSpec协调团队协作。

​实施方法​：

1. ​规范标准化​：统一规范标准

2. ​流程定义​：明确协作流程

3. ​工具集成​：集成协作工具

4. ​透明管理​：透明进度管理

5. ​持续改进​：持续流程改进

​协作价值​：

• ​一致性​：工作成果一致

• ​效率提升​：协作效率提升

• ​质量统一​：质量标准统一

• ​沟通改善​：团队沟通改善

• ​满意度提升​：团队满意度提升

案例4：合规性开发

​场景​：合规性要求严格的开发

​解决方案​：使用OpenSpec确保合规性。

​实施方法​：

1. ​合规分析​：分析合规要求

2. ​规范映射​：映射合规规范

3. ​验证集成​：集成合规验证

4. ​审计跟踪​：审计跟踪记录

5. ​报告生成合规报告生成

​合规价值​：

• ​合规保证​：确保合规性

• ​审计友好​：审计友好性

• ​风险降低​：合规风险降低

• ​透明度​：完全透明度

• ​可信度​：系统可信度提升

案例5：敏捷开发增强

​场景​：敏捷开发流程增强

​解决方案​：使用OpenSpec增强敏捷开发。

​实施方法​：

1. ​流程集成​：集成敏捷流程

2. ​规范同步​：规范故事同步

3. ​质量内建​：质量内建机制

4. ​持续反馈​：持续反馈循环

5. ​迭代改进​：迭代持续改进

​敏捷价值​：

• ​流程增强​：敏捷流程增强

• ​质量提升​：交付质量提升

• ​​ predictability​：可预测性提高

• ​客户满意​：客户满意度提高

• ​团队效能​：团队效能提升

---

总结

OpenSpec作为一个创新的规范驱动开发框架，通过其规范的先导方法、AI集成能力和团队协作支持，为现代软件开发提供了可预测、可审查的解决方案。

​核心优势​：

• 📋 ​规范驱动​：规范先导开发

• 🤖 ​AI集成​：无缝AI集成

• 👥 ​团队协作​：团队协作支持

• 🔍 ​可审查​：完全可审查

• 🚀 ​轻量级​：轻量级实施

​适用场景​：

• 新功能开发

• 遗留系统改造

• 团队协作开发

• 合规性开发

• 敏捷开发增强

​立即开始使用​：

# 安装OpenSpec
npm install -g @fission-ai/openspec@latest

# 初始化项目
openspec init

# 创建第一个变更
openspec create my-first-change

​资源链接​：

• 🌐 ​项目地址​：GitHub仓库

• 📖 ​文档​：使用文档

• 💬 ​社区​：Discord社区

• 🎓 ​教程​：使用教程

• 🔧 ​示例​：代码示例

​通过OpenSpec，您可以​：

• ​规范开发​：规范驱动开发

• ​AI协作​：高效AI协作

• ​质量提升​：开发质量提升

• ​团队协调​：团队更好协调

• ​风险降低​：项目风险降低

​特别提示​：

• 💻 ​技术基础​：需要技术基础

• 📚 ​学习曲线​：需要学习适应

• 👥 ​团队适应​：团队需要适应

• 🔧 ​工具集成​：需要工具集成

• 📊 ​流程调整​：需要流程调整

​通过OpenSpec，提升您的开发流程！​​

​未来发展​：

• 🚀 ​更多集成​：更多工具集成

• 🤖 ​更智能AI​：更智能AI支持

• 🌐 ​更广应用​：更广泛应用场景

• 🔧 ​更易使用​：更易使用体验

• 📊 ​更强分析​：更强分析能力

​加入社区​：

参与方式:
- GitHub: 提交问题和PR
- 文档: 贡献文档改进
- 工具: 贡献新工具集成
- 示例: 贡献使用示例
- 经验: 分享使用经验

社区价值:
- 共同改进项目
- 问题解答帮助
- 经验分享交流
- 功能需求反馈
- 项目发展推动

​通过OpenSpec，共同推动规范驱动开发！​​

​许可证​：

MIT许可证
个人使用免费
商业使用友好

​致谢​：

特别感谢:
- 开发团队: Fission AI团队
- 贡献者: 代码贡献者
- 用户: 用户反馈支持
- 社区: 社区支持者

​免责声明​：

重要提示:
需要技术知识
注意流程调整
团队需要适应
学习最佳实践
逐步实施采用

​通过OpenSpec，负责任地进行开发！​​

​成功案例​：

用户群体:
- 开发团队: 各种开发团队
- 企业用户: 各种企业
- 开源项目: 开源项目
- 研究机构: 学术研究
- 个人开发者: 独立开发者

使用效果:
- 质量提升: 代码质量提升
- 效率提高: 开发效率提高
- 协作改善: 团队协作改善
- 风险降低: 项目风险降低
- 满意度高: 用户满意度高

​最佳实践​：

使用建议:
1. 从小开始: 从小项目开始
2. 逐步推广: 逐步团队推广
3. 培训教育: 团队培训教育
4. 持续改进: 持续改进流程
5. 社区学习: 向社区学习经验

避免问题:
- 过度工程: 避免过度工程
- 强制使用: 避免强制使用
- 孤立使用: 避免孤立使用
- 忽视培训: 避免忽视培训
- 流程僵化: 避免流程僵化

​通过OpenSpec，实现高效的规范驱动开发！​​

​资源扩展​：

学习资源:
- 规范驱动开发学习
- AI辅助编程学习
- 团队协作学习
- 质量保证学习
- 开源社区参与

​通过OpenSpec，构建您的开发未来！​​

​未来展望​：

技术发展:
- 更好集成
- 更多功能
- 更强AI
- 更易使用
- 更智能

应用发展:
- 更多场景
- 更好体验
- 更广应用
- 更深影响
- 更大价值

社区发展:
- 更多用户
- 更多贡献
- 更好文档
- 更多案例
- 更大影响

​通过OpenSpec，迎接开发的未来！​​

​结束语​：

OpenSpec作为一个创新的规范驱动开发框架，正在改变人们进行软件开发的方式。通过合理利用这一框架，开发团队可以享受规范先导、AI协作和质量保证带来的好处。

记住，工具是扩展能力的手段，结合清晰的开发目标与合理的流程选择，共同成就开发卓越。

​Happy spec-driven development with OpenSpec!​​ 📋🚀💻