SuperAPI AI 工具集

codebase-design

编程与开发

查看项目

更新于 10-16 18:01

技能介绍

用途:设计内聚的深模块,即用小型、稳定的调用方契约隐藏大量相关行为与设计决策,为调用方提供杠杆、为维护者提供局部性,同时避免形成上帝模块。它关注逻辑职责与契约形态;物理路径、包、导出与依赖方向交给 structure-codebase,公开兼容性交给 api-design,仓库级扫描交给 improve-codebase-architecture。

主要能力:提供词汇表(模块、接口/公开契约、实现、深度、杠杆、局部性、接缝、适配器)与设计原则,包括隐藏决策而非仅隐藏代码、保持深度内聚、行为保持的内联测试、有意识地把复杂度下移、用证据论证接缝、在稳定契约上测试、保留有意为之的薄边缘。

使用方式:按工作流执行——定义职责与调用方;盘点完整契约负担;梳理隐藏与泄漏的知识;先定职责再定接缝;从使用场景设计契约;检验深度主张;把交付路由给相应技能。提出重大设计前按需阅读 references/deepening.md、design-it-twice.md、source-notes.md。设计输出包含职责与排除项、调用方与场景、完整契约、隐藏知识、依赖与接缝、备选方案、兼容与迁移约束、行为测试、假设与风险。

适用场景:设计或变更进程内模块/包契约、合并浅层透传模块、决定隐藏内容、比较替代接口、判断代码合并或拆分。

限制:不负责物理布局、公开兼容性、仓库级扫描或整体机制削减;在未选定的审计中加载时,只使用其词汇、原则、证据测试与薄边缘保障,不运行契约设计流程或提出具体接口。改编自 Matt Pocock 的 MIT 许可技能,深模块与 Design It Twice 概念归功于 John Ousterhout,接缝术语归功于 Michael Feathers。