skills.rest
Foo-x
Foo-xCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

architecture-md-generator

Generate ARCHITECTURE.md files with Mermaid diagrams from project structure and dependencies.

2|1|Updated Feb 2, 2019
Search Tags:#architecture#documentation#markdown#mermaid#code generation#project analysis
One-click install
npx skills add https://github.com/Foo-x/dotfiles --skill architecture-md-generator
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: architecture-md-generator
Source: https://github.com/Foo-x/dotfiles/tree/main/claude/skills/architecture-md-generator
Command: npx skills add https://github.com/Foo-x/dotfiles --skill architecture-md-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of comprehensive architecture documentation for projects, saving significant manual effort and ensuring consistency.

Core Features & Use Cases

  • Automated Documentation: Generates an ARCHITECTURE.md file by analyzing project structure and metadata.
  • Diagram Generation: Creates system diagrams using Mermaid syntax.
  • Use Case: When onboarding a new team member or preparing for a project audit, use this Skill to quickly generate up-to-date architecture documentation that includes system diagrams, external dependencies, and code structure.

Quick Start

Run the architecture-md-generator skill on the current project directory.

Frequently Asked Questions about architecture-md-generator

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

FAQPage Schema
How do I automatically generate architecture documentation for an existing project?▼

You can generate architecture documentation by running this Skill on your project directory to analyze structure and dependencies, outputting a complete ARCHITECTURE.md file automatically.

What is the best way to create Mermaid diagrams for a codebase?▼

Creating Mermaid diagrams for a codebase is done by analyzing project structure and dependencies to automatically generate system diagrams within your architecture documentation.

Can I generate architecture documentation for a full-stack application with both backend APIs and frontend SPAs?▼

Yes, architecture documentation generation supports full-stack applications by analyzing and documenting both backend APIs and frontend SPAs within the same project structure.

How do I list external services and dependencies in markdown format?▼

To list external services in markdown format, the Skill analyzes project dependencies and metadata to automatically extract and document all external service integrations in the output file.

Does this architecture documentation generator require any specific dependencies or setup?▼

This architecture documentation generator requires no external dependencies, allowing you to run it directly on your project directory to analyze metadata and generate the markdown output.

When should I use an automated architecture documentation generator instead of writing docs manually?▼

Use an automated architecture documentation generator when onboarding new team members or preparing project audits, as it ensures documentation consistency and saves significant manual effort.

Related Skills

Explore More Software Engineering Skills→
shin0720shin0720

auto-setup

Generate ARCHITECTURE.md and .autopus/project documentation from codebase analysis.

Community
Intermediate
abpaiabpai

beautiful-mermaid

Render Mermaid diagrams to SVG and PNG files.

Community
Intermediate
cassm199-mitacassm199-mita

mermaid

Generates Mermaid diagrams for technical documentation in markdown files.

Community
Intermediate
anderson-0anderson-0
4

architecture-map

Generate Mermaid architecture diagrams from source code with dependency analysis.

Community
Advanced