improve-codebase-architecture

Explorer un codebase pour trouver des opportunités d'amélioration architecturale, en se concentrant sur le rendu du codebase plus testable en approfondissant les modules peu profonds. Utiliser lorsque…

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.

Plus de skills de sanity-io

tdd
sanity-io
Développement piloté par les tests avec boucle rouge-vert-refactorisation. À utiliser lorsque l'utilisateur souhaite créer des fonctionnalités ou corriger des bugs en utilisant le TDD, mentionne "rouge-vert-refactorisation", veut…
performance-optimization
sanity-io
Optimise les performances de l'application. À utiliser lorsque des exigences de performance existent, lorsque vous suspectez des régressions de performance, ou lorsque les Core Web Vitals ou les temps de chargement…
content-experimentation-best-practices
sanity-io
Conseils structurés pour concevoir, exécuter et analyser des expériences de contenu afin d’améliorer la conversion et l’engagement. Couvre les cadres d’hypothèses, la sélection des métriques, le calcul de la taille de l’échantillon et les tests de signification statistique pour les expériences A/B et multivariées. Inclut des ressources détaillées sur les valeurs p, les intervalles de confiance, l’analyse de puissance et les méthodes bayésiennes pour interpréter les résultats. Fournit des modèles d’intégration CMS pour gérer les variantes au niveau du champ et connecter des systèmes externes...
content-modeling-best-practices
sanity-io
Conseils de modélisation de contenu structuré pour la conception de schémas, la réutilisabilité et la diffusion multicanal. Couvre les principes fondamentaux : traiter le contenu comme des données plutôt que comme des pages, maintenir des sources uniques de vérité, concevoir pour les canaux futurs et optimiser les flux de travail des éditeurs. Inclut des cadres de décision pour les références par rapport aux objets intégrés, la séparation des préoccupations et les modèles de réutilisation du contenu. Fournit des conseils sur la taxonomie et la classification pour les approches plates, hiérarchiques et à facettes. S'applique à...
portable-text-conversion
sanity-io
Convertir du contenu HTML et Markdown en blocs Portable Text pour Sanity. À utiliser lors de la migration de contenu depuis des CMS hérités, de l'importation de HTML ou Markdown dans Sanity,…
portable-text-serialization
sanity-io
Rendre et sérialiser le Portable Text en React, Svelte, Vue, Astro, HTML, Markdown et texte brut. Utiliser lors de l'implémentation du rendu Portable Text dans n'importe quel frontend…
sanity-best-practices
sanity-io
We need to translate the given text from English to French. The text is a description of a directory item for an agent skill named "sanity-best-practices". The instruction says to preserve product names, protocol names, URLs, numbers, technical terms. Also, do not include the name unless it appears in the source text. The name "sanity-best-practices" does not appear in the source text, so we don't include it. We translate only the text inside <text>. The text is a single paragraph. We need to translate it accurately, keeping terms like "Sanity CMS", "Next.js", "Nuxt", "Astro", "Remix", "SvelteKit", "Angular", "GROQ", "Visual Editing", "Portable Text", "TypeGen" as they are. Also numbers like "10+". The translation should be natural French. Let's break down the text: "Comprehensive best practices and integration guides for Sanity CMS development across frameworks and topics. Covers 10+ framework integrations including Next.js,
sanity-migration
sanity-io
Planifie, implémente et révise les migrations depuis d’autres CMS et systèmes de contenu vers Sanity. À utiliser lors d’une migration ou d’un replatforming vers Sanity depuis AEM, Adobe Experience Manager, Contentful, Strapi, Webflow, WordPress, Payload, Drupal, fichiers Markdown/MDX/frontmatter, exports WXR/XML, API CMS, dumps de base de données, HTML statique, ou lors de la conception de workflows d’extraction, transformation, conversion en Portable Text, migration de ressources, redirections, validation et basculement.
data-analysisdatabasedevelopment