用途
cookbook-audit 用于审核 Anthropic Cookbook 中的笔记本(notebook)。当收到笔记本评审或审计请求时使用。它依据 style_guide.md 中的指南和评分标准,对笔记本给出评分以及改进建议。
主要能力
该技能提供详细的模板和示例,覆盖以下方面:
- 以问题为中心的引言,包含终端学习目标(TLO)和使能学习目标(ELO)
- 前置条件与设置模式
- 核心内容结构
- 与学习目标相呼应的结论
重要提示:进行审计前务必先阅读 style_guide.md,其中包含规范模板以及可参考的正面/反面示例。
使用方式
审计工作流如下:
- 阅读风格指南:首先查看 style_guide.md 以了解当前最佳实践。
- 确定笔记本:如果用户未提供路径,则询问路径。
- 运行自动化检查:使用
python3 validate_notebook.py <path>捕获技术问题并生成 markdown。该脚本会自动运行 detect-secrets 扫描硬编码的 API 密钥和凭据,使用 scripts/detect-secrets/plugins.py 中定义的自定义模式,并对照 scripts/detect-secrets/.secrets.baseline 中的基线进行检查。 - 查看 markdown 输出:脚本会在 tmp/ 文件夹中生成 markdown 文件以便审查(相比原始 .ipynb 更节省上下文)。tmp/ 文件夹已被 gitignore,避免提交审查产物。markdown 包含代码单元格但排除输出,便于更清晰地审查。
- 人工审查:阅读 markdown 版本,对照风格指南和评分标准进行评估。
- 逐维度评分:客观应用评分指南。
- 生成报告:遵循下方的审计报告格式。
- 提供具体示例:使用风格指南模板,给出带行号引用的具体改进建议。
审计报告格式
报告结构包括:
- 执行摘要:总分 X/20、关键优势(2-3 条)、关键问题(2-3 条)
- 详细评分:叙事质量 X/5、代码质量 X/5、技术准确性 X/5、可操作性与理解度 X/5,每项附简要理由和具体示例
- 具体建议:按优先级排列的可操作改进列表,引用具体章节
- 示例与建议:展示笔记本中的具体片段并给出改进建议
快速参考检查清单
该技能提供覆盖以下方面的检查清单:
- 引言:问题钩子、重要性说明、学习目标(2-4 条 TLO/ELO)、聚焦交付价值而非构建机制、可选更广泛应用
- 前置条件与设置:所需知识、所需工具(Python 版本、API 密钥)、推荐背景、使用 %%capture 抑制 pip install 输出、使用 dotenv.load_dotenv() 而非 os.environ、在顶部定义 MODEL 常量、将相关安装合并为单条命令
- 结构与组织:逻辑章节递进、每节通过演示教学、代码块前有说明文字、代码块后包含所学内容、使用标题分隔章节
- 结论:呼应学习目标、总结成果、建议应用到用户场景、指向后续步骤或相关资源
- 代码质量:代码块前有说明文字、无硬编码 API 密钥(由 detect-secrets 自动检查)、有意义的变量名、注释解释“为什么”而非“是什么”、遵循语言最佳实践、模型名在笔记本顶部定义为常量
- 输出管理:用 %%capture 抑制 pip install 日志、无冗长调试输出、展示相关 API 响应、仅在演示错误处理时显示堆栈跟踪
- 内容质量:解释方法为何有效、讨论何时使用该方法、提及限制/注意事项、提供可迁移知识、合适的模型选择
- 技术要求:无需修改即可执行(API 密钥除外)、使用非弃用的 API 模式、使用有效模型名(claude-sonnet-4-6、claude-haiku-4-5、claude-opus-4-6)、使用非日期化模型别名(绝不使用 claude-sonnet-4-6-20250514 这类带日期的 ID)、模型名在笔记本顶部定义为常量、包含依赖规格、分配主分类、具有相关标签
内容理念:行动 + 理解
Cookbook 以行动为导向,但策略性地融入理解,并受 Diataxis 框架启发。核心原则包括:实用聚焦、问题优先框架、构建者视角、培养自主性、可迁移知识、批判性思维、学习契约。
好的 Cookbook 不仅帮助用户解决当前问题,还帮助理解解决方案背后的原理,鼓励用户识别何时以及如何调整方法。
Cookbook 不是:纯教程、全面解释、参考文档、简单技巧、生产级代码。
风格指南
- 语气与风格:教育性和培养自主性、专业但平易近人、尊重用户智慧和时间、使用第二人称(“你”)或第一人称复数(“我们”)并在笔记本内保持一致
- 写作质量:清晰简洁、优先主动语态、短段落(3-5 句)、避免未定义术语、使用标题分隔章节
- 代码呈现:展示前先解释、运行后解释所学、注释解释“为什么”而非“是什么”、使用常量、良好习惯(dotenv.load_dotenv())
- 输出处理:用 %%capture 移除多余输出(pip install 日志、冗长调试语句、冗长堆栈跟踪),展示相关输出(API 响应、成功执行示例)
结构要求
- 引言(必需):问题钩子(1-2 句)、重要性(1-2 句)、学习目标(2-4 条,使用动作动词、具体能力、包含上下文/约束)、可选更广泛应用(1 句)。避免以机制开头,应以问题/价值开头。
- 前置条件与设置(必需):所需知识、所需工具(Python 版本、带链接的 API 密钥)、推荐背景、逐步设置与说明、用 %%capture 处理 pip install、使用 dotenv.load_dotenv()、在顶部定义 MODEL 常量。
- 主要内容(必需):按逻辑步骤或阶段组织,每节包含清晰标题、代码块前说明文字、代码示例、代码块后说明文字、预期输出(相关处)、可选理解提示(为何有效、何时使用、限制)。
- 结论(推荐):回顾学习目标、总结成果、应用指导、后续步骤。避免泛泛总结,应给出可操作指导。
可选章节:工作原理、何时使用、限制与注意事项、故障排除、变体、性能说明、延伸阅读。
常见反模式
- 引言反模式:以机制开头、功能堆砌、模糊学习目标
- 设置反模式:无 %%capture 的嘈杂 pip install 输出、多条独立 pip install 命令、使用 os.environ 而非 dotenv、硬编码模型名而非使用 MODEL 常量
- 代码呈现反模式:代码块前无说明文字、运行后无所学解释、注释解释“是什么”、过度解释明显代码
- 结论反模式:泛泛总结、仅重述笔记本内容而无指导、未呼应既定学习目标
适用场景
适用于对 Anthropic Cookbook 笔记本进行评审、审计或质量检查的场景,帮助审查者按统一标准评估笔记本并给出改进建议。
限制
该技能依赖 style_guide.md、validate_notebook.py 及 scripts/detect-secrets/ 下的相关文件;具体安装方式、收费情况、平台支持等信息暂未提供。