Liking cljdoc? Tell your friends :D

marp: true #theme: gaia theme: uncover class: invert author: "Ludger Solbach"

overarch

data driven system modelling

Ludger Solbach

bg cover 100%

Rationale

system models for
- communication
- documentation
- thinking

Rationale

commercial modelling tools
- e.g. Enterprise Architect, Magic Draw
- comprehensive but complex
- license needed

Rationale

drawing tools
- e.g. Visio, Gliffy, ExcaliDraw
- pretty pictures only
- no reuse between diagrams

Rationale

lightweight open source modelling

data driven and text based

with visualization

=> overarch

Models

models as data
- concept models, concept maps and glossaries
- system landscape and architecture, deployment
- use cases, state machines and class models
hierarchical models and element references
composable / reusable
extensible format

Views

views as data
- separation of models and views
- view specific customization of model elements

Rendering

PlantUML
- C4 views, UML views
  - use case, state machine and class diagrams
- styling and sprite support
GraphViz
- Concept maps
Markdown
- Glossary, textual representations of graphical views

Exporting

exports
- JSON if you need to process models with languages without EDN support
- Structurizr experimental

Example Model

bg right 100%

Example View

bg right 100%

Example Diagram

bg right 70%

Example Diagram

bg right 90%

Extensible Data Notation (EDN)

Similar to JSON but richer set of data literals Subset of Clojure

EDN - Primitives

Numbers: 123 Strings: "Hello" Keywords: :keyword, :namespaced/keyword

EDN - Data Structures

Vectors: ["a" "b" "c"] Sets: #{"a" "b" "c"} Maps: {:a "a" :b "b" :c "c"}

Data structures can be nested

Modelling Example

#{ ; set of model elements
  {:el :system
   :id :example/system1
   :name "Example System"
   :desc "An example system to show how to model in overarch"
   :ct #{ ; set of children
         {:el :container
          :id :example/container1
          :name "Example Container"
          :tech "Java"
          :desc "Deployable application in the example system"}}}
}

Modelling Methods

C4 Model: Architecture Model, Deployment Model, Dynamic Model UML: Use Case Model, Class Model, State Machines Concept Maps: Concept Model