|<<>>|4 of 214 Show listMobile Mode

A shepherd named Shepard shepherds

Published by marco on

There are just some notes I made for a recent documentation review.

  • A shepherd named Shepard shepherds data parameters
  • Use “said” when you’re referring back to one or more items that you don’t want to list again. It’s a sort of fancy neutral pronoun to refer to the subject. E.g., say you have the sentence

    “The parameters A, B, C, and D are shown to the user; after the user has chosen values for them, the application submits them.”

    Here, we’ve used “them” twice, which feels a touch awkward. We could instead spice things up with,

    “The parameters A, B, C, and D are shown to the user; after the user has chosen values for said parameters, the application submits them.”
  • Use “respectively” when you’re applying multiple values to previously named items. E.g.,

    “The user will calibrate A and B, setting them to appropriate input and output values, respectively.”

    You can also use “corresponding”, as in

    “The user will calibrate A and B, setting them to their corresponding input and output values.”