Git Product home page Git Product logo

solution-architecture-diagrams's Introduction

Solution-Diagrams

This repository contains some of the solution diagrams, technical architcture & UML diagrams I've created over diagrams.net (previously, Draw.io) for different personal & commercial projects.

Helpful Resources

Some best practices for system diagrams:

  • Show system interactions: Use simple shapes and lines to indicate process flows and the ways different elements interact with each other. Highlighting these relationships makes it easier to assess how changes can impact the entire system.
  • Include useful annotations: Add helpful explanations to critical pieces of your diagram giving teammates and stakeholders important context and information. It should provide more nuanced details not easily conveyed in the diagram.
  • Keep structural and semantical consistency across diagrams: Every diagram should be consistent with the others in terms of boxes, shapes, borders, lines, colors, etc. From the semantical point of view, all of these diagrams should be periodically synchronized to latest code changes and between them, since a change in one diagram might impact others.
  • Add legends next to architectural diagrams:: If you do not follow a standard architectural description language (e.g. UML, ArchiMate), detail every piece of the diagram in the legend (e.g. boxes, shapes, borders, lines, colors, acronyms, etc).

UML Diagrams

The Unified Modeling Language™ (UML®) is a standard visual modeling language. The latest version is 2.5.1, which was published on December, 2017 [Ref]

The UML specification defines two major kinds of UML diagram:

  • Structure diagrams and
  • Behavior diagrams

UML Diagram Types

UML_diagrams_overview

Behavioral UML diagrams

  • Activity diagram
  • Communication diagram
  • Interaction overview diagram
  • Sequence diagram
  • Timing diagram
  • State diagram
  • Use case diagram

Structural UML diagrams

  • Composite structure diagram
  • Class diagram
  • Deployment diagram
  • Component diagram
  • Package diagram
  • Object diagram
  • Profile diagram

solution-architecture-diagrams's People

Contributors

saadaakash avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.