improve-codebase-architecture

bởi sanity-io

Khám phá mã nguồn để tìm cơ hội cải thiện kiến trúc, tập trung vào việc làm cho mã nguồn dễ kiểm thử hơn bằng cách đào sâu các module nông. Sử dụng khi…

npx skills add https://github.com/sanity-io/sanity --skill improve-codebase-architecture

Improve Codebase Architecture

Explore a codebase like an AI would, surface architectural friction, discover opportunities for improving testability, and propose module-deepening refactors as GitHub issue RFCs.

A deep module (John Ousterhout, "A Philosophy of Software Design") has a small interface hiding a large implementation. Deep modules are more testable, more AI-navigable, and let you test at the boundary instead of inside.

Process

1. Explore the codebase

Use the Agent tool with subagent_type=Explore to navigate the codebase naturally. Do NOT follow rigid heuristics — explore organically and note where you experience friction:

  • Where does understanding one concept require bouncing between many small files?
  • Where are modules so shallow that the interface is 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?
  • Where do tightly-coupled modules create integration risk in the seams between them?
  • Which parts of the codebase are untested, or hard to test?

The friction you encounter IS the signal.

2. Present candidates

Present a numbered list of deepening opportunities. For each candidate, show:

  • Cluster: Which modules/concepts are involved
  • Why they're coupled: Shared types, call patterns, co-ownership of a concept
  • Dependency category: See REFERENCE.md for the four categories
  • Test impact: What existing tests would be replaced by boundary tests

Do NOT propose interfaces yet. Ask the user: "Which of these would you like to explore?"

3. User picks a candidate

4. Frame the problem space

Before spawning sub-agents, write a user-facing explanation of the problem space for the chosen candidate:

  • The constraints any new interface would need to satisfy
  • The dependencies it would need to rely on
  • A rough illustrative code sketch to make the constraints concrete — this is not a proposal, just a way to ground the constraints

Show this to the user, then immediately proceed to Step 5. The user reads and thinks about the problem while the sub-agents work in parallel.

5. Design multiple interfaces

Spawn 3+ sub-agents in parallel using the Agent tool. Each must produce a radically different interface for the deepened module.

Prompt each sub-agent with a separate technical brief (file paths, coupling details, dependency category, what's being hidden). This brief is independent of the user-facing explanation in Step 4. Give each agent a different design constraint:

  • Agent 1: "Minimize the interface — aim for 1-3 entry points max"
  • Agent 2: "Maximize flexibility — support many use cases and extension"
  • Agent 3: "Optimize for the most common caller — make the default case trivial"
  • Agent 4 (if applicable): "Design around the ports & adapters pattern for cross-boundary dependencies"

Each sub-agent outputs:

  1. Interface signature (types, methods, params)
  2. Usage example showing how callers use it
  3. What complexity it hides internally
  4. Dependency strategy (how deps are handled — see REFERENCE.md)
  5. Trade-offs

Present designs sequentially, then compare them in prose.

After comparing, give your own recommendation: which design you think is strongest and why. If elements from different designs would combine well, propose a hybrid. Be opinionated — the user wants a strong read, not just a menu.

6. User picks an interface (or accepts recommendation)

7. Create GitHub issue

Create a refactor RFC as a GitHub issue using gh issue create. Use the template in REFERENCE.md. Do NOT ask the user to review before creating — just create it and share the URL.

Thêm skills từ sanity-io

tdd
sanity-io
Phát triển hướng theo kiểm thử với vòng lặp đỏ-xanh-tái cấu trúc. Sử dụng khi người dùng muốn xây dựng tính năng hoặc sửa lỗi bằng TDD, đề cập đến "đỏ-xanh-tái cấu trúc", muốn…
performance-optimization
sanity-io
Tối ưu hóa hiệu suất ứng dụng. Sử dụng khi có yêu cầu về hiệu suất, khi nghi ngờ có suy giảm hiệu suất, hoặc khi Core Web Vitals hoặc thời gian tải…
content-experimentation-best-practices
sanity-io
Hướng dẫn có cấu trúc để thiết kế, thực thi và phân tích các thử nghiệm nội dung nhằm cải thiện tỷ lệ chuyển đổi và mức độ tương tác. Bao gồm các khung giả thuyết, lựa chọn chỉ số, tính toán kích thước mẫu và kiểm định ý nghĩa thống kê trong các thử nghiệm A/B và đa biến. Cung cấp tài nguyên chi tiết về giá trị p, khoảng tin cậy, phân tích lũy thừa và phương pháp Bayes để diễn giải kết quả. Cung cấp các mẫu tích hợp CMS để quản lý biến thể ở cấp trường và kết nối bên ngoài...
content-modeling-best-practices
sanity-io
Hướng dẫn mô hình hóa nội dung có cấu trúc cho thiết kế schema, khả năng tái sử dụng và phân phối đa kênh. Bao gồm các nguyên tắc cốt lõi: coi nội dung là dữ liệu thay vì trang, duy trì nguồn thông tin duy nhất, thiết kế cho các kênh trong tương lai và tối ưu hóa quy trình làm việc của biên tập viên. Cung cấp khung quyết định cho tham chiếu so với đối tượng nhúng, phân tách mối quan tâm và các mẫu tái sử dụng nội dung. Cung cấp hướng dẫn về phân loại và phân lớp cho các phương pháp phẳng, phân cấp và khía cạnh. Áp dụng cho...
portable-text-conversion
sanity-io
Chuyển đổi nội dung HTML và Markdown thành các khối Portable Text cho Sanity. Sử dụng khi di chuyển nội dung từ các CMS cũ, nhập HTML hoặc Markdown vào Sanity,…
portable-text-serialization
sanity-io
Kết xuất và tuần tự hóa Portable Text thành React, Svelte, Vue, Astro, HTML, Markdown và văn bản thuần. Sử dụng khi triển khai kết xuất Portable Text trong bất kỳ giao diện người dùng nào…
sanity-best-practices
sanity-io
Các phương pháp thực hành tốt nhất toàn diện và hướng dẫn tích hợp cho phát triển Sanity CMS trên nhiều framework và chủ đề. Bao gồm hơn 10 tích hợp framework bao gồm Next.js, Nuxt, Astro, Remix, SvelteKit và Angular với các mẫu và hướng dẫn thiết lập dành riêng cho từng framework. Bao gồm các hướng dẫn chủ đề về thiết kế schema, tối ưu hóa truy vấn GROQ, Chỉnh sửa trực quan, Văn bản di động, hình ảnh, TypeGen, bản địa hóa và di chuyển nội dung. Cung cấp cấu trúc tham khảo nhanh để chỉ tải các hướng dẫn liên quan dựa trên loại tác vụ,...
sanity-migration
sanity-io
Lập kế hoạch, triển khai và xem xét việc di chuyển từ các CMS và hệ thống nội dung khác sang Sanity. Sử dụng khi di chuyển hoặc chuyển đổi nền tảng sang Sanity từ AEM, Adobe Experience Manager, Contentful, Strapi, Webflow, WordPress, Payload, Drupal, tệp Markdown/MDX/frontmatter, xuất WXR/XML, API CMS, bản sao cơ sở dữ liệu, HTML tĩnh, hoặc khi thiết kế quy trình trích xuất, chuyển đổi, chuyển đổi Portable Text, di chuyển tài sản, chuyển hướng, xác thực và cắt chuyển.
data-analysisdatabasedevelopment