Blog: Improve your documentation with Mermaid.js diagrams

By Chris Metz and Tim Bannister Topics covered in this blog. Live editor link: Topics Covered Friendly landing spot. Greeting readers with a page full of text can be intimidating to those new to Kubernetes, software engineering and tech writing. Faster grasp of concepts. A diagram can serve as a visual roadmap for details covered in the accompanying text. Better retention. Humans remember pictures better than words. Most importantly, readers acquire the confidence to explore further. “Wow! Okay I get this. What’s next? Maybe I can contribute. ” There are many drawing tools to choose from. Traditionally, you create a diagram, save it as png or svg file and then embed the file in the documentation.