SuperAPI AI 工具集

explain

通用与其它

查看项目

更新于 10-15 23:47

技能介绍

用途:当用户要求解释当前工作目录中的项目、总结仓库功能、描述其结构时,使用该技能生成面向用户的清晰说明。它与“上手引导”不同,目标不只是让智能体熟悉项目,而是产出可直接给用户看的解释。

主要能力:说明项目看起来做什么、面向谁或什么用途、主要技术与框架、重要文件与目录、代码如何组织、在可发现时如何运行/构建/测试,以及值得注意的约束、风险或不清楚之处。

使用方式:先检查项目说明,读取本地 AGENTS.md、.codex/、.agents/、README 及中央文档(若存在),项目特定说明优先于全局假设。再识别项目类型与栈,检查 package.json、pyproject.toml、Cargo.toml、go.mod、platformio.ini、CMakeLists.txt、compose.yaml 及 CI 工作流等常见清单/配置文件。用 rg --files 和浅层目录列表映射结构,避免依赖、生成、缓存和构建输出目录。读取代表性文件,检查入口点、主模块、路由、命令、硬件目标或应用界面,只读解释项目所需内容。最后输出简洁具体的面向用户说明,区分已确认事实与推测,仅在重要时提及未知项。

输出结构(在有用时):Overview、Main Stack、Directory Map、How It Works、Run / Build / Test、Important Files、Notes and Unknowns。优先短小节而非冗长分析。

限制:除非用户明确要求文档变更,否则不要编辑文件。若用户要求 README 风格文档,先提议目标文件,并等待明确编辑批准后再创建或修改文件。