mcaf-architecture-overview

Create or update docs/Architecture/Overview.md with Mermaid diagrams mapping boundaries, dependencies, and contracts.

20|Updated Feb 1, 2026
One-click install
npx skills add https://github.com/Zendevve/opentweak --skill mcaf-architecture-overview-zendevve
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mcaf-architecture-overview
Source: https://github.com/Zendevve/opentweak/tree/main/.codex/skills/mcaf-architecture-overview
Command: npx skills add https://github.com/Zendevve/opentweak --skill mcaf-architecture-overview-zendevve

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Create or update docs/Architecture/Overview.md with Mermaid diagrams to map boundaries, dependencies, and contracts.

Core Features & Use Cases

  • Mermaid diagrams for system/module map, interfaces/contracts map, and key classes/types map.
  • Documentation of dependency rules and ADR references.
  • Use when onboarding, refactoring, or adding modules/boundaries to orient teams.

Quick Start

Open docs/Architecture/Overview.md and begin updating the Mermaid diagrams to reflect the current boundaries and dependencies.

Frequently Asked Questions about mcaf-architecture-overview

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

FAQPage Schema
How do I create architecture maps with Mermaid diagrams for onboarding?

You create architecture maps for onboarding by generating docs/Architecture/Overview.md with Mermaid diagrams. This maps boundaries, dependencies, and contracts to establish a shared architecture overview for teams.

What is the best way to document module boundaries and dependencies during refactoring?

The best way to document module boundaries during refactoring is updating Overview.md with Mermaid diagrams. This ensures dependencies use real names with explicit links and references relevant ADRs.

Can I map system interfaces and contracts using Mermaid diagrams?

Yes, you can map system interfaces and contracts using Mermaid diagrams. The architecture overview generates specific diagrams for the system/module map, interfaces/contracts map, and key classes/types map.

Does this architecture documentation approach link to existing ADRs and features?

Yes, architecture documentation explicitly links to ADRs and features. It ensures diagrams use real names with explicit links while documenting dependency rules and ADR references.

When should I update my architecture overview documentation?

You should update architecture overview documentation when onboarding, refactoring, or adding modules and boundaries. This orients teams and maintains a shared architecture map reflecting current system contracts.

How to start documenting dependency rules in Markdown for module boundary changes?

Start documenting dependency rules by opening docs/Architecture/Overview.md and updating the Mermaid diagrams. This reflects current boundaries and dependencies while establishing explicit dependency rules.