AgentSkillsCN

explaining-code

利用可视化图表解释代码。适用于阐释代码运行原理、传授代码库知识、讲解软件工具,或当用户询问“这是怎么运作的?”时使用。输出格式为 Markdown。

SKILL.md
--- frontmatter
name: explaining-code
description: 使用視覺化圖表來解釋程式碼。適用於解釋程式碼運作方式、教導程式碼庫知識、軟體工具講解、技術講解,或當使用者詢問「這是怎麼運作的?」時使用。輸出格式為 Markdown。

解釋程式碼時,務必包含以下內容

順序項目說明
1主要功能說明這個工具/程式碼的核心功能是什麼、解決什麼問題、為什麼需要它
2繪製圖表使用 ASCII art 來展示流程、結構或關聯性
3時序圖使用 Mermaid code 來展示程式碼的運作流程
4指出常見陷阱說明常見的錯誤或誤解
5程式範例提供簡短的程式碼範例來說明重點,不需要細節,不需要提供如何配置參數
6回應語言使用繁體中文回答

可選項目(僅在使用者明確要求時使用)

項目說明觸發條件
類比說明使用生活中的例子來解釋技術概念使用者明確要求「用類比解釋」或「舉個生活例子」

圖表使用指南

圖表類型適用情境
ASCII art簡單的結構關係、快速示意
Mermaid 流程圖複雜的邏輯分支、決策流程
Mermaid 時序圖多個元件之間的互動順序
Mermaid 類別圖物件導向的類別關係