skills.rest
ClearMeasureLabs
ClearMeasureLabsOFFICIAL
Explore all skills by this author →
WebsiteGitHub

codebase-cartography-audit

Audit codebases for architectural violations, technical debt, and maintainability risks.

3|2|Updated Aug 1, 2025
Search Tags:#architecture#refactoring#audit#metrics#technical-debt#c4-model
One-click install
npx skills add https://github.com/ClearMeasureLabs/bootcamp-palermo-workorders --skill codebase-cartography-audit
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: codebase-cartography-audit
Source: https://github.com/ClearMeasureLabs/bootcamp-palermo-workorders/tree/main/.claude/skills/codebase-cartography-audit
Command: npx skills add https://github.com/ClearMeasureLabs/bootcamp-palermo-workorders --skill codebase-cartography-audit

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires scc, dotnet-script, plantuml, jscpd, roslynator, and includes references (resource) components.

What problem does it solve?

This Skill solves the "black box" problem of inherited or AI-generated codebases by providing a rigorous, evidence-based audit that maps architecture, measures technical debt, and prioritizes refactoring.

Core Features & Use Cases

  • Measured Metrics: Automatically calculates LOC, cyclomatic complexity, and linting/duplication stats using industry-standard CLI tools.
  • Architecture Mapping: Generates five C4-PlantUML diagrams to visualize logical, runtime, and dependency structures.
  • Economic Valuation: Estimates refactoring effort and replacement cost using Capers Jones productivity bands.
  • Use Case: Use this when you take over a new project and need to present a defensible, data-backed refactoring roadmap to stakeholders.

Quick Start

Run the codebase cartography audit on the current directory to generate a self-contained report with metrics and architecture diagrams.

Frequently Asked Questions about codebase-cartography-audit

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

FAQPage Schema
How do I audit an inherited codebase for technical debt and architecture violations?▼

To audit an inherited codebase for technical debt, you can run an automated cartographic audit that analyzes project structure, dependency direction, and code complexity. It generates C4-PlantUML diagrams and a prioritized refactoring backlog.

What is the best way to map software architecture and visualize dependency direction?▼

Mapping software architecture and visualizing dependency direction is best achieved by generating C4-PlantUML diagrams. This process visualizes logical, runtime, and dependency structures into a self-contained report directory for stakeholder review.

Can I measure code complexity and duplication using automated CLI tools?▼

Yes, you can measure code complexity and duplication using automated CLI tools. The audit calculates lines of code, cyclomatic complexity, and linting duplication stats to quantify maintainability risks and technical debt.

How do I estimate refactoring effort and replacement cost for technical debt?▼

To estimate refactoring effort and replacement cost, the audit applies Capers Jones productivity bands to measure function point sizing. This provides an economic valuation to help you present a defensible, data-backed refactoring roadmap.

Do I need specific dependencies to generate C4 diagrams and codebase metrics?▼

Generating C4 diagrams and codebase metrics requires specific dependencies including scc, dotnet-script, plantuml, jscpd, and roslynator. These tools automate the measurement of lines of code, duplication, and architectural analysis.

When do I need a codebase cartography audit for a new project?▼

You need a codebase cartography audit when taking over a new or AI-generated project that acts as a black box. It provides an evidence-based assessment of architectural violations and maintainability risks to build a prioritized refactoring backlog.

Related Skills

Explore More Software Engineering Skills→
Postpartum-genushyacinthus29Postpartum-genushyacinthus29
8

dotnet-roslynator

Configure Roslynator analyzers and CLI for C# static analysis.

Community
Advanced
nilecuinilecui
27

architecture-diagrams

Generate system architecture diagrams using Mermaid and PlantUML syntax.

Community
Intermediate
uukuguyuukuguy
1

issue-detection

Detect code issues across security, quality, performance, and maintainability dimensions.

Community
Advanced
gmh5225gmh5225
868

llvm-tooling

Create LLVM/Clang-based tools for source analysis, transformation, and IDE integration.

Community
Advanced