How does the skill know my tech stack?

The skill extracts information from your codebase, existing TECH_RADAR documents, and MVP definitions to ensure the architecture matches your implementation.

Where are the architecture documents saved?

By default, documents are saved to the docs/architecture/ directory, with a dedicated subdirectory for ADRs (Architecture Decision Records).

Is this skill suitable for monorepos?

Yes, the skill includes logic to output documentation at both the system-wide root level and specific application levels within a monorepo structure.

What diagrams does this skill support?

It utilizes Mermaid.js to create C4 Context diagrams, Container diagrams, Flowcharts, and Entity Relationship Diagrams (ERDs) directly within your Markdown files.

What is the purpose of the ADR template?

The Architecture Decision Record (ADR) template captures the context, status, and consequences of significant design choices to provide a historical record for the team.

System Architecture Documentation

Name: System Architecture Documentation
Author: orbtyapp

byorbtyapp

학습 및 문서화

Generates comprehensive software architecture documentation including system overviews, API designs, data models, and security protocols.

소개

This skill empowers Claude to act as a seasoned software architect by formalizing the documentation process. It automatically generates a full suite of architectural documents—including C4 context diagrams, entity-relationship diagrams (ERDs), API contracts, and Architecture Decision Records (ADRs)—ensuring that your project has a solid, documented foundation. By referencing existing tech stacks and project requirements, it creates consistent, professional Markdown-based documentation integrated with Mermaid.js visualizations for clear technical communication.

주요 기능

0 GitHub stars
Relational data modeling with ERD and schema definitions
Automated C4 Model diagrams using Mermaid.js visualization
Formalized Architecture Decision Records (ADR) tracking
Standardized API design and endpoint contract documentation
Comprehensive security architecture and risk management templates

사용 사례

Tracking and formalizing complex architectural trade-offs and decisions
Bootstrapping professional documentation for a new software project
Visualizing and documenting existing legacy codebases for team onboarding

소개

주요 기능

0 GitHub stars
Relational data modeling with ERD and schema definitions
Automated C4 Model diagrams using Mermaid.js visualization
Formalized Architecture Decision Records (ADR) tracking
Standardized API design and endpoint contract documentation
Comprehensive security architecture and risk management templates

사용 사례

Tracking and formalizing complex architectural trade-offs and decisions
Bootstrapping professional documentation for a new software project
Visualizing and documenting existing legacy codebases for team onboarding