SuperAPI AI 工具集

adk-unit-guide

通用与其它

查看项目

更新于 10-15 21:53

技能介绍

用途:为 ADK Python 中的单个代码单元编写细粒度的使用指南,比 adk.dev 上的公开文档更深入,面向需要从应用中调用该单元的读者。

主要能力:规定指南以可运行示例开篇,覆盖公开 API 和调用者可见行为,包含配置选项表、进阶用法与已知限制;要求给出约束或默认值的原因,由读者自行取舍,不在指南中固化模型选择。

使用方式:输入为源文件或其中的类与方法,可选读取其单元测试和 docs/design/{topic}/{unit}/index.md 设计文档。指南镜像源码路径放入 docs/guides/,每个单元一个目录,文件名为 index.md,例如 src/google/adk/workflow/_function_node.py 对应 docs/guides/workflow/function_node/index.md。之后需登记到 docs/guides/README.md 对应分类下。

限制:不讨论私有方法、内部状态等实现细节;不使用 e.g.、etc.、缩写和最高级;标题不超过 H3。scripts/check_new_py_files.py 会检查新增文件,internal、platform/internal、v1 子树以及 init.py、cli/、utils/、_utils.py,_helper.py 等文件可豁免;无公开接口的模块也豁免。其余需指南或豁免标签。豁免写为 NO_UNIT_GUIDE= 或 SKIP_UNIT_GUIDE= 并附可核查理由,未提交时可通过环境变量传入,例如 NO_UNIT_GUIDE='covered by docs/guides/errors/index.md' git commit ...,无理由的标签不生效。样例用仓库相对路径链接。

其他具体格式细节暂未提供。