Is your software documentation a 'denial of service attack'? Learn to capture an entire system's critical aspects on a single, pragmatic canvas.
#1about 3 minutes
The common problems with software architecture documentation
Most projects suffer from either no documentation, overwhelming documentation, or overly complex diagrams that are impossible to understand.
#2about 4 minutes
Understanding the canvas pattern for structured visualization
A canvas is a one-page, structured visualization tool that captures key elements of a complex topic, inspired by the Business Model Canvas.
#3about 3 minutes
A brief overview of the Arc42 documentation template
Arc42 is an open-source template with 12 chapters for structuring software architecture documentation, but it can still be too extensive for some teams.
#4about 5 minutes
Introducing the Architecture Communication Canvas
The Architecture Communication Canvas is a one-page tool structured into problem, solution, and risks sections to concisely communicate a system's design.
#5about 3 minutes
Three practical use cases for the canvas
The canvas can be used to kickstart system reviews, overcome the blank-page syndrome when starting documentation, and quickly capture essential knowledge in emergencies.
#6about 3 minutes
Real-world examples of the canvas in action
See examples of the canvas applied to a large CRM system, a small internal tool, and a simple link checker to show its scalability.
#7about 4 minutes
Team experiences and benefits of using the canvas
Teams report that creating a canvas is fast, fun, and leads to valuable insights and "aha" moments about their own system.
#8about 1 minute
Q&A on canvas implementation and maintenance
The most difficult section to write is often past "bad decisions," and the canvas should be reviewed periodically, such as every three months.
Related jobs
Jobs that call for the skills explored in this talk.
Matching moments
02:24 MIN
From ARC 42 to the Architecture Communication Canvas
42 x 2 Canvases Later: Two Years, Two Minds, Many Lessons
01:52 MIN
Common challenges in architecture documentation
42 x 2 Canvases Later: Two Years, Two Minds, Many Lessons
02:45 MIN
How different teams use the architecture canvas
42 x 2 Canvases Later: Two Years, Two Minds, Many Lessons
02:36 MIN
Common pitfalls when using the architecture canvas
42 x 2 Canvases Later: Two Years, Two Minds, Many Lessons
03:21 MIN
Using the arc42 template for lightweight documentation
Work efficiently with Architecture Decision Records (ADRs)
03:45 MIN
Fostering alignment and documenting microservices
42 x 2 Canvases Later: Two Years, Two Minds, Many Lessons
06:39 MIN
Why documenting architectural decisions is crucial
Work efficiently with Architecture Decision Records (ADRs)
05:04 MIN
User feedback on the benefits of the canvas
42 x 2 Canvases Later: Two Years, Two Minds, Many Lessons
Humanizing Your DocumentationAbout the speaker:Carolyn Stransky is a journalist, software engineer, conference speaker and technical writer based in Berlin. This is how she describes herself on her website:Majority of the week, I'm a frontend engineer focused on accessibility, d...
Daniel Cranney
The real reason we document our codeThe world of software development moves fast. Technology is constantly changing, as are the tools we use with it, and even the role of a programmer is itself constantly in flux. However, some aspects of software engineering are so foundational that w...
Benedikt Bischof
Why You Shouldn’t Build a Microservice ArchitectureWelcome to this issue of the WeAreDevelopers Live Talk series. This article recaps an interesting talk by Michael Eisenbart who talks about the pros and cons of microservice architecture.About the speaker:Michael has been working for Bosch as a sof...
Stephen McKenna
Technical Documentation For DevelopersTechnical documentation is an old strategy but essential in web development. However, it’s often a neglected part of the software development process. When done well, it can make a huge difference in the usability and quality of a product. But unfort...
From learning to earning
Jobs that call for the skills explored in this talk.