mcpField
T
tasks-explain-diff

tasks-explain-diff

github.com/makenotion开发3939 次安装38 周前更新
代码仓库

关于 tasks-explain-diff

该 Skill 将代码变更整理为包含背景、原理、代码说明、验证和可选方案的 Notion 页面,面向需要理解变更的开发者和读者。它还加入知识测验,并通过 Notion MCP 创建页面并返回链接。

主要功能

  1. 01说明变更背景与核心原理
  2. 02按文件和行号讲解代码变化
  3. 03记录测试与手动验证步骤
  4. 04整理可行替代方案及优缺点
  5. 05生成选择题并创建 Notion 页面

适用场景

  1. 01为近期代码变更编写说明文档
  2. 02帮助新成员理解系统改动
  3. 03整理代码变更的验证方法
  4. 04通过测验检查读者理解程度

MCP 相关

使用 Notion MCP 创建说明页面,并返回页面 URL。

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/makenotion/cursor-notion-plugin --skill tasks-explain-diff

安装后在 Claude Code 中输入/tasks-explain-diff确认已加载。

详细介绍

解释代码变更

创建一个新的 Notion 页面,详细说明代码变更。

输入

用户会指出需要解释的代码变更。如果未明确指定,则解释对话中最近一批变更。

文档章节

背景

说明与此变更相关的现有系统:

  • 从整体上探索周边代码,以了解上下文
  • 为初学者提供深入的背景说明(熟悉的读者可以跳过)
  • 介绍与此变更直接相关的背景
直觉

说明代码变更的核心思路:

  • 聚焦本质,而非完整细节
  • 使用简单数据举例说明
  • 多使用示意图和 mermaid 图表
代码

从较高层面逐步讲解变更:

  • 将变更分组,并按易于理解的顺序排列
  • 说明每项重要变更的目的
  • 链接到具体文件和行号
验证

说明如何验证代码变更:

  • 单元测试、集成测试等
  • 手动 QA 分步指南
替代方案

介绍 1–2 种替代方案(如果能识别出来):

  • 每种替代方案都要说明优缺点
  • 将优缺点排列在两列中
  • 仅在其代表一种正交方案时纳入
  • 如果没有有意义的替代方案,则省略此章节
测验

5 道考查读者知识的问题:

  • 难度适中,需要理解核心内容
  • 选择题,并附上解释
  • 使用折叠块显示答案:
1. Question
   > Option 1
     - Explanation for why incorrect
   > Option 2
     - Explanation for why correct

格式指南

  • 使用 Notion MCP 创建页面并返回其 URL
  • 行文清晰流畅,风格引人入胜、典雅经典
  • 各章节之间过渡自然
  • 全程使用一致的图示风格
  • 使用提示框突出关键概念、定义和边界情况

评论

支持 Markdown