mcpField
P
principle-minimize-reader-load

principle-minimize-reader-load

github.com/backnotprop开发3.1k5.8k 次安装今天更新
代码仓库

关于 principle-minimize-reader-load

一项旨在降低代码理解成本的开发技能,重点关注间接层级以及隐藏或可变状态。它通过新读者追踪数据来源和变化所需的时间来检验代码可读性。

主要功能

  1. 01删减不必要的抽象层
  2. 02优先采用隐藏关键决策的接口
  3. 03将可变状态限制在较小范围
  4. 04在系统边界说明不变量
  5. 05以读者追踪成本评估代码

适用场景

  1. 01审查拟新增的包装层或适配器
  2. 02重构仅透传调用的层级
  3. 03减少共享可变状态
  4. 04帮助新贡献者追踪数据流

安装

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

$npx skills add https://github.com/backnotprop/pstack --skill principle-minimize-reader-load

安装后在 Claude Code 中输入/principle-minimize-reader-load确认已加载。

详细介绍

降低读者负担

可维护性,是读者为理解代码必须付出的努力。需要关注两个维度:追踪层数(问题与答案之间的间接层级)和需记住的状态(读者必须牢记的隐藏或可变上下文)。代码行数、圈复杂度和“整洁架构”都是衡量指标。真正重要的是读者负担。这两个维度彼此独立。一个有 50 个全局变量的扁平文件,可能和 6 层适配器堆栈一样难以推理。两方面都要把关。这是 守护上下文窗口 的人类对应版本。读者的工作记忆也有限。

  • 精简得不偿失的层级:只有一个调用方的包装器、没有第二种实现的适配器,以及从未有必要的推测性间接层。将它们内联。
  • 让相邻层改变抽象。 如果某一层只是重复相同的方法和参数,就会增加读者负担,却没有带来信息压缩。精简只负责透传的层。
  • 要求接口具备信息压缩能力。 隐藏的复杂度不多的宽泛接口,会让读者既要了解接口表面,也要了解实现。优先选择能隐藏重要决策的边界。
  • 缩小状态范围: 优先选择纯函数(返回值优于修改状态)、局部变量优于字段、字段优于模块状态、模块状态优于全局变量。能推导就不要同步。
  • 在边界处命名不变量, 不要让每个使用方都重复说明,这样读者只需了解一次。
  • 添加层级或状态前,先问:它是否能在其他地方至少同等程度地降低读者负担?

检验标准: 新读者能否在 30 秒内回答“X 的来源是什么?”和“什么会改变 X?”如果不能,就精简层级或状态。

评论

支持 Markdown