openclaw/project-guide

项目开发指导助手

概述

这个 Skill 用于引导和帮助用户完成项目开发指导模板的填写。当用户想要开发新项目或对现有项目进行重大修改时，使用此 Skill 来收集必要的信息。

触发条件

在以下情况下应该激活此 Skill：

1. 用户表达想要开发一个新项目
2. 用户提到"帮我整理一下项目需求"
3. 用户想要使用 AI 开发应用但不知道如何描述需求
4. 用户说"我要做一个 XX 系统"
5. 用户询问如何开始一个项目开发

工作流程

阶段一：项目概览采集

目标： 收集项目的基本信息

需要询问用户以下问题：

1. 项目名称

   • "你希望给项目起什么名字？"
   • 或者 "这个项目叫什么？"

2. 项目类型

   • "这是一个什么类型的项目？Web应用、移动端、API服务还是桌面工具？"

3. 项目简介

   • "能用一两句话描述一下这个项目吗？它是做什么的？"
   • "这个项目要解决什么问题？"

4. 核心目标

   • "你做这个项目最主要想要达成什么目标？"
   • "除了主要目标，还有其他期望吗？"

阶段二：详细需求采集

目标： 收集详细的功能和业务需求

需要引导用户填写 requirements.md，询问：

1. 用户群体

   • "谁会使用这个产品？"
   • "他们有什么特点和需求？"

2. 核心功能

   • "这个产品最核心的功能是什么？"
   • "用户最常用的功能有哪些？"
   • "有没有必须有的功能（P0），重要但不是必须的功能（P1），以及可选功能（P2）？"

3. 业务流程

   • "能描述一下典型的使用流程吗？"
   • "比如用户进来后第一步做什么，然后呢？"

4. 数据需求

   • "需要存储什么类型的数据？"
   • "有没有用户账号体系？需要哪些信息？"

5. 非功能需求

   • "对性能有要求吗？比如响应时间、并发数？"
   • "有安全或合规方面的要求吗？"
   • "需要支持哪些平台或浏览器？"

阶段三：技术约束采集

目标： 了解技术方面的限制和要求

1. 技术偏好

   • "有没有偏好的技术栈？比如必须用某种语言或框架？"
   • "团队对哪些技术比较熟悉？"

2. 已有资源

   • "有没有已经可以复用的组件或服务？"
   • "需要集成哪些第三方服务？"

3. 约束条件

   • "预算或时间有限制吗？"
   • "有没有必须兼容的现有系统？"

阶段四：生成文档

目标： 将收集到的信息整理成完整的模板文档

1. 根据收集的信息，生成/更新 main.md
2. 根据收集的信息，生成/更新 requirements.md
3. 如果用户已确定技术选型，生成 architecture.md
4. 如果涉及接口，生成 api.md

输出格式

完成信息收集后，应该：

1. 总结确认

   • 向用户确认理解是否正确
   • 询问是否有遗漏或需要补充的地方

2. 提供下一步建议

   • "根据你提供的信息，我已经整理出项目模板。"
   • "接下来你可以："
     • "1. 查看并完善 templates 目录下的模板文件"
     • "2. 确认无误后告诉 AI '请从 main.md 开始阅读'"
     • "3. AI 将根据这些信息开始项目开发"

模板文件位置

项目模板位于 templates/ 目录下：

• templates/main.md - 项目概览和索引
• templates/requirements.md - 详细需求文档
• templates/architecture.md - 技术架构设计
• templates/api.md - API 接口设计
• templates/update.md - 需求变更记录

注意事项

1. 循序渐进：不要一次性问所有问题，而是根据用户的回答逐步深入
2. 解释原因：适时解释为什么需要这些信息，帮助用户理解
3. 提供示例：如果用户不知道如何描述，可以提供示例
4. 记录不确定：对于用户不确定的地方，先记录下来，后续再确认
5. 保持简洁：问题要简洁明了，避免过度技术化的术语