Understand the audience - Deepstash
Understand the audience

Understand the audience

Understanding the reader of your writing documentation:

  • What does the reader bring to the table? What context do they have that equips them to understand the context?
  • Why is the reader reading your documnetation? What problems are they trying to solve?

Identify the target audience at the beginning of your documentation so readers can confirm reading it is worth their time (also remind the required knowledge and share links to introductory resources or summary that).

New terms should be emphasized (bold) with description in footer or appedix.

"Bias towards simple over clever"

6

47 reads

CURATED FROM

IDEAS CURATED BY

tuantm

just geek

Good documentation is essential to teams' productivity. It's hard to write documentation that is relevant, accessible and ages well over time. Everything changes time by time. Maintaince of documentation is essential to keep it fresh.

Read & Learn

20x Faster

without
deepstash

with
deepstash

with

deepstash

Personalized microlearning

100+ Learning Journeys

Access to 200,000+ ideas

Access to the mobile app

Unlimited idea saving

Unlimited history

Unlimited listening to ideas

Downloading & offline access

Supercharge your mind with one idea per day

Enter your email and spend 1 minute every day to learn something new.

Email

I agree to receive email updates