borghei/Claude-Skills / engineering/deep-module-design
deep-module-design
VerifiedDesign deep modules with small interfaces and rank shallow, pass-through or leaky code for deepening. Use when designing a module interface, improving codebase architecture, or making code easier to test.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 13.3 KB |
| assets/architecture-review-template.md | markdown | 1.9 KB |
| assets/interface-design-brief-template.md | markdown | 1.5 KB |
| assets/sample_codebase.json | config | 6.4 KB |
| assets/sample_designs.json | config | 3.1 KB |
| references/architecture-review-playbook.md | markdown | 7.2 KB |
| references/depth-principles.md | markdown | 9.5 KB |
| scripts/interface_compare.pyexecutable | script | 8.2 KB |
| scripts/module_depth.pyexecutable | script | 13.3 KB |
assets/interface-design-brief-template.md
View on GitHub# Interface Design Brief — <module concept>
Fill one brief per candidate design. Two or more briefs, each written under a
different constraint, go into the comparison.
## Shared context (identical across briefs)
- **Concept the module owns:** <one domain concept, glossary name>
- **Modules it absorbs:** <paths>
- **Callers today:** <list, with the most common caller marked>
- **Responsibilities that must be placed** (hidden or handed to callers):
1. <responsibility>
2. <responsibility>
- **Dependencies and categories:** <dependency — in-process / local stand-in / remote owned / third party>
- **Recorded decisions to respect:** <ids>
## This design
- **Constraint:** smallest surface | common caller first | flexible | port-based
- **Entry points:**
| Name | Parameters | Returns | Error modes | Ordering rules |
|------|-----------|---------|-------------|----------------|
| | | | | |
- **Configuration knobs:** <list, with defaults>
- **Hides:** <responsibilities kept inside>
- **Leaves to callers:** <responsibilities callers must handle>
- **Seams and adapters:** <seam — adapter 1, adapter 2>
- **Common caller's code:**
```
<the three to five lines the most common caller writes>
```
- **Invariants:** <what is always true after any call>
- **Where leverage is high / thin:** <one line each>
## Comparison entry
Copy the entry points, knobs, hides, leaks, seams and common-case call count
into the `designs` list of the comparison JSON and run `interface_compare.py`.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| finishing-a-development-branchobra/superpowersUse when implementation is complete, all tests pass, and you need to decide how to integrate the work | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixes | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation code | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| skill-creatoranthropics/skillsCreate new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |