Skip to main content
ScaleMath

Repeat only what is cheap to maintain

Some duplication saves the reader a pointless click. The test is not length, it is what happens the next time the product changes.

Search behaviour can and should influence documentation. It can affect page titles, heading wording, terminology, internal linking, discoverability, and the questions a page explicitly answers.

It should not be used as a reason to publish several pages that solve the same user problem. Duplicate documentation creates uncertainty about which page is current, increases maintenance work, and raises the risk that conflicting instructions develop over time. If several search terms represent the same intent, one strong page should address them.

When duplication is acceptable

Not all repetition is harmful. Repeating a small amount of information is fine when it saves the user unnecessary navigation. Good candidates are short, stable, directly relevant to the current task, and unlikely to create a maintenance burden.

Acceptable

Repeating “you need the Admin role to change this” at the top of six different settings guides.

One line. Stable. Directly blocks the task. Sending the reader to a permissions page for a single sentence costs more than the repetition does.

Not acceptable

Repeating the full twelve-step SSO configuration procedure inside each of the four identity provider guides.

It will be updated in one place and not the other three. Write it once and link, or restructure so the shared steps live in the parent guide.

The test is maintenance. If the repeated material would need updating in two places the next time the product changes, link instead.

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