Skip to content

Commit

Permalink
Reminding folks to capitalize "Hooks"
Browse files Browse the repository at this point in the history
  • Loading branch information
rachelnabors authored Feb 5, 2020
1 parent 5934ff9 commit f97c385
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions STYLEGUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,17 @@ When it comes to describing property values, be definitive in what is and is not

**Good** “Accepts integer values.” Leaves no doubt about what values this takes!

## Other grammar policies

* Capitalize “Hooks.”

### Example

**Bad** “Open Xcode’s ‘Preferences...’ menu and then click on ‘Components.’” Ambiguous. Relies on reader knowing that “Preferences” is a submenu of “Xcode.” Difficult to read at a glance.

**Good** “Open **Xcode > Preferences...** and select the **Components** tab.” Path is clearer to pick out from the surrounding copy.


## Empathize with readers

When writing step-by-step instructions (e.g. how to install something), try to forget everything you know about the topic to attain a "beginner's mindset." Imagine follow the instructions you write, one step at time. Often you will discover that there is implicit knowledge that you forgot to mention, or that there are missing or out-of-order steps in the instructions. UX research pro tip: ask _someone else_ to follow your instructions and see where they get stuck!
Expand Down

0 comments on commit f97c385

Please sign in to comment.