skills.rest
jrodrigopuca
jrodrigopucaCOMMUNITY
Explore all skills by this author โ†’
GitHub

create-architecture-docs

Generate architecture documentation with Mermaid diagrams and module descriptions.

Updated Feb 10, 2026
Search Tags:#architecture#documentation#software design#mermaid#modules#diagrams
One-click install
npx skills add https://github.com/jrodrigopuca/skills --skill create-architecture-docs
Or copy as Structured Prompt for Agentโ–ผ
Please help me install this Agent Skill.
Skill: create-architecture-docs
Source: https://github.com/jrodrigopuca/skills/tree/main/create-software-docs/sub-skills/create-architecture-docs
Command: npx skills add https://github.com/jrodrigopuca/skills --skill create-architecture-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

๐Ÿ’ก This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the generation of comprehensive software architecture documentation, ensuring clarity and consistency in project blueprints.

Core Features & Use Cases

  • Architecture Style Classification: Automatically identifies and documents the architectural style.
  • Evidence-Based Diagrams: Generates Mermaid diagrams (component, sequence) based on repository evidence.
  • Module & Concern Documentation: Details modules, dependencies, cross-cutting concerns, security, and operational notes.
  • Use Case: Generate architecture documentation for a new microservice, including its style, key modules, and their interactions, ensuring all stakeholders have a clear understanding of the system's design.

Quick Start

Generate architecture documentation for the 'user-service' scope.

Frequently Asked Questions about create-architecture-docs

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

FAQPage Schema
How do I generate software architecture documentation with Mermaid diagrams?โ–ผ

Software architecture documentation is generated by analyzing a specified scope to classify the architectural style and produce evidence-based Mermaid diagrams. It details modules, dependencies, cross-cutting concerns, and constraints to provide structured architectural blueprints.

What is the best way to document architectural style and cross-cutting concerns for a new microservice?โ–ผ

Documenting architectural style and cross-cutting concerns for a microservice is automated by generating a comprehensive blueprint from repository evidence. It identifies the architecture pattern and details security, operational notes, and module dependencies.

How to create module descriptions and sequence diagrams from repository evidence?โ–ผ

Module descriptions and sequence diagrams are created by analyzing repository evidence to map interactions and dependencies. The generated documentation applies shared templates to ensure structured blueprints for software development projects.

Does this architecture documentation approach work for complex software design projects?โ–ผ

Architecture documentation for complex software design projects is supported by analyzing scope, complexity, and evidence. It requires adherence to shared documentation contracts and templates to ensure consistent architectural blueprints across stakeholders.

What are the limitations of automated architecture documentation generation?โ–ผ

Automated architecture documentation generation requires a specified scope and repository evidence to produce accurate Mermaid diagrams and module descriptions. It is limited by the adherence to shared documentation contracts and the available evidence within the software development project.

Related Skills

Explore More Software Engineering Skillsโ†’
zmsqnfl-commitszmsqnfl-commits
1

architect

Define complete software architecture and file structure before coding.

Community
Intermediate
microsoftmicrosoft
2.9k

wiki-vitepress

Package wiki Markdown into a VitePress static site with dark theme and Mermaid diagrams.

Official
Advanced
gkganesh12gkganesh12
1

gk-review

Audit source code against documentation and test suites for architectural drift.

Community
Advanced
blackcaterblackcater

beautiful-mermaid-diagrams

Generate Mermaid code for flowcharts, sequence, class, ER, and state diagrams.

Community
Intermediate