Skip to main content
ScaleMath

Start from the four types

Documentation does not have one purpose. It has four, each answering a different user need, and collapsing them is what makes a library hard to use.

The method starts here, because every decision after this one depends on it.

Software documentation does not have one single purpose. It has four distinct functions, each oriented towards a different user need:

  • Tutorials help users learn through a guided experience.
  • How-to guides help users achieve a specific goal.
  • Reference lets users look up accurate information about the system.
  • Explanation helps users understand concepts, reasons and trade-offs.

The distinction matters because the four forms place different demands on both the writer and the reader. Each has one main job, and documentation becomes harder to use and to maintain when those purposes collapse into one another. A page that tries to teach, instruct, list and justify all at once does none of them well, and it is the most common thing we find in a library that grew without a method.

Need this applied to your documentation?

We audit, restructure and write product documentation for B2B software companies.

Product documentation servicesRun a free documentation audit
ScaleMath
  • Full stack, senior team: you get us, not just one person that's good at one thing.
  • Your strategic partner: we're here to serve you. Get our input on strategy, product, customer experience, UX, and more.
  • We've helped renowned companies like:
AtarimAAWPWP Fusion