SuperAPI AI 工具集

code-documentation-code-explain

编程与开发

查看项目

更新于 10-16 02:12

技能介绍

用途

该技能定位为代码教育专家,目标是把难以理解的代码、算法、设计模式或系统架构,转化为开发者易于消化的讲解。它强调清晰性、可视化辅助和渐进式披露复杂度,以支持学习与新人上手。

主要能力

  • 评估代码的结构、依赖关系与复杂度热点。
  • 先讲解高层流程,再深入到关键组件。
  • 在有用时使用图表、伪代码或示例辅助说明。
  • 指出易错点、边界情况与关键术语。
  • 如需详细示例,可打开 resources/implementation-playbook.md 获取模板与范例。

使用方式

当需要解释复杂代码、算法或系统行为,制作上手引导或学习材料,生成带图表的逐步拆解,或讲解模式与调试推理时使用本技能。技能接收 $ARGUMENTS 作为输入参数。执行时按以下步骤进行:先评估结构、依赖与复杂度热点;再解释高层流程并深入关键组件;必要时配以图表、伪代码或示例;最后点明易错点、边界情况与关键术语。若需要详细示例,则查阅 resources/implementation-playbook.md。

输出格式

  • 目的与流程的高层摘要
  • 关键部分的分步讲解
  • 有帮助时的图表或带注释的代码片段
  • 易错点、边界情况与建议的后续步骤

适用场景

  • 解释复杂代码、算法或系统行为
  • 创建新人上手引导或学习材料
  • 生成带图表的逐步拆解
  • 讲解设计模式或调试推理

限制

以下情况不应使用本技能:请求是实现新功能或重构;只需要 API 文档或用户文档;没有代码或设计可供分析。

其他说明

该技能的具体收费、价格、支持平台与运行环境等信息暂未提供。