Tips For Technical Writing

Writing steps:

1. Write the first draft
2. Re-read your writing by putting yourself in the recipient’s shoes
3. How to edit:
   • Break it into reasonable chunks
   • Remove unnecessary and distracting elements
   • Remove filler text.
   • Use shorter sentences.
     • Use the Hemingway Editor for this.
   • Use bullet points when it makes sense
   • Use bolding to make documents easy to scan. Also try to have bolding in the first part of a sentence to make it easier to read.
   • Use visuals, not just words.
   • Value the reader’s time more than your own.

Source:

---

uid: 202204062023 tags: #writing #advice #software-engineering

---

---

---