关于 code-explanation
用于讲解代码、架构和技术概念的 Skill,可按受众调整深度,并通过结构化流程和示例促进知识传递。
主要功能
- 01按受众调整讲解深度
- 02渐进式组织讲解
- 03使用示例辅助理解
- 04检查准确性与清晰度
适用场景
- 01说明代码或系统行为
- 02开展技术知识传授
- 03解释框架或领域概念
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ nickcrew/ claude-cortex --skill code-explanation安装后在 Claude Code 中输入/code-explanation确认已加载。
附带文件references/explain.mdreferences/pedagogical-methodology.md
详细介绍
代码讲解
概述
以适当的深度、结构和示例,清晰地讲解代码和概念。根据受众水平调整输出。
使用场景
- 讲解代码、架构或系统行为
- 编写有助于知识传递的教学说明
- 阐明框架或领域概念
避免用于:
- 请求严格限于文档生成时(使用 documentation-production)
快速参考
| 任务 | 加载参考资料 |
|---|---|
| 讲解工作流 | skills/code-explanation/references/explain.md |
| 教学方法论 | skills/code-explanation/references/pedagogical-methodology.md |
工作流
- 确定目标、受众水平和格式。
- 加载讲解参考资料。
- 分析代码或概念。
- 按由浅入深的方式组织讲解。
- 验证准确性和清晰度。
输出
- 结构化讲解及示例
- 关于假设和后续事项的说明
常见错误
- 未校准受众水平
- 未验证源代码行为便进行讲解
评论
支持 Markdown