https://github.com/mam-dev/c4-notation

Technical resources for using the C4 model for visualizing software architecture.
https://github.com/mam-dev/c4-notation

architecture architecture-diagram architecture-visualization c4model diagram-shapes inkscape-symbols visualization yed-palettes

Last synced: about 1 month ago
JSON representation

Technical resources for using the C4 model for visualizing software architecture.

• Host: GitHub
• URL: https://github.com/mam-dev/c4-notation
• Owner: mam-dev
• License: apache-2.0
• Created: 2019-05-16T11:30:58.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-07-28T09:32:00.000Z (over 5 years ago)
• Last Synced: 2024-07-06T20:17:53.019Z (4 months ago)
• Topics: architecture, architecture-diagram, architecture-visualization, c4model, diagram-shapes, inkscape-symbols, visualization, yed-palettes
• Homepage: https://c4model.com/
• Size: 16.6 KB
• Stars: 25
• Watchers: 7
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# C4 Notation

> Technical resources for using the C4 model for visualizing software architecture.

## What is This?

The contents of this repository should help you with putting the C4 model into action,

by providing relevant documentation, links, and technical artifacts (tools and media files).

Planned:

 * SVG notation shapes (for *yEd* or *InkScape*).

 * Documentation samples, possibly in notebook form.

## How to Use This?

Right now, `notation` holds subfolders for different SVG symbol themes including `default`.

The latter is created according to the samples on `c4model.com`.

A `legend.svg` file holds all symbols and can be used directly as a legend insert.

For different color schemes and specialized container types,

create variants of that file for specific projects or your own common stencil.

TODOs:

 * Write a script that extracts symbols into their own SVG files.

 * Explore how a yEd symbol group can be created (instead of importing single images).

## Related Projects

### Media / Resources

 * [skleanthous/C4-PlantumlSkin](https://github.com/skleanthous/C4-PlantumlSkin) – Skinning to create C4 diagrams using PlantUML.

 * [tmorin/plantuml-libs/c4model](https://github.com/tmorin/plantuml-libs/tree/master/c4model#c4-model) – Library implementing elements respecting the C4 Model.

 * [RicardoNiepel/c4-PlantUML](https://github.com/RicardoNiepel/C4-PlantUML) – c4-PlantUML combines the benefits of PlantUML and the C4 model for providing a simple way to describe and communicate software architectures.

 * [pihalve/c4model-visio-stencil](https://github.com/pihalve/c4model-visio-stencil) – Visio stencil with C4 model shapes.

### Software

 * [mrich316/docker-sphinx-doc-builder](https://github.com/mrich316/docker-sphinx-doc-builder) – Docker image for a Sphinx documentation builder, with an included C4 PlantUML skin.

 * [ysholomii/structurizr_py](https://github.com/ysholomii/structurizr_py) – Python client library for Structurizr.

 * [Introducing Structurizr Express](http://www.codingthearchitecture.com/2016/06/06/introducing_structurizr_express.html)

Text Diagrams:

 * https://github.com/plantuml/plantuml

 * https://github.com/knsv/mermaid

 * https://github.com/skanaar/nomnoml

 * https://github.com/jaime-olivares/yuml-diagram

 * https://github.com/aivarsk/scruffy

 * https://github.com/ivanceras/svgbob

### Examples

 * [clarity-h2020/csis-architecture](https://github.com/clarity-h2020/csis-architecture) – Architecture of the EU H2020 Project “Integrated Climate Adaptation Service Tools for Improving Resilience Measure Efficiency”, see [CLARITY D4.2 CLARITY CSIS Architecture](https://zenodo.org/record/2557378) for end results.