<< All versions

Skill v1.0.1

currentAutomated scan100/100
ryanthedev/code-foundations/aposd-reviewing-module-design

+3 new

──Details
PublishedOctober 26, 2026 at 07:14 PM
Content Hashsha256:8b5ae81c12b892dc...
Git SHAca30ba90ebd3
Bump Typepatch
Compare with v1.0.0
──Files
Files (1 file, 6.8 KB)
SKILL.md6.8 KBactive
SKILL.md · 173 lines · 6.8 KB

version: "1.0.1" name: aposd-reviewing-module-design description: "Assesses existing module and interface design for complexity symptoms: information leakage, shallow interfaces, pass-through layers, and unknown unknowns. Produces a structured assessment — not transformations (use aposd-simplifying-complexity to edit) and not new-design generation (use aposd-designing-deep-modules)." user-invocable: false


Skill: aposd-reviewing-module-design

Review Is Systematic, Not Intuitive

Run the checklist. The checklist exists because intuition misses structural problems.

Unknown unknowns are highest severity. If it's unclear what code/info is needed for changes, flag immediately.


Evaluation Checklist

Use this systematic checklist when reviewing code:

1. Complexity Symptoms (Ch2)

SymptomQuestionIf Yes
Change AmplificationDoes a simple change require modifications in many places?Flag dependency problem
Cognitive LoadMust developer know too much to work here?Flag obscurity or leaky abstraction
Unknown UnknownsIs it unclear what code/info is needed for changes?Highest severity - flag immediately

2. Module Depth (Ch4)

CheckDeep (Good)Shallow (Bad)
Interface vs implementationInterface much simplerInterface rivals implementation
Method countFew, powerful methodsMany, limited methods
Hidden informationHighLow
Common caseSimple to useComplex to use

Red flag: If understanding the interface isn't much simpler than understanding the implementation, the module is shallow.

3. Information Hiding (Ch5)

Red FlagDetectionSeverity
Information LeakageSame knowledge in multiple modulesHigh
Temporal DecompositionStructure mirrors execution order rather than knowledgeMedium
Back-Door LeakageShared knowledge not visible in interfaces but both depend on itHigh
OverexposureCommon use forces learning rare featuresMedium
Silent FailureModule swallows errors, returns defaults, or hides failure states from callersHigh

4. Layer Abstraction (Ch7)

Red FlagDetectionSeverity
Pass-Through MethodMethod only passes arguments to another with same APIHigh
Adjacent Similar AbstractionsFollowing operation through layers, abstractions don't changeHigh
Shallow DecoratorLarge boilerplate, small functionality gainMedium

Test: Follow a single operation through layers. Does the abstraction change with each method call? If not, there's a layer problem.

5. Together/Apart (Ch9)

Red FlagDetectionSeverity
Conjoined MethodsCan't understand one method without another's implementationHigh
Special-General MixtureGeneral mechanism contains use-case specific codeHigh
Code RepetitionSame code appears in multiple placesMedium
Shallow SplitMethod split resulted in interface ≈ implementationMedium

Together/Apart Decision Procedure

When evaluating whether code should be combined or separated:

1. Do pieces share information?
YES → Should probably be together
2. Would combining simplify the interface?
YES → Should probably be together
3. Is there repeated code?
YES → Extract shared method (if long snippet, simple signature)
4. Does module mix general-purpose with special-purpose?
YES → Should be separated

Key principle: Depth > Length. Never sacrifice depth for length.


Depth vs Length Rule

SituationCorrect Action
Long method with clean abstractionKeep together
Short method requiring another's impl to understandCombine them
Method split creating conjoined pairUndo the split
Long method with extractable subtaskExtract subtask only

Test for valid split: Can the pieces be understood independently AND reused separately?


Evaluation Output Format

When reporting findings, use:

## Design Review: [Component Name]
### Critical Issues (Must Address)
- [Red flag]: [Specific location] - [Why it's a problem]
### Moderate Issues (Should Address)
- [Red flag]: [Specific location] - [Why it's a problem]
### Observations (Consider)
- [Pattern noticed] - [Potential concern]
### Positive Patterns
- [What's working well]

This skill assesses only. To transform what it flagged, hand off to Skill(code-foundations:aposd-simplifying-complexity); if the fix needs a plan, flag it for /code-foundations:plan.

Before Flagging a Problem

Before reporting any red flag, validate:

  1. Steel-man check: What's the best argument this design choice is intentional?
  2. Intentional shallowness: Is this an adapter, facade, or decorator where thinness is the point?
  3. Testing seam: Is this "leakage" actually a legitimate dependency injection point?
  4. Abstraction quality: Can callers use this interface correctly without knowing implementation details?

Cross-Module Analysis

Ask before concluding:

  • Are there related modules that should be reviewed together? Classitis often hides across file boundaries.
  • Would combining these modules simplify the overall interface? If yes, flag as potential shallow split.
  • Must callers use these modules in sequence? If yes, possible temporal decomposition.

Pattern Consistency Check

QuestionIf Yes
Is there an existing pattern for this type of problem?Compare approaches
Does this introduce a second way to do the same thing?Flag unless justified
Would a maintainer be surprised by the difference?Requires explicit documentation

Balance: Evaluate patterns on merit, but don't create gratuitous inconsistency. The goal is maintainability, not conformance.


When Principles Conflict

ConflictResolution
Depth vs CohesionPrefer cohesion. A focused shallow module beats a bloated deep one.
Information Hiding vs TestabilityTesting seams (injectable dependencies) are acceptable "leakage"
Simple Interface vs ConfigurabilityReal systems need configuration; penalize only unnecessary complexity

CHECKER: run the ID'd checklist Read(${CLAUDE_SKILL_DIR}/checklists.md) against the code. CHECKER output: the ID'd checklist is the item set (the tables in this SKILL.md explain the items, they are not counted twice). Report each VIOLATION and WARNING as | Item | Status | Evidence | Location |; do not list passing or non-applicable items — close with one line N items checked, M pass, K n/a. The Evaluation Output Format above is the assessment that wraps that report.

← v1.0.0All versions