Creating Software with Modern Diagramming Techniques (Pragmatic Bookshelf)

PragmaticBookshelf
Communicate more clearly, refactor more effectively, and save time with attractive diagrams that only take minutes to make with open source, text-based tools.

Ashley Peacock @ashleypeacock

edited by Michael Swaine @michaelswaine

Diagrams communicate relationships more directly and clearly than words ever can. Using only text-based markup, create meaningful and attractive diagrams to document your domain, visualize user flows, reveal system architecture at any desired level, or refactor your code. With the tools and techniques this book will give you, you’ll create a wide variety of diagrams in minutes, share them with others, and revise and update them immediately on the basis of feedback. Adding diagrams to your professional vocabulary will enable you to work through your ideas quickly when working on your own code or discussing a proposal with colleagues.

Expand your professional vocabulary by learning to communicate with diagrams as easily and naturally as speaking or writing. This book will provide you with the skills and tools to turn ideas into clear, meaningful, and attractive diagrams in mere minutes, using nothing more complicated than text-based markup. You’ll learn what kinds of diagrams are suited to each of a variety of use cases, from documenting your domain to understanding how complex code pieces together. Model your software’s architecture, creating diagrams focused broadly or narrowly, depending on the audience. Visualize application and user flows, design database schemas, and use diagrams iteratively to design and refactor your application.

You’ll be able to use technical diagramming to improve your day-to-day workflow. You will better understand the codebase you work in, communicate ideas more effectively and immediately with others, and more clearly document the architecture with C4 diagrams. Manually creating diagrams is cumbersome and time-consuming. You’ll learn how to use text-based tools like Mermaid to rapidly turn ideas into diagrams. And you’ll learn how to keep your diagrams up to date and seamlessly integrated into your engineering workflow. You’ll be better at visualizing and communicating when you add diagrams to your standard vocabulary.


Ashley Peacock is a staff engineer and architect working in the UK tech industry with over 10 years of experience. He’s an avid user of diagrams, and a huge advocate for their power in conveying ideas, documenting architectures, and whiteboarding problems.

He has experience across the tech stack, with particular focus on backend technologies, having worked with C#, Ruby and PHP. He also has significant experience working with APIs and asychronous architectures, in particular working with Apache Kafka.


Don’t forget you can get 35% off with your Devtalk discount! Just use the coupon code “devtalk.com" at checkout :+1:

Latest Threads About This Book Top

Margaret
Ask Me Anything with Ashley Peacock @ashleypeacock On February 27 and 28, we are giving you a chance to ask questions of PragProg aut...
New
New
CandaceSoVan
Title: Creating Software with Modern Diagramming Techniques: Build Better Software with Mermaid Author: Ashley Peacock – typo on pg xvi (...
New
MichaelH
@ashleypeacock “Mermaid is supported in sevaral editors” should be: “Mermaid is supported in several editors”
New
b2m
In section “Create Clear Boundaries With Subgraphs” the subgraph feature is introduced as a boundary. On page 57 within list item 2 it is...
New
b2m
In the section “Additional Arrow Types” on page 65 there is a table describing different arrow styles. In the column Syntax examples are ...
New
victor
@ashleypeacock The image in page 84 is the same as in page 81, when it should show instead the additional REVIEW and SEASON tables and t...
New
victor
In page 62, it is mentioned that all the interactions are synchronous and that you modify the calls to the title service to be asynchrono...
New
victor
When reshuffling the lines of code to increase the ranks of some of the boxes, looks like there’s a missing line inside the subgraph, the...
New
victor
If I interpret this sequence diagram correctly, in case of invalid input, the Error message should end the activation of Sign Up Service....
New

Most Active This Week Top

Most Active This Month Top

Margaret
Ask Me Anything with Ashley Peacock @ashleypeacock On February 27 and 28, we are giving you a chance to ask questions of PragProg aut...
New

Most Active This Year Top

New

Most Active Last Three Years Top

PragmaticBookshelf
Communicate more clearly, refactor more effectively, and save time with attractive diagrams that only take minutes to make with open sour...
New
New
wfence
@ashleypeacock Chapter: Document Your Domain p2 - repeated an “Once you’ve thought of an an entity” p4 - spelling of associations “L...
New
raels
@ashleypeacock There doesn’t seem to be a difference in the notion of independence between GENRE ->> TITLE_GENRE <<-- TITLE,...
New
raels
Please use the following format for the title of this thread (then simply delete/replace this text with the content for the thread): Tit...
New
victor
When I added Title: \n\n as instructed, trying to improve readability of the Title node, I got this error: TypeError: Cannot read proper...
New
b2m
In the section “Additional Arrow Types” on page 65 there is a table describing different arrow styles. In the column Syntax examples are ...
New
victor
When reshuffling the lines of code to increase the ranks of some of the boxes, looks like there’s a missing line inside the subgraph, the...
New
CandaceSoVan
Title: Creating Software with Modern Diagramming Techniques: Build Better Software with Mermaid Author: Ashley Peacock – typo on pg xvi (...
New
rearick
The second sentence after the “Diagramming Techniques” heading has an incorrect spelling for the words modeling and language “The first ...
New
b2m
In section “Create Clear Boundaries With Subgraphs” the subgraph feature is introduced as a boundary. On page 57 within list item 2 it is...
New
victor
@ashleypeacock The image in page 84 is the same as in page 81, when it should show instead the additional REVIEW and SEASON tables and t...
New
victor
If I interpret this sequence diagram correctly, in case of invalid input, the Error message should end the activation of Sign Up Service....
New
rearick
@ashleypeacock First of all, thanks for all your effort on this book; I’m looking forward to putting the knowledge you’ve shared to good ...
New
victor
In page 62, it is mentioned that all the interactions are synchronous and that you modify the calls to the title service to be asynchrono...
New

Most Active Over Three Years Top

MichaelH
@ashleypeacock “Mermaid is supported in sevaral editors” should be: “Mermaid is supported in several editors”
New
victor
In page 29 (of PDF) synchronous is spelled wrong in two instances, in the header Display Asynchrous Messages and the first line in the ne...
New
victor
after showing the diagram detail of the asynchronous message, the text reads: which in today’s modern world of microservices and is cri...
New
victor
@ashleypeacock I was about to post this as an erratum but decided to check on Brave browser and saw that it worked. For some reason, wh...
New

Get money off!

The Pragmatic Bookshelf

35% off any eBook

Simply use coupon code "devtalk.com" at checkout. See full details here.