SKILL

codebase-design

用于设计深层模块的共享词汇。当用户想要设计或改进模块接口、寻找深化机会、决定接缝位置、使代码更可测试、AI-navigable 或智能体可读、选择以机械方式强制执行哪些不变量时,或当其他技能需要深层模块词汇时使用。

机器翻译
查看英文原文

Shared vocabulary for designing deep modules. Use when the user wants to design or improve a module's interface, find deepening opportunities, decide where a seam goes, make code more testable, AI-navigable, or agent-legible, choose which invariants to enforce mechanically, or when another skill needs the deep-module vocabulary.

适用对象:设计与内容创作。自动收录 · 待核查。

原作者说明节选

从固定版本的 SKILL.md 提取,保留原文语言。以下内容属于作者说明,本站尚未验证安装、兼容或运行结果。

查看英文原文

原文涵盖的主题

  • Codebase Design
  • Glossary
  • Deep vs shallow
  • Principles
  • Designing for testability
  • Agent legibility
  • Relationships
  • Rejected framings

Design deep modules: substantial behaviour behind a small interface at a clean seam, testable through that interface. Use this vocabulary when it clarifies a design decision. The aim is leverage for callers, locality for maintainers, and testability. Use these terms consistently where their distinctions matter. Module: anything with an interface and an implementation. Deliberately scale-agnostic: a function, class, package, or tier-spanning slice. Avoid: unit, component, service. Interface: everything a caller must know to use the module correctly: the type signature, but also invariants, ordering constraints, error modes, required configuration, and performance characteristics. Avoid: API, signature (too narrow because they refer only to the type-level surface). Implementation: what is inside a module, its body of code. Distinct from Adapter: a thing can be a small adapter with a large implementation (a Postgres repo) or a large adapter with a small implementation (an in-memory fake). When the seam is the topic, use "adapter". Otherwise, use "implementation". Depth: leverage at the interface. The amount of behaviour a caller (or test) can exercise per unit of interface they have t

这里只展示节选,请以完整原文和当前要求为准。

来源仓库
PaulRBerg/agent-skills
源文件
skills/codebase-design/SKILL.md
固定版本
3fc64886b46c95238cdad340a8a04e3aaac96665
阅读完整原作者说明 ↗

准备条件

  • 本条仅收录原作者的技能元数据;请阅读完整说明,确认依赖、许可与使用条件。

第一件可以尝试的小事

先阅读原作者说明,再决定是否在自己的 AI 工具中使用。

对应 AI 工具说明

作者有说明不等于本站实机验证。没有证据时,不自动标为兼容、安全或免费。

来源与内容状态

本条为自动发现的元数据,尚未完成人工文档核查;适用性与运行结果待核查。

原作者:PaulRBerg/agent-skills · 原作者仓库元数据。文档核查:未核查。最近来源检查:2026-11-10T00:00:29.888Z。

分类由名称、说明与路径规则生成,分类不代表已核实适配。

许可与权利归属

MIT。第三方内容及版权归原作者,使用条件以原文为准。

许可原文 ↗

本站没有因同步、复制或用户自报成功而将资源标为运行验证通过。

限制与注意事项

  • 元数据收录不代表本站已经安装、适配、实测或进行安全审查。