Summary
Understanding the software you are working on is crucial to successful software. To understand, you and your team must transfer knowledge to each other. Diagrams are key to this knowledge transfer, but effective diagraming is a skill you traditionally don't get taught. So how do you create effective diagrams and visuals?
Design patterns can be applied to your diagrams to guide you towards the goal of successful communication, and towards maximum inclusion for your audience.
In this practical workshop, learn how to apply design patterns to tailor your visuals to your audience, choose the most appropriate level of detail and notations, and improve accessibility for all audiences.
We will use free open-source tools accessible via the internet. You will require access to https://app.diagrams.net and https://github.com. A mouse may be easier to use to draw diagrams than a trackpad.
If you are using a work computer it is a good idea to check your company allows access to any required websites before the course starts.
For who?
Developers, Tech Leads, Architects, Business Analysts, anyone creating software diagrams and visuals to communicate
Learning Objectives
- Become confident in your abilities to communicate using diagrams, and know where you still want to improve (we are always learning),
- Create diagrams that clearly communicate your message,
- Learn to spot and avoid diagramming antipatterns and leverage diagramming patterns,
- Understand how to make diagrams accessible to all audiences.
Agenda
We will cover design patterns and antipatterns, split into six themes like the chapters in part one of my book, Communication Patterns. As you learn you will have the opportunity to apply your learning in practical exercises.
Day 1
- Introduction
- Communication Essentials: the foundations of successful visual communication
- Clarify the Clutter: use less to say more
- Accessibility: go beyond screen readers
Day 2
- Narrative: tell your audience a story
- Notation: select the best standard to communicate successfully
- Composition: arrange your visuals for ultimate clarity
- Summary
Requirements
Some expereince of creating diagrams and/or documentation is useful but not necessary
FAQ
Q: Do I need to have read your book to attend the workshop?
A: No, we will cover everything you need to know for the workshop in the workshop. You may want to follow up by reading Communication Patterns for more patterns and antipatterns, and you can get a code from me to be able to read it for free for 30 days.
Q: What is the schedule for the workshop?
A: The workshop will be run in 2x 3.5 hour sessions on separate days. We will have breaks within these sessions.
Q: Will there be any homework?
A: You will be encouraged to apply your learning in the time between the taught sessions, but it is not mandatory. We will have time in the 2nd session to discuss anything you have done between the sessions.
Q: Will I receive the slides and teaching materials used during the course?
A: Yes, all materials will be made available to you, and you will be able to continue to access the GitHub repository we use in the workshop.
Q: Do you cover diagrams-as-code?
A: Not in this course, but I run another course on diagrams-as-code with AI. Please reach out if you are interested.
What participants say about this workshop
"This training session helped me realize it was time to update my architectural modeling approaches. Jacqui's ability to address all questions, even those slightly off-topic, made the learning experience particularly valuable."
- Workshop participant
