快速入门: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
2610

被折叠的 条评论
为什么被折叠?



