<< All versions

Skill v1.0.0

currentAutomated scan100/100
xushuodasd/vibe-claude-plugin/vibe-architecture
──Details
PublishedOctober 3, 2026 at 05:34 PM
Content Hashsha256:5c9adde6a7ed78df...
Git SHA
──Files
Files (1 file, 6.0 KB)
SKILL.md6.0 KBactive
SKILL.md · 159 lines · 6.0 KB

version: "1.0.0" name: vibe-architecture description: Use this skill to design the technical architecture, including tech stack, modules, data flow, and deployment.


架构设计文档工作流

1. 文档目的

规范架构设计文档的编写标准,确保AI能按照项目实际情况,生成包含技术栈、模块划分、数据流、部署架构的完整架构设计文档。

2. 工作流结构

一个简洁高效的架构设计文档工作流应包含:

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

3. 执行要求

  • 严格按照步骤执行
  • 与用户保持深度沟通
  • 记录关键信息和结果
  • 遇到异常时按失败处理机制执行
  • 确保输出成果符合用户预期

4. 工作流程

前置步骤:产物检查

  1. 检查项目根目录README.md:
  • 确认项目根目录是否存在README.md文件
  • 读取README.md文件,了解项目基本信息和主要功能
  1. 检查项目目录结构:
  • 查看项目的完整目录结构
  • 确认是否存在配置文件、依赖文件等
  1. 检查项目文档:
  • 查看doc/目录下的工作流程文档
  • 了解项目的开发规范和工作流程

第一步:了解项目需求

  1. 分析项目README:
  • 理解项目的定位、目标和主要功能
  • 识别项目的核心业务逻辑
  1. 分析项目目录结构:
  • 分析.vibe/目录下的开发规则
  • 分析doc/目录下的工作流程文档
  • 理解项目的组织方式和设计思路
  1. 识别项目技术栈:
  • 检查项目中是否存在package.json、requirements.txt等依赖文件
  • 分析项目中使用的编程语言、框架和库

第二步:设计技术栈方案

  1. 前端技术栈:
  • 分析项目中是否存在前端代码
  • 确定前端使用的框架、库和工具
  • 记录前端技术栈的版本和配置
  1. 后端技术栈:
  • 分析项目中是否存在后端代码
  • 确定后端使用的语言、框架和数据库
  • 记录后端技术栈的版本和配置
  1. AI相关技术:
  • 分析项目中是否使用了AI相关技术
  • 确定AI模型、算法和工具
  • 记录AI技术的版本和配置

第三步:设计模块划分

  1. 前端模块:
  • 基于项目功能,划分前端模块
  • 确定每个模块的职责和功能
  • 设计模块间的交互方式
  1. 后端模块:
  • 基于项目功能,划分后端模块
  • 确定每个模块的职责和功能
  • 设计模块间的交互方式
  1. AI模块:
  • 基于项目功能,划分AI模块
  • 确定每个模块的职责和功能
  • 设计模块间的交互方式

第四步:设计数据流

  1. 前端数据流:
  • 设计前端页面间的数据传递
  • 设计前端与后端的数据交互
  • 设计前端状态管理方案
  1. 后端数据流:
  • 设计后端模块间的数据传递
  • 设计后端与数据库的数据交互
  • 设计后端与AI模块的数据交互
  1. AI数据流:
  • 设计AI模型的输入输出数据结构
  • 设计AI模型的训练和推理流程
  • 设计AI结果的处理和存储方案

第五步:设计部署架构

  1. 开发环境部署:
  • 设计开发环境的配置和依赖
  • 设计开发环境的启动和调试方案
  1. 测试环境部署:
  • 设计测试环境的配置和依赖
  • 设计测试环境的部署和测试方案
  1. 生产环境部署:
  • 设计生产环境的配置和依赖
  • 设计生产环境的部署和监控方案
  • 设计生产环境的扩展性和容错方案

第六步:编写架构设计文档

  1. 文档结构设计:
  • 设计架构设计文档的结构,包含技术栈、模块划分、数据流、部署架构等章节
  1. 文档内容编写:
  • 根据收集的信息,编写架构设计文档内容
  • 确保文档内容完整、清晰、准确
  • 使用图表和示例辅助说明
  1. 文档保存:
  • 将架构设计文档保存至/项目文档/启动文档/架构设计文档.md
  • 与用户确认文档内容,确保符合其要求

5. 执行建议

  1. 深入了解:仔细分析项目的目录结构、文档和代码,确保对项目有全面的理解
  2. 系统性思考:从整体架构出发,系统性地设计技术栈、模块划分、数据流和部署架构
  3. 模块化设计:采用模块化设计思想,确保各个模块职责清晰、接口明确
  4. 数据流清晰:设计清晰的数据流,确保数据在各个模块间的传递顺畅
  5. 部署合理:根据项目特点,设计合理的部署架构,确保系统的稳定性和可扩展性
  6. 文档详细:编写详细的架构设计文档,使用图表和示例辅助说明,确保文档易于理解
  7. 与用户沟通:与用户保持深度沟通,确保架构设计符合用户的需求和期望

6. 成功标准

  1. 架构设计文档包含完整的技术栈、模块划分、数据流、部署架构信息
  2. 架构设计文档结构清晰,内容准确,易于理解
  3. 架构设计文档已保存至/项目文档/启动文档/架构设计文档.md
  4. 用户确认文档内容符合要求

7. 失败处理

  1. 信息不完整:如果收集的信息不完整,应及时与用户沟通,补充缺失的信息
  2. 设计不合理:如果架构设计不合理,应重新分析项目需求,调整设计方案
  3. 文档格式错误:如果文档格式错误,应重新编写文档,确保格式正确
  4. 保存失败:如果文档保存失败,应检查目录权限,确保有写入权限

8. 输出成果

  1. 完整的架构设计文档(包含技术栈、模块划分、数据流、部署架构等信息) - 保存至/项目文档/启动文档/架构设计文档.md
All versions