architecture-design

What problem does it solve?

Manually creating and maintaining comprehensive software architecture documentation is a time-consuming and often neglected task. This skill automates the generation of detailed ARCHITECTURE.md files, complete with visual diagrams and API specifications, ensuring consistency and reducing the burden on development teams.

Core Features & Use Cases

• Interactive Architecture Interviews: Guides you through 5-7 focused questions to gather essential system information, adapting to your project's needs.
• Comprehensive Documentation: Generates an 11-section ARCHITECTURE.md covering project structure, core components, data stores, deployment, security, and more.
• Visual Diagrams: Creates 5 essential Mermaid.js diagrams (C4 Context, Container, Component, Data Flow, Deployment) to visualize your system's architecture.
• API Specifications: Automatically generates OpenAPI 3.0 compliant specifications for your APIs, ensuring clear communication and integration.
• Use Case: Design an architecture for a new Node.js microservices platform by answering a few questions, and receive a complete documentation package including diagrams and API specs, ready for your repository.

Quick Start

Create architecture documentation for my Node.js e-commerce platform.