【Spec Kit!】 本指南将帮助你在几分钟内快速上手规范驱动开发(Spec-Driven Development)

快速入门:5 步流程
第 1 步:初始化项目

specify init my-project

指定 AI 助手

specify init my-project --ai claude

在当前目录初始化

specify init . --ai copilot

specify init 命令会创建完整的目录结构,包含为你所选 AI 助手量身定制的模板、脚本和文档。支持的 AI 助手包括:Claude Code、GitHub Copilot、Cursor、Windsurf、Gemini CLI 等 src/specify_cli/init.py。

第 2 步:确立项目原则
创建指导所有开发工作的项目治理章程:

/speckit.constitution Create principles focused on code quality, testing standards, user experience consistency, and performance requirements
这将在 .specify/memory/constitution.md 中创建包含项目开发原则和质量标准的章程文件。

第 3 步:编写功能规范
使用 /speckit.specify 命令描述你想要构建的内容:


/speckit.specify Build an application that can help me organize my photos in separate photo albums. Albums are grouped by date and can be re-organized by dragging and dropping on the main page. Albums are never in other nested albums. Within each album, photos are previewed in a tile-like interface.

这将生成全面的规范文档 templates/spec-template.md,包含:

带优先级的用户故事(P1、P2、P3…)
功能性需求
成功标准
边界案例和验收场景
第 4 步:制定技术实施方案
使用 /speckit.plan 定义如何构建:


/speckit.plan The application uses Vite with minimal number of libraries. Use vanilla HTML, CSS, and JavaScript as much as possible. Images are not uploaded anywhere and metadata is stored in a local SQLite database.

这将创建 templates/plan-template.md,包含:

技术栈和依赖项
项目结构
性能目标和约束
章程合规性检查
第 5 步:生成任务并实施
最后,分解工作并让 AI Agent 执行:

/speckit.tasks
/speckit.implement
/speckit.tasks

命令会生成可执行的任务列表 templates/tasks-template.md,按用户故事组织,支持每个功能的独立实施和测试。

项目结构概览
初始化项目时,Spec Kit 会创建以下结构:

my-project/
├── .specify/
│   ├── memory/
│   │   └── constitution.md          # 项目原则
│   ├── templates/
│   │   └── commands/               # AI 命令模板
│   └── scripts/                    # 自动化脚本
├── specs/                          # 功能规范
└── [你的源代码]

.specify/ 目录包含了驱动规范驱动开发工作流的所有模板和自动化脚本。

支持的 AI Agent
Spec Kit 兼容所有主流 AI 开发环境:


Agent	状态	集成方式
Claude Code	✅ 完全支持	原生斜杠命令
GitHub Copilot	✅ 完全支持	VS Code 集成
Cursor	✅ 完全支持	IDE 集成
Windsurf	✅ 完全支持	CLI 集成
Gemini CLI	✅ 完全支持	命令行界面
更多...	✅ 完全支持	多种集成方式

成功关键原则
明确表达:清晰描述想要构建的内容及其原因
关注点分离:保持规范独立于实现细节
迭代优化:在实施前验证规范的正确性
信任流程:让结构化工作流程指导高质量产出
后续步骤
熟悉快速入门流程后,请探索以下资源:

安装指南 - 不同环境的详细设置说明
项目初始化 - 深入了解项目结构和配置
规范编写 - 掌握高效编写规范的技巧
CLI 命令参考 - 完整的命令文档
故障排除
遇到问题时:

安装问题:确保已安装 uv 且 Python 版本为 3.11+
Git 问题:检查项目目录是否已初始化 Git
Agent 未检测到:验证 AI Agent 是否正确安装和配置
如需更多帮助,请查看 问题与反馈 页面或查阅 完整方法论指南。
https://zread.ai/github/spec-kit/3-installation-guide

(speckit) PS C:\spec\xhs_pub> C:\Users\gqzheng\.local\bin\specify.exe --help
### 规格驱动开发Spec - Driven Development)介绍 规格驱动开发Specification Driven Development,简称SpecDD)是一种全新的软件开发概念性框架,它贯穿于应用生命周期管理(Application Lifecycle Management,简称ALM)的各个阶段,支持各种成熟开发模型,旨在帮助开发团队提高项目质量,促进软件项目成功[^1]。 ### 原理 - **以知识为核心**:强调将软件开发过程中的各种知识,如需求规格、设计规格等进行明确的定义和管理。这些知识成为开发过程中的关键驱动因素,确保团队成员对项目目标和要求有清晰的理解。 - **全程贯穿**:在应用生命周期管理的各个阶段都发挥作用,从需求分析开始,到设计、开发、测试、部署等,每一个环节都紧密围绕规格进行。这样可以保证整个开发过程的一致性和连贯性。 - **支持多种开发模型**:能够与不同的成熟开发模型相结合,如敏捷开发、瀑布模型等。无论采用哪种开发模式,规格驱动开发都可以提供一个统一的框架,使得开发过程更加规范和可控。 ### 实践 - **需求规格定义**:在项目开始阶段,详细准确地定义需求规格。这包括功能需求、非功能需求等,使用清晰、无歧义的语言描述软件应该具备的特性和性能。 - **规格评审**:对定义好的规格进行严格的评审,确保其完整性、正确性和可行性。评审过程中,开发团队、测试团队、业务人员等相关方都应参与,提出意见和建议,对规格进行不断完善。 - **开发过程遵循规格**:开发人员在编写代码时,严格按照规格要求进行实现。规格成为代码编写的依据,保证代码的实现符合预期的功能和性能。 - **测试验证规格**:测试团队根据规格编写测试用例,对软件进行测试。通过测试来验证软件是否满足规格要求,发现并解决与规格不符的问题。 - **持续更新规格**:随着项目的推进,需求可能会发生变化。此时需要及时更新规格,并确保整个开发团队都了解这些变化,保证开发过程始终与最新的规格保持一致。 ```python # 示例:一个简单的规格驱动开发流程模拟 # 定义需求规格 requirements_spec = { "functionality": "实现一个简单的加法函数,输入两个整数,返回它们的和", "performance": "函数执行时间在1毫秒以内" } # 开发实现 def add_numbers(a, b): return a + b # 测试验证 import time start_time = time.time() result = add_numbers(3, 5) end_time = time.time() execution_time = end_time - start_time if result == 8 and execution_time < 0.001: print("测试通过,符合规格要求") else: print("测试不通过,需要检查代码是否符合规格") ```
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

大江东去浪淘尽千古风流人物

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值