Knowledgebase

Writing About Technical Matters for Non-Technical Readers Print

  • 0

Translating between audiences.

WHAT TO ESTABLISH

What decision they need to make.

WHY

It determines what detail is relevant.

WHAT TO LEAD WITH

The implication, not the mechanism.

WHAT EXAMPLE SHOWS IT

Saying the site will be unavailable for a period, rather than describing a database migration.

WHAT TO INCLUDE

What is affected For how long What it costs What the risk is What you recommend

WHAT TO OMIT

How it works internally Technology names Detail that changes nothing for them

WHAT TO DO IF THEY ASK HOW

Explain by analogy, briefly.

WHAT MAKES A GOOD ANALOGY

Something in their experience with the same structure.

WHAT MAKES A BAD ONE

Something requiring its own explanation.

WHAT TO AVOID

Condescension Implying the question was naive Vocabulary you did not define

WHAT TO DO ABOUT NECESSARY TERMS

Define once, in a phrase.

WHAT TO QUANTIFY

Time, money and risk.

WHY

They are the terms decisions are made in.

WHAT TO PREPARE

Detail beneath, for anyone who wants it.

WHAT TO TEST

Whether they could explain it to someone else.

WHY

It is the standard for successful explanation.


Was this answer helpful?
Back

Are you happy with your experience? Leave us a review on Trustpilot.


Trustpilot