指导初始化 OpenSpec 环境并填充 project.md 的标准流程,适用于任何使用 OpenSpec 规范驱动开发的项目
OpenSpec 环境配置助手 - 帮助团队初始化 OpenSpec 规范驱动开发环境,并填充项目上下文信息到 openspec/project.md。
openspec --version
npm install -g @fission-ai/openspec@latest
ls openspec/
如果 openspec/ 目录不存在:
检测到项目未初始化 OpenSpec。
请运行以下命令初始化:
```bash
cd <项目根目录>
openspec init
初始化后会创建:
read_file openspec/project.md
检查各章节是否为空或模板状态。
2.1 项目目的
询问:
建议格式:
## 目的
[项目简介 - 1-2 句话]
**核心目标**:
- [目标 1]
- [目标 2]
2.2 技术栈
自动检测(如果存在):
package.json → Node.js/前端项目requirements.txt / pyproject.toml → Python 项目pom.xml / build.gradle → Java 项目go.mod → Go 项目询问确认并补充:
2.3 项目约定
逐项询问:
代码风格:
架构模式:
测试策略:
Git 工作流:
2.4 领域上下文
询问:
2.5 重要约束
询问:
2.6 外部依赖
询问:
检查每个章节是否已填充实质内容(非模板占位符)。
✅ project.md 已填充完成!
建议下一步:
1. 如有现有功能,在 openspec/specs/ 创建规范
2. 有新需求时,使用 openspec 创建变更提案
3. 让 AI 助手阅读 openspec/project.md 理解项目上下文
参考文档:
- OpenSpec 文档: https://github.com/Fission-AI/OpenSpec
- 工作流程: openspec/AGENTS.md
技术栈示例 (Web 应用):
## 技术栈
- **前端**: React 18.x + TypeScript 5.x
- **构建工具**: Vite 5.x
- **状态管理**: Zustand
- **UI 框架**: Tailwind CSS 3.x
- **后端**: Node.js 20.x + Express
- **数据库**: PostgreSQL 15.x
- **部署**: Docker + Kubernetes
代码风格示例:
### 代码风格
- **格式化**: Prettier (自动格式化)
- **Linting**: ESLint + 项目自定义规则
- **命名规范**:
- 组件: PascalCase (UserProfile)
- 函数/变量: camelCase (getUserData)
- 常量: UPPER_SNAKE_CASE (API_URL)
- 文件: kebab-case (user-profile.tsx)
Web 应用:
CLI 工具:
库/SDK:
openspec/specs/ 中维护仅在以下情况执行:
openspec/project.md 内容为模板占位符记住: 简洁但完整 - 给 AI 助手足够的上下文,但不要写成详尽文档。