Save a horse, use a content strategy

You can lead a horse to water, but you can’t make it drink. In this metaphor, technical documentation is the water.

You can spend a lot of time making the pond look nice and accessible. Provide clear, clean water, some lily pads, a water feature to make it easier to drink. You invest in the structure of the pond to make sure the water doesn’t get stagnant, and even add a nice sign to indicate “fresh water here”.

Smooth dirt path to a rectangular horse pond, surrounded by tall green grass.
Credit: Simon Carey / Horse Pond / CC BY-SA 2.0

But if the route to the pond is treacherous — difficult to follow, unclear, full of pitfalls — then the horses won’t visit your beautifully curated pond. You won’t be able to lead the horse to the pond with the fresh, high-quality water. Instead, the horses will drink out of a muddy puddle — because the puddle is right in front of them where they were going already.

I’m stretching this metaphor to its limits to underscore the importance of having a content strategy. It’s not enough to write effective, accurate, and useful content. You also need to identify how people discover your content — invest in documentation discovery and evangelism.

If people don’t know how to get to your content, if it doesn’t appear in their pre-existing paths, they won’t discover it. And if they don’t know what’s in it or what the quality of your content is, they won’t use it.

Consider the context #

When you write documentation, you must consider the context in which it exists:

If your documentation isn’t available and accessible where your customers need it, it almost doesn’t matter what you write because it won’t get used.

Instead, customers will turn to alternatives:

These content types can be useful, but many of them are expensive to provide (and access) and are frequently not well maintained. Resources that are only available to some folks or are outdated are not as useful, reliable, or authoritative as official documentation. And if customers are using these content types instead of rather than in addition to the official documentation, you have a problem.

Improve access and awareness #

So what can you do?

You might discover when you talk to customers and internal stakeholders that the documentation you thought was excellent isn’t actually fitting the need — maybe the pond is too shallow to provide effective hydration to the horses, or the shoreline is difficult to access, or only some horses can find their way to the pond.

Getting feedback can help you prioritize your work accordingly to help ensure that your documentation gets used. If your technical content isn’t available where your users look for it, your content won’t get used — no matter how good it is.

Humans are creatures of convenience. Build your beautiful pond, but don’t forget to make it easy to access.

Two dark brown horses drinking out of a shallow pond, partially standing on a rocky path that enters directly into the pond. Leafy green trees are visible in the background and the water appears clear.
Credit: Sunny Ripert / Chevaux au bord de l'eau / CC BY-SA 2.0