generate-arch-doc
CommunityDocument your system architecture.
Software Engineering#architecture#code analysis#documentation#system design#mermaid#developer onboarding
Authorsitharaj88
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill automates the creation of comprehensive architecture documentation, making complex systems understandable for new developers and stakeholders.
Core Features & Use Cases
- System Mapping: Visualizes the overall system context with external actors and dependencies.
- Component Documentation: Details individual components, their responsibilities, key files, and dependencies.
- Data Flow Visualization: Illustrates key user workflows with sequence diagrams.
- Technology Stack Summary: Lists all technologies used with their versions and purposes.
- Deployment Overview: Describes the deployment architecture if infrastructure files are present.
- Development Guide: Provides essential information for setting up and running the project locally.
- Use Case: Onboarding a new engineer to a large microservices project by providing a clear, visual, and textual overview of its architecture.
Quick Start
Generate architecture documentation for the current project and save it to 'docs/architecture.md'.
Dependency Matrix
Required Modules
None requiredComponents
scriptsreferences
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: generate-arch-doc Download link: https://github.com/sitharaj88/claude-skills/archive/main.zip#generate-arch-doc Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.