Architecture Documentation
CommunityDocument or design system architecture, effortlessly.
Software Engineering#architecture#documentation#data flow#system design#tech stack#Mermaid#component diagram
Authornormcrandall
Version1.0.0
Installs0
System Documentation
What problem does it solves? This Skill automatically documents existing software architecture or helps design new systems, providing a clear, up-to-date reference for development teams and stakeholders. It eliminates the manual effort of creating and maintaining complex architectural diagrams and descriptions.
Core Features & Use Cases
- Existing System Analysis: Analyzes codebases to document tech stack, components, data flow, API patterns, and architectural decisions.
- New Project Design: Guides the design of new architectures based on user requirements, recommending appropriate tech stacks, patterns, and deployment strategies.
- Visual Diagrams: Embeds clear Mermaid diagrams directly into the Markdown documentation for high-level and component-level architecture.
- Decision Recording: Documents key architectural decisions with context, rationale, and consequences.
- Use Case: Run this on an unfamiliar codebase to instantly generate a comprehensive
architecture.mddocument, saving days of manual discovery and accelerating onboarding for new team members.
Quick Start
Document existing architecture (first time)
Skill(command: "architecture")
Or, for a new project, describe your requirements
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 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: Architecture Documentation Download link: https://github.com/normcrandall/claudeskills/archive/main.zip#architecture-documentation Please download this .zip file, extract it, and install it in the .claude/skills/ directory.