architecture-quality
Keep web applications, APIs and services readable as they grow: choose feature or domain seams, assign state ownership, enforce dependency direction, keep adapters thin, and verify file shape. Use when starting or extending a web app, backend, frontend, API or multi-page product; when a change makes a module hard to read; when architecture review finds a god file, cross-feature imports, a circular dependency or a framework-heavy domain. Load architecture-first first for a new system, and refactoring-safely for an existing oversized module. Do not use for a one-file script, throwaway spike or a purely local naming change.
- License 许可
- MIT
- 最近更新
- 2026-11-14
- Stars
- ★ 214
- Forks
- 32
01 前言 Front Matter
- name
- architecture-quality
- description
- Keep web applications, APIs and services readable as they grow: choose feature or domain seams, assign state ownership, enforce dependency direction, keep adapters thin, and verify file shape. Use when starting or extending a web app, backend, frontend, API or multi-page product; when a change makes a module hard to read; when architecture review finds a god file, cross-feature imports, a circular dependency or a framework-heavy domain. Load architecture-first first for a new system, and refactoring-safely for an existing oversized module. Do not use for a one-file script, throwaway spike or a purely local naming change.
03 SKILL.md 正文
Architecture quality — readable by construction
This skill turns the architecture decision into a small, repeatable delivery
contract. It complements architecture-first; it does not add layers for their own
sake.
Working contract
Before a non-trivial web or service change, record these five facts in
ARCHITECTURE.md or docs/architecture/README.md:
- Feature/domain modules — name them by reason to change, not by a generic
utils,helpersorservicesbucket. - Ownership — each mutable state, database table boundary and external side effect has one owner.
- Dependency direction — policy/domain code is independent of the web framework, ORM, queue and filesystem; adapters point inward through small ports.
- Vertical slice — prove one user-visible path from entry point to state and test before multiplying layers or pages.
- Verification boundary — list the architecture checks and the test command that must remain green after the change.
If the project is a small script or a single-module experiment, state that scope and skip the document. A missing document is a finding only once the project has enough shape to need one, not a reason to create ceremony around a toy.
Web application shape
- Keep routes/controllers thin: parse input, call a use-case or feature API, map the result and return. Do not put business policy, SQL and provider retries in a route.
- Keep domain/use-case code framework-free where practical. Inject ports for storage, clocks, queues and providers; keep concrete adapters at the edge.
- Organize user-facing behavior by feature or bounded context. A page may compose features, but one feature must not reach into another feature's private state.
- Give each page a stable route-level composition boundary. Shared UI primitives are visual primitives, not a second business-logic layer.
- Treat a
utilsorcommonimport that keeps growing as a boundary question. Move code to the module that owns its reason to change; do not create a universal bag. - Prefer a modular monolith until an independently deployable or scalable boundary is proven. A microservice split is not a substitute for a missing internal boundary.
Shape checks
Run the repository audit before broadening a new app and after a structural change:
python "${CLAUDE_PLUGIN_ROOT}/scripts/architecture_audit.py" --root .
The audit is intentionally conservative. It reports, rather than invents, findings:
- a sizeable application with no
ARCHITECTURE.mdor architecture directory; - a source file crossing the calibrated shape thresholds;
- an explicitly declared project marker without a readable architecture anchor.
The live module-shape-advisor.py hook repeats the file-shape check after
Write|Edit|MultiEdit in both Codex and Claude. It is advisory: acknowledge the
finding, split at an ownership boundary, or record why the file is intentionally
large. CLAUDE_ALLOW_BIG_MODULES=1 is an explicit, reviewable escape hatch, not a
default.
For dependency rules, use the tool native to the stack when the project has earned it:
- Python:
import-lintercontracts for allowed import direction; - JavaScript/TypeScript:
dependency-cruiserfor cycles, orphans and forbidden folder edges; - Java:
ArchUnitarchitecture tests alongside unit tests; - C/C++: compiler/include tooling plus explicit CMake target boundaries; do not infer a domain architecture from a raw include graph alone.
Do not install all four. Pick one boundary mechanism, commit its rules, and run it in the same CI lane as the tests that prove the behavior.
Review questions
- Can a new feature be changed without editing an unrelated feature's internals?
- Does a route, page or controller own policy that belongs inside a use-case/domain?
- Is state ownership named, or are modules reaching into shared mutable objects?
- Are imports crossing a documented boundary? If yes, is the exception recorded with a reason and expiry?
- Is the file becoming large because one change is crossing multiple reasons to change? If yes, split the seam before adding more behavior.
- Did the change update the architecture document and the focused architecture/test evidence together?
Gotchas
- Folders are not boundaries. Moving files without changing imports or ownership only makes the same coupling harder to see.
- Thin controllers can still hide a fat service. Inspect the next boundary; a
generic
ApplicationServiceis often a god module with a nicer name. - A metric is a signal, not a verdict. Generated code, migrations and large declarative tables need explicit exemptions; production logic needs an explanation before an exemption.
- Microservices can multiply unreadability. Network boundaries add failure, deployment and observability costs; prove the module boundary first.
Troubleshooting
| Symptom | Likely cause | Action |
|---|---|---|
| The audit reports a missing architecture anchor | An app marker and several source files exist, but the boundary is implicit | Write the small module/ownership/dependency map before adding more features |
module-shape-advisor reports a large file |
Local edits accumulated in one ownership boundary | Add characterization tests, split one named slice, then rerun the audit |
| A cycle appears | Two modules own part of the same concept or one imports an implementation detail | Move the concept behind an inner port or extract a genuinely shared concept |
| Every change touches many folders | Layer-first layout scatters a feature across technical layers | Recut the next slice by feature; migrate incrementally with tests |
| The guard is noisy on generated code | The file is outside the built-in exemption list | Add a narrow, documented project exemption; do not silence the whole hook |
04 同仓库更多 Skills
owner-voice
暂无简介
humanize-russian
Редактировать русский текст для ясности и естественного звучания, сохраняя факты, термины, источники и жанр. Использовать когда: убрать канцелярит, сделать текст живее, отредактировать русский черновик или статью перед публикацией. Не определяет авторство и не обещает обход детекторов. Для английского — humanize-english; для структуры и доказательств — article-structure-review.
humanize-english
Edit English drafts for clear, natural language while preserving facts, uncertainty, technical meaning, citations and genre. Use when: humanize this text, remove AI-style filler, improve English prose, or edit an English article before publication. Not an authorship detector or a promise to bypass one. For Russian use humanize-russian; for thesis/evidence and structure use article-structure-review.
caveman
Ultra-compressed reply mode. Cuts output tokens ~65-75% by answering in terse "caveman" style while keeping full technical accuracy, and shapes what survives: action first, state restated every turn, concrete time estimates, visible wins. Intensity levels: lite, full (default), ultra, wenyan-lite, wenyan-full, wenyan-ultra. Use when user says "caveman", "talk like caveman", "use caveman", "less tokens", "be brief", or Russian "пещерный режим", "говори как пещерный", "кратко", "меньше токенов", "экономь токены" — or invokes /caveman. Preserves the user's language (Russian in → Russian caveman out). Off only: "stop caveman" / "normal mode" / "обычный режим". Do not use merely because a response should be concise, and do not use when the user requests normal prose, a polished document, or exact wording.
article-structure-review
Проверить структуру технической статьи после черновика: задача читателя, жанр, опора значимых утверждений на доказательства и честные ограничения. Use after the first draft, before publication. Исправлять структуру, когда это входит в запрос; не создавать обязательный конвейер из других навыков. Для локальной языковой редактуры — humanize-english или humanize-russian.
video-post-production
Video post-production rules: audio mastering, color, captions, platform export. Use when: 'add music', 'add voiceover', 'export for tiktok', 'add captions', 'color grade', 'audio levels', 'master audio', 'export settings', 'platform requirements'. Covers FFmpeg patterns, audio chain, subtitle standards, and platform-specific export configs. Do NOT use to generate or animate the video frames/scenes in code (use remotion-production-guide), to write the script (use video-narrative-arc), or to evaluate script quality (use script-evaluator); this is the finishing stage applied to an already-rendered video.