关于 explain-irl
explain-irl 是一种写作技能,通过追踪代码行为,将结果写成以人物为中心的场景。它帮助开发者用具体影响说明权衡和缺陷。
主要功能
- 01从请求或会话中选定主题
- 02设定人物及虚构的起始数值
- 03追踪输入经过代码后的结果
- 04比较不同选项或正常与故障路径
- 05以产品影响解释错误及其后果
适用场景
- 01通过用户结果说明代码变更的权衡
- 02展示条件性缺陷如何影响某个人
- 03区分系统计算值与示例估算值
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ angusfretwell/ skills --skill explain-irl安装后在 Claude Code 中输入/explain-irl确认已加载。
详细介绍
场景按日期顺序跟随一个人,直到读者看到这个主题对他们造成的影响。
1. 选择主题
使用调用中点名的主题。否则,使用本次会话中最近提出的主题;如果那条消息提出了多个主题,则使用 AskUserQuestion 询问要选哪一个。
完成标准:明确指出一个主题。
2. 设定人物并追踪
设定一个感受到后果的人,使用项目中的术语称呼他们:客户、编辑、API 的调用者。给他们一个名字和一个以实际单位表示的起始状态:数量、大小或日期。即使可以访问真实记录,也要虚构这个人以及与他们有关的所有数值。
沿一条路径追踪他们,或沿着仅有一处差异的多条路径追踪:
- 对于权衡取舍,每个选项对应一条路径。
- 对于只在某些条件下才会造成影响的问题,把正常路径和出错路径并列。
追踪每条路径:将这个人的输入代入决定结果的代码,并记录系统在每一步产生的结果。代码无法决定的数字(例如该条件出现的频率)属于示例数据;在场景中将其标明。
完成标准:每条路径上系统产生的每个数字都有追踪依据,其他所有数字要么是这个人输入的虚构数据,要么已标明为示例数据。
3. 讲述场景
在对话中以散文形式讲述场景,遵循 /humanize。在原因造成影响的那一刻,用产品术语说明原因:“搜索索引会在夜间重建,因此她上午 9 点发布的商品要到明天才能被找到”。
根据主题加入适用的内容:
- 当系统显示错误信息时:说明它显示的内容与实际情况有何不同、他们据此采取行动后会发生什么,以及错误属于明显错误(有人投诉)还是隐性错误(没有人报告一个看似合理的数字)。
- 对于影响范围不确定的问题,说明其条件出现的频率以及你对此有多大把握。
完成标准:场景以这个人遭遇的结果收尾,读起来不依赖它所替代的解释。
评论
支持 Markdown