vibe-startup

启动文档整理工作流

1. 文档目的

规范启动文档的整理标准，确保项目启动文档包含完整的环境要求、依赖、启动命令、目录结构和账号密码信息。

2. 工作流结构

一个简洁高效的启动文档整理工作流应包含：

• 基本信息：名称、目标
• 前置步骤：产物检查、依赖项确认
• 执行步骤：详细的执行流程和顺序
• 执行建议：专业建议和注意事项
• 成功标准：任务完成的判定条件
• 失败处理：异常情况的应对措施
• 输出成果：明确的交付物和保存位置

3. 执行要求

• 严格按照步骤执行
• 自动从项目文件中提取信息
• 记录关键信息和结果
• 遇到异常时按失败处理机制执行
• 确保输出成果符合用户预期

4. 工作流程

前置步骤：产物检查

1. 检查项目根目录README.md：

   • 确认项目根目录是否存在README.md文件
   • 读取README.md文件，了解项目基本信息

2. 检查项目目录结构：

   • 查看项目的完整目录结构
   • 确认是否存在配置文件、依赖文件等

第一步：收集环境要求信息

1. 操作系统要求：

   • 检查项目配置文件（如package.json、requirements.txt等）中的操作系统要求
   • 检查项目文档中关于操作系统的说明
   • 记录操作系统版本要求

2. 硬件要求：

   • 检查项目文档中关于硬件配置的说明
   • 基于项目类型和依赖推断硬件要求
   • 记录硬件配置要求

3. 软件要求：

   • 检查项目配置文件（如package.json、requirements.txt等）中的软件依赖
   • 检查项目文档中关于软件环境的说明
   • 记录软件版本要求

第二步：收集依赖信息

1. 开发依赖：

   • 检查项目的依赖文件（如package.json、requirements.txt等）
   • 自动提取开发依赖包及其版本
   • 记录开发依赖包及其版本

2. 生产依赖：

   • 检查项目的依赖文件（如package.json、requirements.txt等）
   • 自动提取生产依赖包及其版本
   • 记录生产环境需要的依赖包及其版本

3. 依赖安装命令：

   • 根据项目类型自动推断依赖安装命令（如npm install、pip install等）
   • 检查项目文档中关于依赖安装的说明
   • 记录依赖安装命令

第三步：收集启动命令信息

1. 开发环境启动命令：

   • 检查项目配置文件（如package.json中的scripts部分）
   • 自动提取开发环境启动命令
   • 记录开发环境启动命令

2. 生产环境启动命令：

   • 检查项目配置文件（如package.json中的scripts部分）
   • 自动提取生产环境启动命令
   • 记录生产环境启动命令

3. 其他命令：

   • 检查项目配置文件（如package.json中的scripts部分）
   • 自动提取其他常用命令（如构建、测试等）
   • 记录其他常用命令

第四步：整理目录结构

1. 项目根目录结构：

   • 生成项目根目录的完整目录结构
   • 记录主要目录和文件的用途

2. 关键文件说明：

   • 检查项目中的关键文件（如配置文件、源码文件等）
   • 自动分析关键文件的作用
   • 记录关键文件的说明

第五步：收集账号密码信息

1. 开发环境账号密码：

   • 检查项目配置文件（如.env文件、配置文件等）
   • 自动提取开发环境账号密码相关配置
   • 记录开发环境账号密码

2. 生产环境账号密码：

   • 检查项目配置文件（如.env.production文件、配置文件等）
   • 自动提取生产环境账号密码相关配置
   • 记录生产环境账号密码

3. 安全注意事项：

   • 基于项目配置和最佳实践，自动生成安全管理建议
   • 记录安全管理建议

第六步：生成启动文档

1. 文档结构设计：

   • 设计启动文档的结构，包含环境要求、依赖、启动命令、目录结构、账号密码等章节

2. 文档内容编写：

   • 根据收集的信息，编写启动文档内容
   • 确保文档内容完整、清晰、准确

3. 文档保存：

   • 将启动文档保存至/项目文档/启动文档/README.md