Skip to content

Commit

Permalink
add tone of voice
Browse files Browse the repository at this point in the history
  • Loading branch information
martinbonnin committed Feb 25, 2025
1 parent e9ac8c8 commit ac3da61
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,3 +82,16 @@ MyAlgorithm(argOne, argTwo):
- Let {something} be {true}.
- Return {something}.
```

## Tone of voice

The GraphQL specification is a reference document and should use neutral and
descriptive tone of voice.

Favor the present tense. The present tense is usually clearer and shorter:

✅ Present: The client then sends a request to the server.
❌ Future: The client will then send a request to the server.

Avoid repetition. Repetition adds more cognitive load and possibilities for different
parts of the specification to diverge in their meaning.

0 comments on commit ac3da61

Please sign in to comment.