How to Write Great Documentation

Bruno Martins
New Work Development
7 min readMar 15, 2021

--

Address the reader’s needs in the simplest way!

That’s it, I could stop now and publish this post already. There is no big secret to write great documentation, that’s all you have to do.

Then, why are there so many poor docs that make you fall asleep, skip them or lose focus? I’ll tell you why. It’s because:

  • we’re lazy
  • we’re writing for ourselves
  • documentation isn’t properly structured
  • the writing doesn’t sound natural

--

--

Backend engineer @XING | Co-founder @Psyquê | Traveller | Bar hopper | Gamer | Blogger?