architecture-docs

Generate version-controlled Mermaid architecture diagrams for microservice systems.

4|1|Updated Mar 15, 2026
One-click install
npx skills add https://github.com/FaysilAlshareef/dotnet-ai-kit --skill architecture-docs-faysilalshareef
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: architecture-docs
Source: https://github.com/FaysilAlshareef/dotnet-ai-kit/tree/main/skills/docs/architecture-docs
Command: npx skills add https://github.com/FaysilAlshareef/dotnet-ai-kit --skill architecture-docs-faysilalshareef

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill removes ambiguity and drift in system architecture documentation by providing reusable Mermaid diagram patterns, service topology templates, and event/data flow guidance so diagrams stay editable, version-controlled, and aligned with the codebase.

Core Features & Use Cases

  • Mermaid diagram templates for system overviews, service topology, sequence/event flows, data flow, and infrastructure.
  • Service topology tables mapping services to responsibilities, databases, and communication channels for onboarding and design reviews.
  • Detection & update patterns to find existing architecture docs and merge new services or event flows into the documentation.
  • Use Case: Produce a complete architecture overview for a CQRS + Event Sourcing microservice system, including mermaid graphs and a service table for developer documentation.

Quick Start

Generate a Mermaid system architecture overview for the Orders domain showing services, event flows, data stores, and infrastructure components.

Frequently Asked Questions about architecture-docs

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

FAQPage Schema
How do I create version-controlled architecture diagrams for microservices?

You can create version-controlled architecture diagrams by generating editable Mermaid syntax and service topology tables directly in markdown, ensuring your documentation stays aligned with the codebase and tracks changes through version control.

What is the best way to document event flow in a CQRS system?

Documenting event flow in a CQRS system is best handled by generating Mermaid sequence diagrams and graph visualizations that map service responsibilities, communication channels, and data stores within a structured service table.

Can I generate infrastructure diagrams for Azure and .NET deployments using Mermaid?

Yes, you can generate infrastructure diagrams for Azure and .NET deployments by applying Mermaid diagram templates to map your service topology, data flows, and infrastructure components directly into version-controlled markdown files.

How do I update existing architecture documentation when new services are added?

You can update existing architecture documentation by applying detection patterns to find current docs and merging new services or event flows into the editable Mermaid diagrams and service topology tables without starting from scratch.

Does this approach work for visualizing data flow alongside service topology?

Yes, this approach works for visualizing data flow alongside service topology by generating dedicated Mermaid diagrams for data flow and mapping services to their respective databases and communication channels in a comprehensive table format.