ferdinandobons/AWSBestPracticesSkill

GitHub: ferdinandobons/AWSBestPracticesSkill

为 Claude Code 和 OpenAI Codex 提供 208 项 AWS 服务的带来源最佳实践知识库,避免模型训练数据过时或实时搜索的高昂 token 开销。

Stars: 35 | Forks: 1

# AWS 最佳实践 Skill **询问你的 AI 编码代理“我该如何保护我的 S3 bucket”,即可获得带来源且最新的 AWS 最佳实践,同时跳过过时的训练数据和昂贵的实时查询。** 这是一个专为 **Claude Code** 和 **OpenAI Codex** 打造的 skill,它收集了**每个 AWS 服务的最佳实践**,且仅限于此。你可以通过**使用场景**(如安全、可靠性、性能、成本、运维和可持续性)来查找建议,每一条建议都附有官方 AWS 来源链接。 **项目主页:** **最新版本:** [v0.1.2](https://github.com/ferdinandobons/AWSBestPracticesSkill/releases/tag/v0.1.2) ## 为什么使用这个 skill,而不是直接询问模型 AI 代理可以通过三种方式回答“该 AWS 服务的最佳实践是什么”: 1. **凭记忆**:免费且即时,但一旦 AWS 发布新功能、重命名服务或更新其 Well-Architected 指南,模型的训练数据就会过时。即使回答错误或已过时,它依然会表现得自信满满。 2. **实时查询**:代理每次都会运行网络搜索或查询 AWS 文档 MCP 服务器。这种方式能得到准确答案,但成本高昂:需要经历多次“搜索 → 抓取 → 阅读”的往返过程,消耗数万个 token;哪怕相同的问题被问了两遍,每次也会重复这个过程。 3. **使用本 skill**:研究工作已经针对每个服务一次性完成,并以带有来源链接的小文件形式存储。代理只需精确打开 `services//.md`,读取几百行内容即可给出答案,无需实时搜索,也没有重复的 token 消耗,同时每一条实践依然可追溯到官方的 `docs.aws.amazon.com` / `aws.amazon.com` / `wa.aws.amazon.com` 页面。此外,考虑到内容会随时间推移而老化,文中记录的更新循环(见下文)能防止这些内容悄然退化回“过时的训练数据”状态。 ## 包含 / 不包含的内容 | ✅ 包含 | ❌ 不包含 | |---|---| | 按 Well-Architected 支柱划分的各服务最佳实践 | 服务概述 / “X 是什么” | | 每条实践附带的 `[when-it-applies]` 上下文标签 | 定价、成本估算、计算器 | | 跨服务的通用最佳实践 | 教程 / 入门指南 / 操作说明 | | 每条记录均提供官方 AWS 来源链接 | 冗长的代码示例 | ## 快速开始 **Claude Code**(插件,推荐): ``` claude plugin marketplace add ferdinandobons/AWSBestPracticesSkill claude plugin install aws-best-practices@aws-best-practices-skill ``` 使用 `claude plugin update aws-best-practices` 更新,使用 `claude plugin uninstall aws-best-practices` 卸载。(在激活的 Claude Code 会话中,同样可以通过 `/plugin marketplace add ...` 和 `/plugin install ...` 来完成。) **OpenAI Codex CLI**(插件,推荐): ``` codex plugin marketplace add ferdinandobons/AWSBestPracticesSkill codex plugin add aws-best-practices@aws-best-practices-skill ``` 使用 `codex plugin marketplace upgrade aws-best-practices-skill` 更新,使用 `codex plugin remove aws-best-practices@aws-best-practices-skill` 卸载。 **手动安装(备用方案,两者均适用):** ``` # Claude Code git clone https://github.com/ferdinandobons/AWSBestPracticesSkill ~/.claude/skills/aws-best-practices # OpenAI Codex CLI git clone https://github.com/ferdinandobons/AWSBestPracticesSkill ~/.codex/skills/aws-best-practices ``` 随时可通过 `git -C pull` 进行更新。 如果工具已打开,请将其重启。有两种使用方式: **直接使用**,通过名称调用该 skill: - Claude Code:`/aws-best-practices`(手动安装)或 `/aws-best-practices:aws-best-practices`(插件安装;插件 skill 采用 `plugin:skill` 的命名空间格式)。 - Codex CLI:在你的 prompt 中引用 `aws-best-practices`(例如“使用 aws-best-practices skill 来...”)。 **间接使用**,只需询问有关某个服务的问题,它就会自动触发,无需手动调用: 无论哪种方式,模型都会读取 [`SKILL.md`](SKILL.md),打开匹配的 `services//.md`(或 `general/.md`),并给出带来源的最佳实践;它不需要打开此仓库中的任何其他内容。 ## 导航原理 `SKILL.md` 是一个路由器。模型会从你的使用场景中识别出相应的服务及关注点,打开 `services/` 下匹配的文件,先阅读 **Common scenarios** 映射表,接着再阅读相关的支柱章节。 ``` SKILL.md # router / index (what the model reads first) catalog.md # human-readable index (generated) catalog.json # machine-readable source of truth services//.md # per-service best practices general/.md # cross-service best practices scripts/ # maintainer utilities (check.py, cost.py) docs/ # GitHub Pages landing page + SEO metadata GENERATE.md # fills in missing files (maintainers) REFRESH.md # periodic refresh: new services + stale content (maintainers) .claude-plugin/ # Claude Code plugin + marketplace manifest .codex-plugin/ # Codex CLI plugin manifest .agents/plugins/ # Codex CLI marketplace manifest ``` 在 [`catalog.md`](catalog.md) 中浏览完整索引。 ## 覆盖范围 - 涵盖 23 个 AWS 类别下的 **208 项服务**,外加 **9 份**通用的跨服务文档:共计 217 个文件,且已全部完成。 - 最佳实践均源自 AWS 官方文档和 Well-Architected Framework。 - 截至上次全面检查,所有来源链接均已验证有效(HTTP 200,官方 AWS 主机)。 ## 目录的更新维护机制 这并非一次性的快照。有两个可移植的、与工具无关的 prompt 驱动着目录的生命周期:将它们中的任意一个粘贴到该仓库下的 Claude Code / Codex CLI 对话中即可。 - **[`GENERATE.md`](GENERATE.md)** 会为尚未生成文件的目录条目补全内容,它通过查阅各服务的官方 AWS 文档来进行研究。 - **[`REFRESH.md`](REFRESH.md)** 会定期运行以 (1) 将 `catalog.json` 与 AWS 当前的服务列表进行 diff 对比,从而发现新服务、捕获重命名或重新分类的服务、移除已完全退役的服务,以及 (2) 重新审查根据 `scripts/check.py --stale` 判定内容已经陈旧的现有文件(默认标准:超过 180 天未审查)。 这两者都受 [`scripts/check.py`](scripts/check.py) 的管控,该脚本可在零外部依赖的情况下验证结构、覆盖范围、时效性和链接健康度(`--check-links` 会联网请求;其他操作均为纯标准库解析),从而确保维护过程不会在不知不觉中偏离“仅提供带来源的最佳实践”这一原则。 ## 构建成本 整个最佳实践语料库都是通过将 [`GENERATE.md`](GENERATE.md) 粘贴到编码代理的对话中生成的。每次生成运行都会追踪 token 消耗量。 **截至目前,生成成本约为:30.51M tokens**(30,510,969),跨越 481 个工作流 agent · 217 个文件。有关各阶段的成本明细,请参见 [`docs/build-cost.md`](docs/build-cost.md)。 ## 维护 这是一个动态更新的合集。关于更新流程,包括使用 [`GENERATE.md`](GENERATE.md) 生成缺失的条目、使用 [`REFRESH.md`](REFRESH.md) 保持目录最新,以及验证机制,均记录在 [`MAINTENANCE.md`](MAINTENANCE.md) 中。在本地进行验证,请运行: ``` python3 scripts/check.py # coverage + conformance + freshness summary python3 scripts/check.py --strict # release gate: every catalog entry has a file python3 scripts/check.py --check-links # validate all source links (network) python3 scripts/check.py --stale # list entries due for a REFRESH.md pass ``` 欢迎贡献代码,在提交 PR 之前请参阅 [`MAINTENANCE.md`](MAINTENANCE.md)。 ## 许可证 MIT,详见 [`LICENSE`](LICENSE)。
标签:AI编程助手, AWS, DPI, Ruby, SOC Prime, 开发工具, 提示词工程, 最佳实践, 知识库, 策略决策点, 逆向工具, 防御加固