/
Write
Start a team blog
NEW ✨
Start a team blog, invite your team, and start publishing.

How do you write documentations? What practices do you follow?

wusatosi's photo
wusatosi
·May 12, 2020

Some say documentations are as important as code itself, just like testing. Though there are established, wide-spread best-practices, resources and examples for testing, but not much for documentations.

So:

  • Do you write documentations?
  • What do you write in your documentations?
  • What role do you think documentations play in writing good code/software?
  • What are the best practices you've seen/heard/used in writing documentations?
  • What are you trying to avoid in documentation? (bad practices? common mis-conceptions?)
  • Suggestions for good resources on documentations?