Skip to content

[[[[Switch to English]]]]

快速入门指南

本指南将帮助您使用 Spec Kit 开始规格驱动开发。

NOTE

所有自动化脚本现在都提供 Bash (.sh) 和 PowerShell (.ps1) 变体。specify CLI 会根据操作系统自动选择,除非您传递 --script sh|ps

6 步流程

TIP

上下文感知:Spec Kit 命令会根据您当前的 Git 分支(例如 001-feature-name)自动检测活动功能。要在不同规格之间切换,只需切换 Git 分支。

第 1 步:安装 Specify

在您的终端中,运行 specify CLI 命令来初始化您的项目:

bash
# 创建新项目目录
uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME>

# 或者在当前目录初始化
uvx --from git+https://github.com/github/spec-kit.git specify init .

显式选择脚本类型(可选):

bash
uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME> --script ps  # 强制 PowerShell
uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME> --script sh  # 强制 POSIX shell

第 2 步:定义您的章程

在您的 AI 智能体聊天界面中,使用 /speckit.constitution 斜杠命令来建立项目的核心规则和原则。您应该提供项目特定的原则作为参数。

markdown
/speckit.constitution 本项目遵循“库优先”方法。所有功能必须首先作为独立库实施。我们严格使用 TDD。我们偏好函数式编程模式。

第 3 步:创建规格

在聊天中,使用 /speckit.specify 斜杠命令描述您想构建什么。关注 什么为什么,而不是技术栈。

markdown
/speckit.specify 构建一个应用程序,帮助我在单独的相册中组织照片。相册按日期分组,可以通过在主页上拖放来重新组织。相册永远不会嵌套在其他相册中。在每个相册中,照片以平铺界面预览。

第 4 步:完善规格

在聊天中,使用 /speckit.clarify 斜杠命令来识别和解决规格中的歧义。您可以提供特定的关注领域作为参数。

bash
/speckit.clarify 关注安全性和性能需求。

第 5 步:创建技术实施计划

在聊天中,使用 /speckit.plan 斜杠命令来提供您的技术栈和架构选择。

markdown
/speckit.plan 该应用程序使用 .NET Aspire 生成,使用 Postgres 作为数据库。前端应使用 Blazor server,具有拖放任务板和实时更新功能。应创建一个包含项目 API、任务 API 和通知 API 的 REST API。

第 6 步:分解决和实施

在聊天中,使用 /speckit.tasks 斜杠命令来创建可操作的任务列表。

markdown
/speckit.tasks

可选地,使用 /speckit.analyze 验证计划:

markdown
/speckit.analyze

然后,使用 /speckit.implement 斜杠命令来执行计划。

markdown
/speckit.implement

详细示例:构建 Taskify

这是一个构建团队生产力平台的完整示例:

第 1 步:定义章程

初始化项目的章程以设定基本规则:

markdown
/speckit.constitution Taskify 是一个“安全优先”的应用程序。所有用户输入必须经过验证。我们使用微服务架构。代码必须有完整的文档。

第 2 步:使用 /speckit.specify 定义需求

text
开发 Taskify,一个团队生产力平台。它应允许用户创建项目、添加团队成员、分配任务、评论以及是以看板风格在板块间移动任务。
在这个功能的初始阶段,我们称之为“创建 Taskify”,让我们有多个用户,但用户将预先声明,即预定义的。
我想要两类共五个用户,一个产品经理和四个工程师。让我们创建三个不同的示例项目。
让我们有标准的看板列来显示每个任务的状态,例如“待办”、“进行中”、“审查中”和“已完成”。
此应用程序不需要登录,因为这只是最初的测试,以确保我们的基本功能已设置好。

第 3 步:完善规格

使用 /speckit.clarify 命令交互式地解决规格中的任何歧义。您还可以提供您希望确保包含的具体细节。

bash
/speckit.clarify 我想澄清任务卡片的细节。对于任务卡片 UI 中的每个任务,你应该能够更改任务在看板工作板中不同列之间的当前状态。你应该能够为特定卡片留下无限数量的评论。你应该能够从那个任务卡片分配一个有效用户。

您可以使用 /speckit.clarify 继续通过更多细节完善规格:

bash
/speckit.clarify 当你第一次启动 Taskify 时,它会给你一个包含五个用户的列表供选择。不需要密码。当你点击一个用户时,你进入主视图,显示项目列表。当你点击一个项目时,你打开该项目的看板。你会看到列。你将能够拖放卡片在不同列之间来回移动。你会看到任何分配给你(当前登录用户)的卡片与所有其他卡片颜色不同,以便你可以快速看到你的卡片。你可以编辑你发表的任何评论,但不能编辑其他人发表的评论。你可以删除你发表的任何评论,但不能删除其他人发表的评论。

第 4 步:验证规格

使用 /speckit.checklist 命令验证规格清单:

bash
/speckit.checklist

第 5 步:使用 /speckit.plan 生成技术计划

明确您的技术栈和技术需求:

bash
/speckit.plan 我们将使用 .NET Aspire 生成这个,使用 Postgres 作为数据库。前端应使用 Blazor server,具有拖放任务板和实时更新功能。应创建一个包含项目 API、任务 API 和通知 API REST API。

第 6 步:验证和实施

使用 /speckit.analyze 让您的 AI 智能体审计实施计划:

bash
/speckit.analyze

最后,实施解决方案:

bash
/speckit.implement

关键原则

  • 明确 您要构建什么以及为什么
  • 不要关注技术栈 在规格阶段
  • 迭代和完善 您的规格,然后再实施
  • 验证 计划,然后再开始编码
  • 让 AI 智能体处理 实施细节

下一步