arch-analyzer

Name: arch-analyzer
Availability: InStock
Author: Weiran

Analyze Java multi-module microservice projects to generate architecture documentation.

3|Updated Apr 2, 2026

Search Tags:#architecture #documentation #microservices #java #analyze

Ready to run

npx skills add https://github.com/weiran-tech/agent-skills --skill arch-analyzer

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: arch-analyzer
Source: https://github.com/weiran-tech/agent-skills/tree/main/skills/arch-analyzer
Command: npx skills add https://github.com/weiran-tech/agent-skills --skill arch-analyzer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Analyzes Java multi-module microservice projects to generate cohesive architecture documentation.

Core Features & Use Cases

Parallel module discovery (pom.xml/build.gradle, application.yml) to extract structure and service names
MQ, Feign, and service interaction scanning to document cross-service flows
Generates four docs: overview.md, business.md, contracts.md, and flows.md for multi-stakeholder readership
Use Case: onboarding new developers to a complex microservice ecosystem by generating architecture docs from code

Quick Start

Run arch-analyzer on your multi-module Java project to generate architecture documents.

Frequently Asked Questions about arch-analyzer

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

FAQPage Schema

How do I generate architecture documentation for a Java microservice project?▼

To generate architecture documentation for a Java microservice project, you can use a code analyzer to scan Maven or Gradle multi-module structures, extract service interactions, and produce reader-focused markdown files automatically from your existing codebase.

What is the best way to document cross-service flows in microservices?▼

The best way to document cross-service flows in microservices is to scan MQ listeners, MQ publishers, and Feign clients to map inter-service communication patterns and generate cohesive architectural documents detailing the interaction flows.

Does this architecture analyzer work with both Maven and Gradle multi-module projects?▼

Yes, this architecture analyzer works with both Maven and Gradle multi-module projects by discovering pom.xml or build.gradle files alongside application.yml to extract module structures and service names for documentation.

What types of architecture documents are generated from Java code?▼

The types of architecture documents generated from Java code include overview.md, business.md, contracts.md, and flows.md, which are structured to serve multiple stakeholders by detailing module structures and service interactions.

How are Feign clients and MQ listeners used to map service interactions?▼

Feign clients and MQ listeners are used to map service interactions by scanning the service-layer patterns to identify publishers and consumers, documenting cross-service flows and communication contracts within the generated architecture markdown.