codebase-design SKILL.md skillA

codebase-design from mxyhi/ok-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add mxyhi/ok-skills/codebase-design@git:20260831.e7f2564

Pins git:20260831.e7f2564 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
mxyhi/ok-skills
Path
codebase-design/SKILL.md
Versions recorded
2
Latest version
git:20260831.e7f2564, committed Aug 31, 2026
First version recorded
Jun 18, 2026
Size
6,446 bytes
Repository stars
500
License
Apache-2.0

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 or AI-navigable, or when another skill needs the deep-module vocabulary.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# Codebase Design

Design **deep modules**: a lot of behaviour behind a small interface, placed at a clean seam, testable through that interface. Use this language and these principles wherever code is being designed or restructured. The aim is leverage for callers, locality for maintainers, and testability for everyone.

## Glossary

Use these terms exactly: don't substitute "component," "service," "API," or "boundary." Consistent language is the whole point.

**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, they refer only to the type-level surface).
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add mxyhi/ok-skills/codebase-design@sha256:2c20617f87ec8af6

The line at the top of this page pins the label git:20260831.e7f2564, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_wb5dphfswr2hjeq4.svg)](https://markdownregistry.com/a/art_wb5dphfswr2hjeq4)

4 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 2 versions of this file, between Jun 18, 2026 and Aug 31, 2026, about one every 74 days.

versioncommittedcommitsizeaudit
git:20260831.e7f2564 latest2026-08-31 e7f2564 6,446 BA view · diff
git:20260618.e4bc6a22026-06-18 e4bc6a2 6,488 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (6446 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

mxyhi/ok-skills · 500 stars · license Apache-2.0 · pushed 2026-10-18 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_wb5dphfswr2hjeq4
GET https://markdownregistry.com/api/v1/resolve?ref=mxyhi/ok-skills/codebase-design
GET https://markdownregistry.com/api/v1/blob/2c20617f87ec8af6a434859f381b2f061a69b530444e74eb39e78bb016a6d1e2

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from mxyhi/ok-skills

AGENTS.md AGENTS.md file
mxyhi/ok-skills · AGENTS.md
git:20260925.7de4640 · audit A · 500 stars
agent-browser SKILL.md skill
mxyhi/ok-skills · agent-browser/SKILL.md · Browser automation CLI for AI agents. Use when the user needs to interact with websites, including navigating pages…
git:20260831.972d952 · audit A · 500 stars
ai-elements SKILL.md skill
mxyhi/ok-skills · ai-elements/SKILL.md · Build AI chat interfaces using ai-elements components — conversations, messages, tool displays, prompt inputs, and…
git:20260314.07e5678 · audit A · 500 stars
autoresearch SKILL.md skill
mxyhi/ok-skills · autoresearch/SKILL.md · Autonomous iteration loop: modify, verify, keep/discard against any metric
v2.2.2 · audit A · 500 stars
ax SKILL.md skill
mxyhi/ok-skills · ax/SKILL.md · Use the ax CLI instead of curl + throwaway parsing scripts whenever you fetch a URL, explore an unknown web page, or…
git:20260731.b493166 · audit A · 500 stars
better-icons SKILL.md skill
mxyhi/ok-skills · better-icons/SKILL.md · Use when working with icons in any project. Provides CLI for searching 200+ icon libraries (Iconify) and retrieving…
git:20260415.87a17fa · audit A · 500 stars
bopomofo-rescue SKILL.md skill
mxyhi/ok-skills · bopomofo-rescue/SKILL.md · Detect and recover text that was accidentally typed with the Taiwanese Bopomofo / Zhuyin (注音) keyboard while the input…
git:20261018.2c986bf · audit A · 500 stars
browser-trace SKILL.md skill
mxyhi/ok-skills · browser-trace/SKILL.md · Capture a full DevTools-protocol trace of any browser automation — CDP firehose, screenshots, and DOM dumps — then…
git:20260517.ccd356a · audit A · 500 stars
deep-research SKILL.md skill
mxyhi/ok-skills · deep-research/SKILL.md · Professional deep research report generation — multi-agent collaboration with parallel chapter writing, automatic…
v6.0.0 · audit A · 500 stars
diagnosing-bugs SKILL.md skill
mxyhi/ok-skills · diagnosing-bugs/SKILL.md · Diagnosis loop for hard bugs and performance regressions. Use when the user says "diagnose"/"debug this", or reports…
git:20261009.b4e20e9 · audit A · 500 stars
domain-modeling SKILL.md skill
mxyhi/ok-skills · domain-modeling/SKILL.md · Build and sharpen a project's domain model. Use when discussing codebase terminology, writing or editing a GLOSSARY.md…
git:20260930.4ade426 · audit A · 500 stars
exa-search SKILL.md skill
mxyhi/ok-skills · exa-search/SKILL.md · Use Exa MCP for current web, code/docs, company, people, and page-fetch research. Prefer current hosted tool schemas…
git:20260905.9d9dd2c · audit A · 500 stars

Every file in mxyhi/ok-skills

Other files named codebase-design

codebase-design SKILL.md skill
danny-avila/librechat · .claude/skills/codebase-design/SKILL.md · Shared vocabulary for designing deep modules. Use when the user wants to design or improve a module's interface, find…
git:20260812.ee8c0ab · audit A · 46,090 stars
codebase-design SKILL.md skill
librechat-ai/librechat · .claude/skills/codebase-design/SKILL.md · Shared vocabulary for designing deep modules. Use when the user wants to design or improve a module's interface, find…
git:20260812.ee8c0ab · audit A · 46,149 stars
codebase-design SKILL.md skill
vinvcn/mattpocock-skills-zh-cn · skills/engineering/codebase-design/SKILL.md · 用于设计深模块的共享词汇。适用于用户想设计或改进模块接口、寻找深化机会、决定 seam 放在哪里、让代码更容易测试或更适合 AI 导航,或其他技能需要深模块词汇时。
git:20261008.5be0dc1 · audit A · 5,110 stars
codebase-design SKILL.md skill
dcouple/pane · main/src/services/paneChatBundle/skills/codebase-design/SKILL.md · Shared vocabulary for designing deep modules. Use when the user wants to design or improve a module's interface, find…
git:20260924.17234b5 · audit A · 562 stars
codebase-design SKILL.md skill
greenfield-inc/pane · main/src/services/paneChatBundle/skills/codebase-design/SKILL.md · Shared vocabulary for designing deep modules. Use when the user wants to design or improve a module's interface, find…
git:20260924.17234b5 · audit A · 575 stars
codebase-design SKILL.md skill
kunolu/640-skills · sbtd-workflow-onboard/assets/external-skills/stable/skills/codebase-design/SKILL.md · Shared vocabulary for designing deep modules. Use when the user wants to design or improve a module's interface, find…
git:20260827.561ec6a · audit A · 555 stars
codebase-design SKILL.md skill
asymmetric-al/core · .agents/skills/codebase-design/SKILL.md · Shared vocabulary for designing deep modules. Use when the user wants to design or improve a module's interface, find…
git:20260923.15c9348 · audit A · 379 stars
codebase-design SKILL.md skill
romiluz13/cc10x · plugins/cc10x/skills/codebase-design/SKILL.md · Canonical deep-module vocabulary (module, interface, depth, seam, adapter, leverage, locality) for designing a module's…
git:20261007.bdeaedb · audit A · 165 stars

Browse by kind, by grade A, or by owner.