Docs header diagram from Hopsworks

A docs header worth a thousand words.

For a dev platform or infrastructure tool it is hard to explain where you fit, what you do quickly, and how you connect to existing components quickly.  

Hopsworks docs team does a great job here.

So instead of using words, they use a diagram:

  • You get a solid overview of where your tool/platform fits larger context
  • It shows you which part of the workflow/infra the platform solves
  • Every part of the diagram is a clickable docs link
  • Shows where you can deploy it
  • Shows what backend you can use.

All of that in a single diagram.

Now that is a dev-focused header visual.

  • See Hopsworks docs