PlantUML demo – PlantUML for Architecture & Modeling

Docs: Mindmap Diagram.md

Mon, 01 Jan 0001 00:00:00 +0000

PlantUML demo

“PlantUML in a nutshell. PlantUML is a component that allows to quickly write: Sequence diagram. Usecase diagram. Class diagram. Object diagram. Activity diagram (here is the legacy syntax) Component diagram. Deployment diagram” - PlantUML.com.

Getting started

MindMap Diagram

Mindmap OrgMode syntax

@startmindmap
* Debian
** Ubuntu
*** Linux Mint
*** Kubuntu
*** Lubuntu
*** KDE Neon
** LMDE
** SolydXK
** SteamOS
** Raspbian with a very long name
*** <s>Raspmbc</s> => OSMC
*** <s>Raspyfi</s> => Volumio
@endmindmap

Docs: UML Modeling

Fri, 26 Nov 2021 12:33:16 -0300

Unified Modeling Language (UML)

“The Unified Modeling Language (UML) is a general-purpose, developmental, modeling language in the field of software engineering that is intended to provide a standard way to visualize the design of a system”. - Wikipedia

Docs: C4 Model Diagraming

Fri, 26 Nov 2021 12:07:45 -0300

The C4 model for visualising software architecture: Context, Containers, Components, and Code

“The C4 model is an easy to learn, developer friendly approach to software architecture diagramming. Good software architecture diagrams assist with communication inside/outside of software development/product teams, efficient onboarding of new staff, architecture reviews/evaluations, risk identification (e.g. risk-storming), threat modelling (e.g. STRIDE/LINDDUN), etc”. - C4 Model

Docs: OpenAPI

Fri, 26 Nov 2021 12:08:24 -0300

Introduction

“The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.
An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases”. - OpenAPI Specification