Back to Details

code-explanation

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Code Explanation

代码解释

Overview

概述

Provide clear explanations of code and concepts with appropriate depth, structure, and examples. Adapt the output to the audience level.
以合适的深度、结构和示例清晰解释代码与概念，根据受众水平调整输出内容。

When to Use

适用场景

  • Explaining code, architecture, or system behavior
  • Producing educational explanations for knowledge transfer
  • Clarifying framework or domain concepts
Avoid when:
  • The request is strictly documentation generation (use documentation-production)
  • 解释代码、架构或系统行为
  • 制作用于知识传递的教学性解释内容
  • 阐明框架或领域概念
避免场景：
  • 当请求仅为生成文档时（请使用documentation-production技能）

Quick Reference

快速参考

TaskLoad reference
Explanation workflow
skills/code-explanation/references/explain.md
Pedagogical Methodology
skills/code-explanation/references/pedagogical-methodology.md
任务加载参考内容
解释工作流
skills/code-explanation/references/explain.md
教学方法论
skills/code-explanation/references/pedagogical-methodology.md

Workflow

工作流

  1. Identify target, audience level, and format.
  2. Load the explanation reference.
  3. Analyze the code or concept.
  4. Structure the explanation with progressive depth.
  5. Validate accuracy and clarity.
  1. 确定目标、受众水平和输出格式。
  2. 加载解释参考内容。
  3. 分析代码或概念。
  4. 构建具备递进深度的解释内容。
  5. 验证内容的准确性与清晰度。

Output

输出内容

  • Structured explanation with examples
  • Notes on assumptions and follow-ups
  • 包含示例的结构化解释内容
  • 关于假设前提与后续跟进的说明

Common Mistakes

常见误区

  • Skipping audience level calibration
  • Explaining without verifying source behavior
  • 跳过受众水平校准
  • 未验证源内容行为就进行解释