kumaran-is

architecture-design

0
0
# Install this skill:
npx skills add kumaran-is/claude-code-onboarding --skill "architecture-design"

Install specific skill from multi-skill repository

# Description

System and solution architecture patterns for full-stack applications. Activate when designing APIs, system diagrams, deployment topologies, or making technology decisions.

# SKILL.md


name: architecture-design
description: System and solution architecture patterns for full-stack applications. Activate when designing APIs, system diagrams, deployment topologies, or making technology decisions.
allowed-tools: Bash, Read, Write, Edit


Architecture Design Skill

Architecture Decision Record (ADR) Template

# ADR-001: <Title>

**Status:** Proposed | Accepted | Deprecated | Superseded
**Date:** YYYY-MM-DD
**Decision Makers:** <names>

## Context
What is the issue we are facing?

## Decision
What is the change we are proposing?

## Consequences
### Positive
- ...
### Negative
- ...
### Risks
- ...

API Contract Template (OpenAPI snippet)

openapi: 3.0.3
info:
  title: My Service API
  version: 1.0.0
paths:
  /api/v1/users:
    get:
      summary: List all users
      parameters:
        - name: page
          in: query
          schema: { type: integer, default: 0 }
        - name: size
          in: query
          schema: { type: integer, default: 20 }
      responses:
        '200':
          description: Paginated list of users
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items: { $ref: '#/components/schemas/User' }
                  pagination:
                    $ref: '#/components/schemas/Pagination'
    post:
      summary: Create a user
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: '#/components/schemas/CreateUserRequest' }
      responses:
        '201':
          description: User created

Sequence Diagram Template (Mermaid)

sequenceDiagram
    participant C as Client (Angular/Flutter)
    participant G as API Gateway
    participant S as Spring Boot Service
    participant DB as PostgreSQL
    participant FB as Firebase

    C->>G: POST /api/v1/users
    G->>S: Forward request
    S->>S: Validate input
    S->>DB: INSERT user (R2DBC)
    DB-->>S: User entity
    S->>FB: Sync to Firestore
    FB-->>S: Ack
    S-->>G: 201 Created + UserResponse
    G-->>C: 201 Created

Docker Compose โ€” Dev Environment

version: '3.9'
services:
  postgres:
    image: postgres:16-alpine
    environment:
      POSTGRES_DB: mydb
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: postgres
    ports: ['5432:5432']
    volumes: ['pgdata:/var/lib/postgresql/data']

  redis:
    image: redis:7-alpine
    ports: ['6379:6379']

  backend:
    build: ./backend
    ports: ['8080:8080']
    environment:
      SPRING_R2DBC_URL: r2dbc:postgresql://postgres:5432/mydb
      SPRING_FLYWAY_URL: jdbc:postgresql://postgres:5432/mydb
    depends_on: [postgres, redis]

volumes:
  pgdata:

C4 Diagram โ€” System Context (Mermaid)

graph TB
    User[fa:fa-user End User]
    Angular[Angular SPA<br/>Browser]
    Flutter[Flutter App<br/>iOS / Android]
    Backend[Spring Boot API<br/>Java 21 / WebFlux]
    PG[(PostgreSQL)]
    Firebase[Firebase<br/>Auth + Firestore]
    Redis[(Redis Cache)]

    User --> Angular
    User --> Flutter
    Angular -->|REST API| Backend
    Flutter -->|REST API| Backend
    Flutter -->|Real-time| Firebase
    Backend -->|R2DBC| PG
    Backend -->|Cache| Redis
    Backend -->|Sync| Firebase

# Supported AI Coding Agents

This skill is compatible with the SKILL.md standard and works with all major AI coding agents:

Learn more about the SKILL.md standard and how to use these skills with your preferred AI coding agent.