maintain-architecture-map

Scan codebase structures and generate ARCHITECTURE_MAP.md documentation.

Updated Apr 23, 2024
One-click install
npx skills add https://github.com/dudusoar/VRP-Toolkit --skill maintain-architecture-map
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: maintain-architecture-map
Source: https://github.com/dudusoar/VRP-Toolkit/tree/main/.claude/skills/maintain-architecture-map
Command: npx skills add https://github.com/dudusoar/VRP-Toolkit --skill maintain-architecture-map

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintains up-to-date architecture documentation by syncing ARCHITECTURE_MAP.md with the latest codebase.

Core Features & Use Cases

  • Automatically scans module structure, entry points, and dependencies to populate ARCHITECTURE_MAP.md.
  • Generates and updates sections like System Overview, Three-Layer Architecture, Module Guide, Entry Points, Data Flows, and Dependencies.
  • Use this skill when adding new modules, refactoring architecture, or preparing for a design review.

Quick Start

Run the architecture scan to refresh ARCHITECTURE_MAP.md after code changes.

Frequently Asked Questions about maintain-architecture-map

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

FAQPage Schema
How do I keep architecture documentation synchronized with my codebase after refactoring?

Architecture documentation stays synchronized by scanning the codebase structure to automatically generate and populate sections of ARCHITECTURE_MAP.md, including module maps, entry points, and data flows.

What is the best way to document module dependencies and data flows for a design review?

Documenting module dependencies and data flows for a design review is best handled by generating an ARCHITECTURE_MAP.md that cross-links module guides and data-flow diagrams. This ensures system structure is communicated clearly to stakeholders.

Can I automatically generate an architecture map for onboarding sessions?

Yes, you can automatically generate an architecture map for onboarding sessions. The process scans repository-wide module structures and dependencies to populate ARCHITECTURE_MAP.md, ensuring new team members understand the system structure clearly.

Does this approach work for maintaining documentation across a repository with multiple modules?

Yes, this approach works for maintaining documentation across a repository with multiple modules. It applies template-driven documentation to refresh the System Overview, Three-Layer Architecture, and Module Guide sections across the entire repository.

When do I need to regenerate the architecture map for my repository?

You need to regenerate the architecture map when adding new modules, refactoring the architecture, or preparing for a design review. Running the architecture scan after code changes ensures ARCHITECTURE_MAP.md stays up-to-date.