138 lines
4.3 KiB
Markdown
138 lines
4.3 KiB
Markdown
# AI项目规划文档生成
|
||
|
||
`项目规划` `文档生成` `Claude技能` `软件架构` `AI辅助开发`
|
||
|
||
# 注意：建议查看此仓库以获取增强版规格文档技能 -> https://github.com/adrianpuiu/specification-document-generator
|
||
|
||
# 项目规划技能 - 即将删除，此版本已过时，将被以下项目替代 -> https://github.com/adrianpuiu/specification-document-generator
|
||
|
||
一个综合性技能，将 Claude 定义为**项目架构师**角色，用于生成详细的规划文档，作为 AI 辅助软件开发的蓝图。
|
||
|
||
## 技能功能
|
||
|
||
本技能将 Claude 转变为系统架构师，通过以下方式创建完整的项目文档：
|
||
|
||
1. **预先定义完整的系统架构** - 所有组件、数据流和集成点
|
||
2. **设定明确的项目边界** - 范围内、范围外的内容及关键约束
|
||
3. **创建可追溯的文档** - 需求 → 设计 → 实现任务
|
||
|
||
本技能生成三份核心文档：
|
||
|
||
1. **需求文档** - 带有可测试验收标准和可追溯 ID 的用户故事
|
||
2. **设计文档** - 完整的系统架构，包含组件图、数据流和集成规范
|
||
3. **实现计划** - 带需求追溯和明确交付物的层级任务分解
|
||
|
||
## 架构师方法论
|
||
|
||
**有效原因：** 预先设定清晰的角色、职责和交付物，能显著提升输出质量。通过在深入细节之前明确定义系统组件、数据流和集成点，文档将变得全面且可执行。
|
||
|
||
## 快速开始
|
||
|
||
### Claude 安装
|
||
|
||
```bash
|
||
/plugin marketplace add adrianpuiu/claude-skills-marketplace
|
||
|
||
/plugin install project-planner-skill@claude-skills-marketplace
|
||
```
|
||
|
||
## 文档类型
|
||
|
||
### 需求文档
|
||
- 标准格式的用户故事
|
||
- 使用 SHALL 语句的可测试验收标准
|
||
- 用于追溯的需求编号
|
||
- 领域术语词汇表
|
||
|
||
### 设计文档
|
||
- 系统架构图
|
||
- 组件职责与接口
|
||
- 数据模型与模式
|
||
- 错误处理策略
|
||
- 部署配置
|
||
|
||
### 实现计划
|
||
- 层级任务分解
|
||
- 需求追溯（将任务链接到需求）
|
||
- 任务间依赖管理
|
||
- 带复选框的进度跟踪
|
||
|
||
## 支持的项目类型
|
||
|
||
- **web-app**：全栈 Web 应用
|
||
- **cli-tool**：命令行工具和实用程序
|
||
- **api-service**：REST/GraphQL API 服务
|
||
- **generic**：通用项目
|
||
|
||
## 包含文件
|
||
|
||
### 脚本
|
||
- `generate_project_docs.py` - 自动化文档生成
|
||
- `validate_documents.py` - 文档验证与完整性检查
|
||
|
||
### 参考资料
|
||
- `domain-templates.md` - 领域特定模板和模式
|
||
|
||
### 资源
|
||
- `requirements-template.md` - 基础需求文档模板
|
||
|
||
## 最佳实践
|
||
|
||
1. **从需求开始** - 先定义系统应做什么，再考虑如何实现
|
||
2. **保持具体** - 使用可衡量的标准（如"100ms 以内"而非"快速"）
|
||
3. **追溯需求** - 将每个任务链接回需求
|
||
4. **包含非功能性需求** - 性能、安全性、可扩展性
|
||
5. **定义清晰的接口** - 明确组件如何交互
|
||
6. **增量规划** - 将大任务拆分为更小的可管理单元
|
||
|
||
## 常见使用场景
|
||
|
||
### 启动新项目
|
||
```
|
||
用户："我想构建一个实时聊天应用"
|
||
AI：[使用本技能生成完整的项目文档]
|
||
```
|
||
|
||
### 扩展现有项目
|
||
```
|
||
用户："为我的项目需求添加用户认证"
|
||
AI：[添加带有验收标准的规范格式需求]
|
||
```
|
||
|
||
### 创建技术规范
|
||
```
|
||
用户："为微服务电商平台设计架构"
|
||
AI：[生成包含组件、接口和部署的设计文档]
|
||
```
|
||
|
||
## AI 实现建议
|
||
|
||
在使用这些文档进行 AI 辅助开发时：
|
||
|
||
1. **需求优先** - 按需求优先级顺序实现
|
||
2. **遵循任务依赖** - 先完成前置任务
|
||
3. **对照验收标准测试** - 每条 SHALL 语句都是一个测试用例
|
||
4. **参考设计接口** - 使用规定的 API 和数据模型
|
||
5. **跟踪进度** - 在实现计划中勾选已完成的任务
|
||
|
||
## 验证清单
|
||
|
||
在使用文档进行实现之前：
|
||
|
||
- [ ] 所有占位符（[PLACEHOLDER]）已填写
|
||
- [ ] 需求具有可测试的验收标准
|
||
- [ ] 设计包含所有主要组件
|
||
- [ ] 任务引用了需求 ID
|
||
- [ ] 任务间依赖关系已识别
|
||
- [ ] 非功能性需求已明确
|
||
- [ ] 包含部署配置
|
||
|
||
## 输出示例
|
||
|
||
生成的文档遵循行业标准格式，具备以下特点：
|
||
- **机器可读** - 结构化以便 AI 解析
|
||
- **人类可读** - 开发者易于理解
|
||
- **版本控制友好** - 纯文本 Markdown 格式
|
||
- **可追溯** - 需求在所有文档中相互链接
|
||
|
||
本技能将高层次的项目构想转化为可执行的规范，供 AI 智能体用于构建可运行的软件。 |