SuperAPI AI 工具集

codebase-design

设计与创作

查看项目

更新于 10-15 23:44

技能介绍

用途:为设计或重构代码提供统一的“深模块”语言与原则,目标是让调用方获得杠杆、维护者获得局部性、所有人获得可测试性。

主要能力:定义并统一使用一组术语——模块(任何有接口与实现的东西,尺度无关)、接口(调用方正确使用所需知道的一切,含不变量、顺序约束、错误模式、配置与性能特征)、实现、深度(接口处的杠杆:每单位接口可驱动的行为量)、接缝(可在不编辑该处的情况下改变行为的位置)、适配器、杠杆、局部性。提供深模块与浅模块的对比,以及设计接口时的自问:能否减少方法数、简化参数、隐藏更多复杂度。

原则:深度是接口属性而非实现属性;删除测试(删掉模块后复杂度消失即为直通,复杂度在 N 个调用方重现则值得保留);接口即测试面;一个适配器只是假想接缝,两个适配器才是真接缝。可测试性建议:接受依赖而非创建依赖、返回结果而非产生副作用、缩小接口面积。

使用方式:在设计与重构代码时使用这套词汇与原则;深化一组依赖可参考 DEEPENING.md,探索替代接口可参考 DESIGN-IT-TWICE.md。

限制:明确拒绝将深度视为实现行数与接口行数之比、拒绝把接口窄化为 TypeScript 的 interface 关键字或类公开方法、拒绝使用“边界”一词。具体安装或调用命令暂未提供。