improve-codebase-architecture

Analyze codebase modules and seams to generate HTML architecture review reports.

Updated Dec 11, 2024
One-click install
npx skills add https://github.com/huaxel/dotfiles --skill improve-codebase-architecture-huaxel
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: improve-codebase-architecture
Source: https://github.com/huaxel/dotfiles/tree/main/skills/improve-codebase-architecture
Command: npx skills add https://github.com/huaxel/dotfiles --skill improve-codebase-architecture-huaxel

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Surface and surface architectural friction in codebases and surface opportunities to deepen modules for improved testability and AI-navigability.

Core Features & Use Cases

  • Identify shallow modules, external seams, and potential adapters to reduce coupling.
  • Generate self-contained HTML architecture-review reports with before/after visuals and top recommendations.
  • Provide a structured plan to guide grilling loops and ADR considerations, referencing CONTEXT.md vocabulary and project glossaries.

Quick Start

Ask to generate an architecture review for the target repository or module, then review the candidate deepening options.

Frequently Asked Questions about improve-codebase-architecture

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I identify architectural friction and shallow modules in my codebase?

An architecture review analyzes modules, seams, and adapters to identify architectural friction and shallow modules. It surfaces deepening opportunities to reduce coupling and improve testability and AI-navigability.

What is the best way to generate an architecture review report with before and after visuals?

Generating a self-contained HTML architecture review report provides before/after visuals and top recommendations. This structured output references project glossaries and safety constraints to guide iterative deepening and ADR considerations.

How do I reduce coupling in software modules using adapters and seams?

Reducing coupling involves analyzing external seams and identifying potential adapters to deepen shallow modules. This architectural refactoring isolates dependencies, which significantly improves module testability and structural separation.

Can I use an architecture analysis report to guide refactoring loops and ADR considerations?

Yes, an architecture analysis report provides a structured plan to guide refactoring loops and Architecture Decision Records. It respects CONTEXT.md vocabulary and project glossaries to deliver actionable deepening candidates for iteration.

When should I not use automated architecture analysis for module deepening?

Automated architecture analysis should be avoided when a codebase lacks established CONTEXT.md vocabulary or project glossaries. Without these safety constraints and structural references, the generated deepening recommendations may misalign with existing architectural patterns.