Agent Skills
返回列表
🎓

代码解释与分析

教育学习 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @org-02qudk26/code-documentation-code-explain。

技能介绍

要解决什么问题

读别人的代码、啃算法实现或理清微服务调用链时,常见问题不是「缺文档」,而是文档和代码对不上、复杂度被一次性摊开,读者在依赖关系和边界条件里迷路。本技能面向「需要真正理解一段现有代码或设计」的场景,而不是替你写新功能或生成 API 手册。

技能如何工作

它把角色设定为代码教育专家:先评估结构、依赖与复杂度热点,再按「先总览、后细节」组织输出。

  • 高级摘要:说明这段代码/系统的目的与主流程。
  • 逐步讲解:拆关键模块与数据流,必要时用图表、伪代码或注释片段。
  • 术语与陷阱:标出易错点、边界情况,以及值得继续深挖的方向。

若需要更完整的示例模板,技能会引导参考 bundled 资源 resources/implementation-playbook.md。

适用边界

  • 适合:解释复杂代码与算法、做入职培训材料、带图的分步说明、讲设计模式或调试思路。
  • 不适合:实现新功能或重构、只要用户/API 文档、或上下文中根本没有可分析的代码或架构。用户侧通过 $ARGUMENTS 传入待分析的具体代码或问题描述。

使用场景

  • 接手遗留模块前,需要把调用链、依赖和关键分支用分步说明讲给组内同事听
  • 为 PR 或设计评审准备材料,要把某段复杂实现的主流程和边界条件可视化拆解
  • 调试线上问题时,先系统梳理相关代码的行为假设,再对照日志推理失败路径
  • 编写内部学习文档,针对仓库里的排序/并发等算法做带伪代码与陷阱说明的讲解

适合人员

  • 刚加入业务线、必须在改 bug 前搞清支付/订单等核心流程的后端工程师
  • 负责新人 onboarding、要把单体或 monorepo 里某子系统讲清楚的技术负责人
  • 需要把开源或内部库中难读实现整理成培训稿的内训讲师或 mentor
  • 维护核心库、希望向贡献者解释非显而易见并发或状态机设计的 maintainer