system-architecture-document

Solid

Create a System Architecture Document (SAD) with C4 model diagrams, 4+1 view decomposition, integration maps, NFR constraints, and an Architecture Decision Record log. Use when documenting how an entire system or major subsystem is structured.

AI & Automation 6 stars 2 forks Updated 6 days ago MIT

Install

View on GitHub

Quality Score: 84/100

Stars 20%
28
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

## Purpose Produce a System Architecture Document (SAD) that gives every stakeholder - from non-technical product leadership to infrastructure engineers - the right level of detail about the system's structure. This document answers: - **What** components make up the system? - **How** do they communicate? - **Why** was the architecture designed this way? - **Where** does data flow and where are the trust boundaries? - **What** are the non-functional constraints the architecture must satisfy? ## Input **Works best with:** The name of the system or subsystem being documented. **Also valuable:** Existing diagrams, technology stack decisions, known integration points, existing ADRs, NFR targets. **Example invocation:** `Create a system architecture document for PayFlow, a multi-brand payment gateway with a PHP 8.3 backend, MySQL database, custom plugin system, and white-label domain routing.` ## Key Concepts ### C4 Model (Simon Brown) The C4 Model provides a hierarchical, developer-friendly approach to architecture documentation - like a "Google Maps" with multiple zoom levels: - **Level 1: System Context** - The system's place in the world. Users and external systems. Intended for all stakeholders. - **Level 2: Container** - The major deployable units (web apps, APIs, databases, queues). Intended for technical leads and architects. - **Level 3: Component** - The internal structure of a container (controllers, services, repositories). Intended for developers. - **Level 4:...

Details

Author
fattain-naime
Repository
fattain-naime/engineering-docs
Created
2 months ago
Last Updated
6 days ago
Language
JavaScript
License
MIT

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

c4-model

Create or review C4 model architecture documentation (official c4model.com notation) as diagrams-as-code in Markdown — C4-PlantUML where the target renders it (GitLab.com does; verify Self-Managed instances), Mermaid flowchart/sequence conventions otherwise. Use whenever the user wants to visualize or document the architecture of a system or codebase — even if they never say "C4" — for requests like "diagram this service", "document the architecture", "how do the pieces of this repo fit together", "draw the system/containers/components", or when reviewing existing C4/Mermaid architecture diagrams for correctness. Covers system context, system landscape, container, component, dynamic, and deployment views. Do not use for generic flowcharts, ER diagrams, standalone Kubernetes topology, API contract documentation (OpenAPI/AsyncAPI), or architecture prose without diagrams.

4 Updated 1 weeks ago
mryll
AI & Automation Listed

c4-architecture

Generate architecture documentation using C4 model Mermaid diagrams. Use when asked to create architecture diagrams, document system architecture, visualize software structure, create C4 diagrams, or generate context/container/component/deployment diagrams. Triggers include "architecture diagram", "C4 diagram", "system context", "container diagram", "component diagram", "deployment diagram", "document architecture", "visualize architecture".

0 Updated 5 days ago
dills122
AI & Automation Listed

c4-architecture

Генерирует 4-уровневую архитектурную документац��ю по C4 Model (Simon Brown): Context (системный обзор) → Container (деплоймент) → Component (внутренняя структура) → Code (детали реализации). Синтезирует Mermaid C4 диаграммы на каждом уровне. Используй при документировании архитектуры для стейкхолдеров, onboarding новых членов команды, архитектурном review, подготовке к scale. Триггеры: /c4-architecture, /c4, "c4 model", "architecture diagram", "c4 diagram", "архитектурная документация", "system context diagram", "container diagram".

7 Updated today
sergeeey