SuperAPI AI 工具集

generate-agent-docs

智能体与模型

查看项目

更新于 10-15 22:41

技能介绍

用途:为 AI 编程助手的自定义文件生成易读的文档与使用指南,覆盖 agent、skill、prompt、instruction 四类内容,适用于新成员上手、建立可用清单、生成特定 agent 的使用示例,以及记录自定义配置。

提供方目录:GitHub Copilot 用 .github/,Claude Code 用 .claude/,Codex 用 .codex/,OpenCode 用 .config/opencode/;文中以 <provider>/ 表示所选提供方的基础目录。

文档类型:单条文档(针对单个 agent、skill、prompt 或 instruction)与目录文档(汇总全部自定义文件的概览)。

输出模板:agent 文档含概述、何时使用(含 @[agent-name] 调用与不适用场景)、行为、示例对话、使用建议、相关项;skill 文档含用途、触发条件、执行内容、被谁使用、示例;prompt 文档含用途、模式、变量表、使用步骤、示例;instruction 文档含适用文件匹配模式、用途、关键规则、生效时机、受影响文件示例;目录文档含提供方、快速参考表(agent、子 agent、skill、prompt、instruction)与详细文档。

生成流程:读取源文件,从 frontmatter 提取名称与描述、从正文提取行为与规则、示例及相关项,再补充上下文(生成示例、识别生态内相关项、按常见模式加提示),最后按条目类型套用模板。

质量要求:清晰、实用、完整、简洁、与文件实际内容一致。补充示例时应覆盖不同用例、边界情况、与其他条目的集成及常见错误。

限制:资料未提供安装命令、收费方式、平台支持范围与效果保证等信息。