Skip to content

Commit effe01c

Browse files
shannonbuxKyleAMathews
authored andcommitted
Hyperlinks, optionality, and "easy" (#5154)
Added a few changes. This document needs to be reorganized eventually; I just want to add these notes in the fastest way possible now so I don't forget them.
1 parent 3dc94f0 commit effe01c

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/docs/gatsby-style-guide.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,8 @@ abstract syntax tree (AST) is ..."
170170

171171
Text should use the second person ("you") to help to give it a conversational
172172
tone. This way, the text and instructions seem to speak directly to the person
173-
reading it. Try to avoid using the first person ("I", "we", "let's", and "us").
173+
reading it. Try to avoid using the first person ("I", "we", "let's", and "us").
174+
Using second person is also more accurate than saying "we," because typically only one person is reading the tutorial or guide at a time and the person who wrote the tutorial is not actually going through it with them, so "we" would be inaccurate. Finally, some technical documentation uses third person pronouns and nouns like "they" and "the user," which add more distance and feel colder than the conversational and warm "you" and "your."
174175

175176
If there are other Guide resources you think readers would benefit from, add
176177
them at the bottom in an "Other Resources" section.
@@ -192,6 +193,12 @@ item in a list of three or more items, before ‘and’ or ‘or’ e.g. an Ital
192193
painter, sculptor, and architect). It makes things easier, clearer, and prettier
193194
to read.
194195

196+
Avoid using words like "easier" or "simple," because if users have a hard time completing the task that is supposedly "easy," they will question their abilities. Consider using more specific descriptors; for example, when you say the phrase "deployment is easy," what do you really mean? Is it easy because it takes fewer steps than another option? If so, just use the most specific descriptor possible, which in that case would be "this deployment method involves fewer steps than other options."
197+
198+
Hyperlinks should contain the clearest words to indicate where the link will lead you. So instead of linking to the word [here](https://www.gatsbyjs.org/) link to [Gatsby's docs](https://www.gatsbyjs.org/).
199+
200+
When a paragraph or sentence offers an optional path, the beginning of the first sentence should indicate optionality. For example, "if you'd like to learn more about xyz, see our reference guide" is clearer than "Go to the reference guide if you'd like to learn more about xyz." This method allows people who would *not* like to learn more about xyz to stop reading the sentence as early as possible. This method also allows people who *would* like to learn more about xyz to recognize the opportunity to learn quicker instead of skipping over the paragraph.
201+
195202
# Formatting example code
196203

197204
Readers will likely use Guide articles as a quick reference to look up syntax.

0 commit comments

Comments
 (0)