My top 5 tips for writing good technical documentation

Separate writing and editing

Communicating your work

Outlining vs initial draft

Images

Use images as often as possible. A picture means 1000 words. This is also more productive as you don’t need to always describe the context fully.

Editing Tools

  • grammar errors highlight
  • minimal interface to decrease distractions
  • sleek UI with beautiful typography

--

--

Senior Software Developer, Writer, Amateur Photographer, Reader

Love podcasts or audiobooks? Learn on the go with our new app.

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store
Abdallah Yashir

Abdallah Yashir

Senior Software Developer, Writer, Amateur Photographer, Reader