Software Architecture Design, Planning, and Documentation using UML(Architekturdesign, Planung und Dokumentation mit UML)

Examen project Real-Time Room Booking and Occupancy Software via Samply.Beam

Examen project

"Raumbelegungssoftware über Samply.Beam" Docker as cross-platform with a client script to install

• Client Axum(Rust Webframework) with Svelte(JavaScript Framework) template as UI

• Backend-Connector SeaORM (Rust Object Related Mapper)

• Library from the Tokio developer group

• [Dokumentation] will follow

Tauri framework Extension

• Tauri for building lightweight, secure desktop applications using web technologies
• Backend(Rust) with a beam proxy combined
• Frontend(Svelte.js, typescript)
• Desktop app for Windows, Linux and Mac
• Overwiew

PlantUML

PlantUML is an open-source diagramming tool that allows blind and visually impaired users to create visual representations of software systems, processes, and concepts using a simple syntax and a wide range of pre-defined templates.

• PlantUML Einführung (PDF)
• ACCESS - Karlsruhe Institute of Technology (KIT)
• tutorial Key Features:

1. Easy-to-learn syntax: PlantUML uses a simple and intuitive syntax, making it easy for developers, designers, and non-technical stakeholders to create diagrams without extensive knowledge of diagramming tools.
2. Pre-defined templates: PlantUML comes with a wide range of pre-defined templates, allowing users to quickly create diagrams for various software development concepts, such as class diagrams, sequence diagrams, state machines, and more.
3. Automatic rendering: PlantUML generates visual diagrams in multiple formats, including images (PNG, SVG, JPEG), HTML, and PDF.
4. Integrations: PlantUML integrates with popular IDEs, version control systems, and project management tools, making it easy to incorporate into existing workflows.
5. Collaboration: PlantUML allows real-time collaboration on diagrams, enabling multiple users to work together on the same diagram simultaneously.

Types of Diagrams:

1. Class Diagrams: Representing class relationships, inheritance, and interfaces.
2. Sequence Diagrams: Showing interactions between objects over time.
3. State Machine Diagrams: Visualizing state transitions and behaviors.
4. Component Diagrams: Representing system components and their relationships.
5. Deployment Diagrams: Showcasing system deployment and infrastructure.

Benefits:

1. Improved communication: PlantUML helps bridge the gap between developers, designers, and stakeholders by providing a shared visual language for discussing software systems.
2. Reduced misunderstandings: By using visual diagrams, misunderstandings caused by misinterpretation of code or documentation are minimized.
3. Faster development: PlantUML saves time by allowing users to quickly create and communicate about system designs.

Community:

PlantUML has an active community of users, developers, and contributors who share knowledge, examples, and templates on various platforms, including:

1. GitHub (official repository) PlantUML GitHub Repository
2. PlantUML PlantUML Sitemap
3. PlantUML forums Visit the PlantUML Forum

Overall, PlantUML is a powerful tool for creating visual representations of software systems, processes, and concepts, making it an excellent choice for developers, designers, and stakeholders alike.

Overview from my projekts and school examples

1. Tutorial PLANTUML overview: "PlantUML Tutorial Series and Overview" This theme serves as an introduction to PlantUML, a diagramming tool for creating visual representations of software development concepts, including tutorials, examples, and project documentation.

2. Classes: "Software Architecture and Design Patterns" This theme explores different software design patterns, architecture styles, and class relationships in object-oriented programming.

3. Database: "Data Storage and Management Systems" This theme delves into the world of databases, covering data modeling, schema design, normalization, and querying techniques.

4. JSON: "Data Interchange and JSON Data Structures" This theme examines the principles and syntax of JSON (JavaScript Object Notation), as well as its applications in data exchange, storage, and manipulation.

5. KI (Knowledge Intelligence): "Artificial Intelligence and Machine Learning Fundamentals" This theme covers the basics of artificial intelligence, machine learning, and natural language processing, providing a foundation for more advanced topics.

6. Calendar: "Time Management and Scheduling Systems" This theme focuses on time management strategies, scheduling techniques, and calendar systems, including their applications in personal and professional settings.

7. Mindmap: "Visual Thinking and Conceptual Mapping Tools" This theme explores the world of visual thinking tools like mindmaps, covering concepts, principles, and best practices for creating effective mindmaps.

8. Process: "System Development Life Cycle and Process Management" This theme examines the software development life cycle, including planning, execution, testing, and deployment phases, as well as process management techniques.

9. Deploy Diagram: "System Deployment Plans and Architecture Design" This theme discusses system deployment plans, architecture design principles, and best practices for deploying complex systems.

10. Network: "Network Toplogy" This theme examines possible representations and concepts for Network tasks.

11. Projects: "real projects" This theme focuses on the various aspects of my projects, including planning, execution, and deployment.

How to Install PlantUML

1. Prerequisites

Before installing PlantUML, ensure the following requirements are met:

• Java Runtime Environment (JRE): PlantUML requires Java to run.
  • To check if Java is installed, run:

    java -version

  • If not installed, download Java from Oracle or OpenJDK.

---

2. Installation Methods

A. Install the Standalone PlantUML Jar

1. Download PlantUML:
   • Get the PlantUML .jar file from the official website.
2. Run PlantUML:
   • Use the following command:

     java -jar plantuml.jar your-diagram-file.puml

   • Replace your-diagram-file.puml with the path to your .puml file.
3. Optional:
   • Install Graphviz if your diagrams require advanced layouts.

---

B. Install Using a Package Manager

For Linux (Debian/Ubuntu):

sudo apt update
sudo apt install plantuml

For Mac (Homebrew):

brew install plantuml

C. Integration with Editors and IDEs

1. Visual Studio Code (VS Code):

• Install the PlantUML Extension from the Extensions Marketplace.
• Ensure Java is installed on your system.
• Use the shortcut Alt + D to preview diagrams in real-time.

2. IntelliJ IDEA:

• Install the PlantUML Integration plugin from the JetBrains Marketplace.
• Configure the plugin to use the PlantUML .jar file.

5. Additional Resources

• PlantUML Official Website
• Graphviz Download
• PlantText Online Editor