Document the right things - Deepstash

Explore the World's Best Ideas

Join today and uncover 100+ curated journeys from 50+ topics. Unlock access to our mobile app with extensive features.

Document the right things

Document the right things

"Be selective about what you document and what you don't."

"Documenting everything leads to noise that is a burden to maintain over time"

Whether something is worth documenting or not (why something is worth documenting):

  • What common questions do you spend a lot of your time answering (in active context)?
  • What information is poorly understood by your team?
  • What information is neccessary for people to make informed decisions?

"Documentation isn't free; you bear a one-time cost for writing it and a recurring cosst for maintaining it forever."

7

65 reads

MORE IDEAS ON THIS

Layer your communication

Layer your communication

"Structure your documentation to accomodate the different levels of investment with which readers will approach it"

Each readers has their own ways to read your document (from beginning to end...

6

40 reads

Consider the future

Consider the future

"Implement practices that help your documentation age well over time"

  • Be concise. Don't repeat yourself. Maintainers should have to update the same information in as few places as possible.

6

39 reads

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...

6

47 reads

CURATED FROM

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.

More like this

Things To Be Considered By Freelancers

Things To Be Considered By Freelancers

  • Finding New Work Every Now and Then: You need to make sure you are building good relations with potential clients, applying for jobs, answering emails, and constantly improving your work and marketing strategy.
  • Recurring Gigs: Having recurring gigs...

The Low-Information Diet

The Low-Information Diet

Most information is time-consuming and unnecessary. You should be critical with what you look at, read, or watch daily.

The low-information diet:

  • Go on a one-week media fast immediately: no newspapers, magazines, news websites, t...

Choose the Right Forum

When you post something controversial online, you're inviting people with different views to engage. In some cases, you may feel so strongly about a certain topic that you think it is worth putting out there, regardless of the consequences.

However, the most polarising topics are best ...

Read & Learn

20x Faster

without
deepstash

with
deepstash

with

deepstash

Access to 200,000+ ideas

Access to the mobile app

Unlimited idea saving & library

Unlimited history

Unlimited listening to ideas

Downloading & offline access

Personalized recommendations

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