Skip to content

Commit ac3da61

Browse files
committed
add tone of voice
1 parent e9ac8c8 commit ac3da61

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

STYLE_GUIDE.md

+13
Original file line numberDiff line numberDiff line change
@@ -82,3 +82,16 @@ MyAlgorithm(argOne, argTwo):
8282
- Let {something} be {true}.
8383
- Return {something}.
8484
```
85+
86+
## Tone of voice
87+
88+
The GraphQL specification is a reference document and should use neutral and
89+
descriptive tone of voice.
90+
91+
Favor the present tense. The present tense is usually clearer and shorter:
92+
93+
✅ Present: The client then sends a request to the server.
94+
❌ Future: The client will then send a request to the server.
95+
96+
Avoid repetition. Repetition adds more cognitive load and possibilities for different
97+
parts of the specification to diverge in their meaning.

0 commit comments

Comments
 (0)