reading-note-technical-writing

Posted by Chen22 on 2021-03-31

Choose strong verbs#

Weak Verb Strong Verb
The error occurs when clicking the Submit button. Clicking the Submit button triggers the error.
This error message happens when… The system generates this error message when…
We are very careful to ensure… We carefully ensure

Reduce there is/there are#

Exercise

Clarify the following sentences by removing There is, and possibly rearranging, adding, modifying, or deleting other words:

  1. There is a lot of overlap between X and Y.
  2. There is no creator stack for the main thread.
  3. There is a low-level, TensorFlow, Python interface to load a saved model.
  4. There is a sharding function named distribute that assigns keys.
Weak Verb Strong Verb
There is a lot of overlap between X and Y. X and Y overlap a lot
There is no creator stack for the main thread. The main thread does not provide creator stack
There is a low-level, TensorFlow, Python interface to load a saved model. TensorFlow provides a low-level python interface to load a saved model.
There is a sharding function named distribute that assigns keys. The distribute sharding function assigns keys.

Minimize certain adjectives and adverbs (optional)#

Short sentences#