SuperAPI AI 工具集

wa-builder

编程与开发

查看项目

更新于 10-15 12:01

技能介绍

用途

wa-builder 是一个面向 AWS Well-Architected 的“Learn then Build”技能,目标是帮助开发者理解适用于自身工作负载的 Well-Architected 最佳实践,并产出可以直接提交到代码库的可视化产物。资料明确指出,它与 aws-well-architected-framework-review(负责评估与打分)不同,wa-builder 的定位是“教学与赋能”。

知识库

该技能使用 AWS Well-Architected Framework(6 大支柱、57 个问题)作为其知识库,不要求外部框架文件——所有指导都源自 WA Framework 的问题与设计原则。

主要能力

资料列出三类可产生的产物:

  1. 带 WA 注释的架构图:展示架构中的主要组件,用颜色编码边框标示支柱健康度(🟢 绿=关键 BP 已实现、🟡 黄=存在部分缺口、🔴 红=关键/高优先级缺口),并标注风险热点及具体 BP ID,附颜色图例。主格式为 PlantUML,另提供 Mermaid 备选。
  2. 决策树:针对与工作负载缺口相关的架构决策生成 Mermaid 流程图,从具体工作负载上下文出发,依据可用性目标、成本容忍度、团队规模、合规等标准分支,最终给出引用 BP ID 的具体建议,并在叶子节点标注工作量/成本指标。常见决策领域包括:计算(serverless 对比容器对比 VM)、数据(SQL 对比 NoSQL、单区域对比多区域)、韧性(多 AZ 对比多区域、active-active 对比 warm standby)、部署(金丝雀对比蓝绿对比滚动)、安全(WAF 规则、加密方式、身份提供商)。
  3. 改进路线图:由 Mermaid 甘特图与 ASCII 依赖关系图组成。甘特图按阶段(Quick Wins 第 1-2 周、Foundation 第 3-6 周、Strategic 第 2-3 月)展示时间线;依赖图展示哪些事项阻塞哪些事项。排序依据包括改进项之间的前置关系、工作量分组以及支柱依赖关系。

使用方式

技能的流程包含以下步骤:

  • 步骤 1:上下文与校准。询问工作负载名称与简要描述(或指向代码)、WA 熟悉程度(New to WA / Familiar / Practitioner)、想要哪种产物(架构图、决策树、路线图或三者全部)、可选的现有评审输出。若未明确说明熟悉程度,会从用词中推断(自然使用 pillar、HRI、RTO/RPO、blast radius 等术语判为 Practitioner;询问“什么是 WA”判为 Beginner;默认 Familiar)。不同经验水平在学习、发现和产物环节有不同深度。
  • 步骤 2:工作负载发现。分两条路径:路径 A(独立使用,无先前评审)进行轻量发现,扫描 IaC 文件、识别计算模式、数据存储、网络拓扑、部署运维模式,产出工作负载画像(架构模式、所用 AWS 服务、每支柱健康信号、前三大风险热点);路径 B(评审后)解析 aws-well-architected-framework-review 报告,提取支柱评分、按严重程度的发现、证据位置、修复计划项与架构图,直接使用、跳过轻量发现。此步骤设有检查点,要求用户明确确认后才继续。
  • 步骤 3:学习阶段。Practitioner 完全跳过;Beginner 获得完整支柱讲解、类比与“这对你为什么重要”的说明;Familiar 获得简洁的支柱缺口说明。问题按风险严重程度和与工作负载模式的相关性排序。
  • 步骤 4:产物生成。生成所有被请求的产物,每个产物必须包含 BP ID 引用、颜色编码或严重度标示,且内容针对用户具体工作负载而非通用模板。
  • 步骤 5:提交建议。建议保存位置(如 docs/architecture/wa-annotated.puml、docs/decisions/{topic}-decision.md、docs/roadmap/wa-improvement-roadmap.md),并可选择细化产物、深入某个决策、为路线图中某项改进生成 IaC、为决策创建 ADR,或运行完整的 /aws-well-architected-framework-review 以获得精确的逐 BP 评分。

ADR 模式

当用户要求“创建 ADR”“记录设计决策”“评估架构选项”或“权衡分析”时,技能切换到 ADR 模式,ADR 基于代码库分析。流程包括:理解决策(标题、上下文、至少两个备选项);当前状态发现(现状实现及文件路径行号、受影响代码、集成点、约束、依赖);基于证据评估各选项(受影响文件、新依赖、迁移步骤、具体工作量、WA 支柱影响表、运维影响),此步骤设有检查点,需确认后才进入推荐;权衡与风险(推荐选项的收益、放弃项、风险与缓解、可逆性,被拒选项的主要拒绝理由及未来何种条件下更优);最终产出包含状态、日期、上下文、决策、选项评估、Well-Architected 影响表、权衡、实现(迁移路径、回滚计划、验证)、复核触发器的完整 ADR。

适用场景

需要针对自身具体工作负载学习 AWS Well-Architected 最佳实践的开发者;希望获得可提交的架构注释图、决策树与改进路线图的团队;需要基于代码库证据记录架构决策(ADR)的场景;已有 WA 评审报告并希望据此产出更丰富可视化产物的场景。

限制

资料未提供该技能的收费、价格、平台支持范围、运行环境要求等具体信息,这些事实暂未提供。技能存在明确的检查点机制:工作负载发现完成后、以及 ADR 选项分析完成后,均要求用户明确确认才继续。资料强调该技能重在赋能而非评判,语气应鼓励而非批判;决策树呈现选项而非强制要求;路线图应现实可行,不应把大量事项塞进 Quick Wins。