mcaf-architecture-overview

Generate Mermaid architecture diagrams and dependency rules in docs/Architecture/Overview.md.

52|6|Updated Dec 1, 2025

Search Tags:#architecture #documentation #onboarding #refactoring #mermaid #diagrams

Ready to run

npx skills add https://github.com/managedcode/MCAF --skill mcaf-architecture-overview

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: mcaf-architecture-overview
Source: https://github.com/managedcode/MCAF/tree/main/skills/mcaf-architecture-overview
Command: npx skills add https://github.com/managedcode/MCAF --skill mcaf-architecture-overview

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams create and maintain a single source of truth for the repository's architecture by generating and updating Mermaid diagrams that map system boundaries, modules, interfaces, dependencies, and key classes.

Core Features & Use Cases

Mermaid diagrams for system/module maps, interfaces/contracts, and key classes/types.
Clear boundaries and dependency rules to guide architectural decisions.
Linkage to ADRs and Features for traceability and onboarding.

Quick Start

Update docs/Architecture/Overview.md by adding or adjusting Mermaid diagrams to reflect current system/module boundaries, interfaces, and key classes, and ensure explicit dependency rules.

Frequently Asked Questions about mcaf-architecture-overview

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

FAQPage Schema

How do I generate Mermaid diagrams for my repository architecture documentation?▼

You can generate Mermaid diagrams for repository architecture by automating the creation of system/module maps, interfaces, and key classes, outputting a single Overview.md file with clear boundaries and explicit dependency rules.

What is the best way to maintain architecture overview documentation during refactoring?▼

Maintaining architecture overview documentation during refactoring involves updating Mermaid diagrams to reflect shifting module boundaries, interfaces, and dependency rules, while preserving links to related ADRs and Features for traceability.

Do I need repository write access to automate module boundary and diagram generation?▼

Yes, automating module boundary and diagram generation requires repository write access to output the updated docs/Architecture/Overview.md file containing the Mermaid diagrams and explicit dependency rules.

Can I link architecture diagrams to ADRs and Features for onboarding purposes?▼

Yes, you can link architecture diagrams to ADRs and Features to support onboarding. The generated Overview.md includes Mermaid diagrams for system maps and key classes with direct traceability to related decisions.

How does automating system and module maps help with onboarding new developers?▼

Automating system and module maps streamlines onboarding by providing new developers with a single source of truth. The generated Mermaid diagrams visualize interfaces, key classes, and dependency rules, reducing ramp-up time.

What are the limitations of using Mermaid diagrams for architecture overviews?▼

Mermaid diagrams for architecture overviews are limited to visualizing module boundaries, interfaces, and key classes within a single Overview.md file. They require manual updates if architectural changes occur outside the automated generation process.