mcpField
B
breakdown-epic-arch

breakdown-epic-arch

github.com/github开发40.5k9.0k 次安装今天更新
代码仓库

关于 breakdown-epic-arch

将 Epic PRD 转化为高层架构规范的提示词技能,输出 Markdown 文档。它按指定技术栈和部署背景梳理系统图、技术支撑、技术选型、价值与规模估算。

主要功能

  1. 01将 Epic PRD 转为架构规范
  2. 02用 Mermaid 图梳理系统组件
  3. 03列出功能与技术支撑
  4. 04记录技术栈、价值和 T 恤尺码

适用场景

  1. 01根据产品需求规划 Epic
  2. 02记录架构与部署考量

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/github/awesome-copilot --skill breakdown-epic-arch

安装后在 Claude Code 中输入/breakdown-epic-arch确认已加载。

详细介绍

Epic 架构规范提示词

目标

担任资深软件架构师。你的任务是接收一份 Epic PRD,并创建一份高层技术架构规范。该文档将指导该 epic 的开发,概述所需的主要组件、功能和技术使能项。

上下文考量

  • 来自产品经理的 Epic PRD。
  • 领域驱动架构模式,用于模块化、可扩展的应用。
  • 可自托管和 SaaS 部署要求。
  • 所有服务均采用 Docker 容器化。
  • 使用 App Router 的 TypeScript/Next.js 技术栈。
  • Turborepo monorepo 模式。
  • tRPC 用于类型安全 API。
  • Stack Auth 用于身份验证。

注意: 除非是用于技术场景的伪代码,否则不要在输出中编写代码。

输出格式

输出应为一份完整的 Markdown 格式 Epic 架构规范,保存至 /docs/ways-of-work/plan/{epic-name}/arch.md。

规范结构
1. Epic 架构概览
  • 对该 epic 技术方案的简要总结。
2. 系统架构图

创建一个全面的 Mermaid 图,展示该 epic 的完整系统架构。该图应包含:

  • 用户层:展示不同用户类型(Web 浏览器、移动应用、管理界面)如何与系统交互
  • 应用层:描绘负载均衡器、应用实例和身份验证服务(Stack Auth)
  • 服务层:包含 tRPC API、后台服务、工作流引擎(n8n)以及任何特定于 epic 的服务
  • 数据层:展示数据库(PostgreSQL)、向量数据库(Qdrant)、缓存层(Redis)以及外部 API 集成
  • 基础设施层:体现 Docker 容器化和部署架构

使用清晰的子图来组织这些层,为不同组件类型应用一致的颜色编码,并展示组件之间的数据流。在相关时包含同步请求路径和异步处理流程。

3. 高层功能与技术使能项
  • 待构建的高层功能列表。
  • 支持这些功能所需的技术使能项列表(例如,新服务、库、基础设施)。
4. 技术栈
  • 将使用的关键技术、框架和库列表。
5. 技术价值
  • 评估技术价值(例如,高、中、低),并附简要理由。
6. T 恤尺码估算
  • 提供该 epic 的高层 T 恤尺码估算(例如,S、M、L、XL)。

上下文模板

  • Epic PRD: [Epic PRD markdown 文件的内容]

评论

支持 Markdown