agentleFS
syangasyanga/astack/skills/improve-codebase-architecture/SKILL.md

improve-codebase-architecture

Skill0 starsChanged 53 days agoMITView on GitHub

Scan a codebase for deepening opportunities, present them as a visual HTML report, then grill through whichever one you pick.

195 other projects use a version of this, 156 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use migrate-to-shoehorn, writing-beats and 9 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • simo97Skill

    migrate-to-shoehorn

    Migrate test files from `as` type assertions to @total-typescript/shoehorn. Use when user mentions shoehorn, wants to replace `as` in tests, or needs partial test data.

    Also in 73 projects that use this

  • LesaniSkill

    writing-beats

    Shape an article as a journey of beats, choose-your-own-adventure style. The user picks a starting beat from the raw material, you write only that beat, then offer options for where to pivot next, beat by beat, until the article reaches a natural end. Use when the user has raw material and wants to assemble it as a narrative rather than an argument.

    Also in 68 projects that use this

  • simo97Skill

    request-refactor-plan

    Use this skill when user wants to create a refactor plan.

    Also in 43 projects that use this

  • liufeng1976Skill

    setup-ts-deep-modules

    Wire dependency-cruiser into a TypeScript repo so each package is a deep module — implementation hidden in subfolders, reachable only through its entry-point files. User-invoked.

    Also in 43 projects that use this

  • FabienDehopreSkill

    decision-mapping

    Turn a loose idea into a sequenced map of investigation tickets, then drive them to resolution one at a time.

    Also in 8 projects that use this

  • LesaniSkill

    writing-shape

    Take a markdown file of raw material and shape it into an article through a conversational session — drafting candidate openings, growing the piece paragraph by paragraph, arguing about format (lists, tables, callouts, quotes) at each step. Use when the user has a pile of notes, fragments, or a rough draft and wants help turning it into something publishable.

    Also in 65 projects that use this

  • +2 more from simo97

The file

We split this skill into the rules it gives an agent

9 rules. 2 are common, 7 are distinctive, and 0 are very specific to this project.

  • 2

    Common

    Most of the 184 edited versions we read keep these.

  • 7

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    If the user named a direction (a module, a subsystem, a pain point), take it, and skip the inference below.

    line 22
  2. Common:

    Read the project's domain glossary and any ADRs in the area you're touching first, when available.

    line 25
  3. Distinctive:

    Read Minimize Reader Load, Laziness Protocol, and Subtract Before You Add to judge which candidates are worth pursuing.

    line 37
  4. Distinctive:

    Write a self-contained HTML report with before/after visualizations, following HTML-REPORT.md.

    line 41
  5. Common:

    Do NOT propose interfaces yet.

    line 45
  6. Distinctive:

    Read Model the Domain and Foundational Thinking when deciding what the module owns.

    line 51
  7. Distinctive:

    Follow domain-modeling as terms and decisions resolve, passing along any identified glossary and ADR locations.

    line 53
  8. Distinctive:

    If the user wants to explore alternative interfaces for the deepened module, follow Design It Twice.

    line 55
  9. Distinctive:

    When the user authorizes implementation of a behavior-preserving change, hand the chosen design to refactoring.

    line 57

“Common” is measured: kept by at least 6 in 10 of the 184 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Improve codebase architecture

Surface architectural friction and propose deepening opportunities: refactors that turn shallow modules into deep ones. The aim is testability and AI-navigability.

This command is informed by the project's domain model and built on a shared design vocabulary:

  • Read Deep Modules for the architecture vocabulary (module, interface, depth, seam, adapter, leverage, locality) and its principles (the deletion test, "the interface is the test surface", "one adapter = hypothetical seam, two = real"). Use these terms exactly in every suggestion, and don't drift into "component," "service," or "API."
  • The project's domain glossary, such as CONTEXT.md, gives names to good seams; its ADRs record decisions this command should not re-litigate.

Process

1. Explore

Scope before you scan: YAGNI. Deepening a module pays off by making future changes to it easier, so put extra weight on the parts of the codebase that have recently changed. Decide where to look before you look:

  • If the user named a direction (a module, a subsystem, a pain point), take it, and skip the inference below.
  • Otherwise, walk back a good stretch of the commit history (git log --oneline) to find the codebase's hot spots, the files and areas that keep coming up, and let those paths pull your attention first. If the changes are scattered with no clear hot spot, widen the net.

Read the project's domain glossary and any ADRs in the area you're touching first, when available.

Then spawn a sub-agent to walk the codebase, with the scope, domain vocabulary, and principle guidance below. Don't follow rigid heuristics; explore organically and note where you experience friction:

  • Where does understanding one concept require bouncing between many small modules?
  • Where are modules shallow, with an interface nearly as complex as the implementation?
  • Where have pure functions been extracted just for testability, but the real bugs hide in how they're called (no locality)?
  • Where do tightly-coupled modules leak across their seams?
  • Which parts of the codebase are untested, or hard to test through their current interface?

Apply the deletion test from Deep Modules to anything you suspect is shallow.

Read Minimize Reader Load, Laziness Protocol, and Subtract Before You Add to judge which candidates are worth pursuing.

2. Present candidates as an HTML report

Write a self-contained HTML report with before/after visualizations, following HTML-REPORT.md. In T3 Code, deliver it through t3-preview. Elsewhere, open it for the user and report the absolute path.

ADR conflicts: if a candidate contradicts an existing ADR, only surface it when the friction is real enough to warrant revisiting the ADR. Mark it clearly in the candidate section (e.g. a warning callout: "contradicts ADR-0007, but worth reopening because…"). Don't list every theoretical refactor an ADR forbids.

Do NOT propose interfaces yet. After the file is written, ask the user: "Which of these would you like to explore?"

3. Grilling loop

Once the user picks a candidate, follow grilling to walk the decision tree with them: constraints, dependencies, the shape of the deepened module, what sits behind the seam, what tests survive.

Read Model the Domain and Foundational Thinking when deciding what the module owns. For representation and validation choices, read Boundary Discipline and Type System Discipline. For shared writes or retry behavior, read Separate Before Serializing Shared State or Make Operations Idempotent, respectively.

Follow domain-modeling as terms and decisions resolve, passing along any identified glossary and ADR locations. Apply its ADR criteria to rejected candidates as well.

If the user wants to explore alternative interfaces for the deepened module, follow Design It Twice.

When the user authorizes implementation of a behavior-preserving change, hand the chosen design to refactoring. A change to observable behavior belongs in implement. Reuse the decisions and evidence from this exploration.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.