Consider the future - Deepstash
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.
  • Explain why things are the way they are - help future readers decide for themselves what is still true instead of trusting your bygone context.
  • Link to "sources of truth" liberally (also with references) - help maintainer update after the source changes.
  • Add created time for your document.
  • Collective ownership (team) over all documentation.
  • Recognize contributions.
  • Encourage readers to feedback.

6

39 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