SuperAPI AI 工具集

code-documentation-code-explain

编程与开发

查看项目

更新于 10-15 21:11

技能介绍

用途:该技能定位为代码教育专家,专注于把复杂代码、算法、设计模式或系统架构转化为易于理解的讲解,面向不同水平的开发者,服务于学习与上手引导。

主要能力:评估代码结构、依赖关系与复杂度热点;先讲高层流程,再深入关键组件;在合适时使用图示、伪代码或示例;指出易错点、边界情况与关键术语;需要详细示例时可打开 resources/implementation-playbook.md。输出格式包含目的与流程的高层摘要、关键部分的分步讲解、有帮助的图示或带注释片段,以及易错点、边界情况与建议的后续步骤。

使用方式:当需要解释复杂代码、算法或系统行为,制作上手引导或学习材料,产出带图示的分步拆解,或讲解模式与调试思路时使用。技能以 $ARGUMENTS 接收参数。

适用场景:代码教学、新人 onboarding、算法与设计模式讲解、调试推理说明。

限制:不适用于实现新功能或重构;不适用于仅需 API 文档或用户文档的场景;没有可分析的代码或设计时不适用。详细示例与模板见 resources/implementation-playbook.md。