Skip to content

Commit

Permalink
Add sentence for second person to style guide (#865)
Browse files Browse the repository at this point in the history
Co-authored-by: Kim Nylander <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Jack Baldry <[email protected]>
  • Loading branch information
3 people authored Oct 11, 2024
1 parent 5dfd83c commit cee0a40
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion docs/sources/write/style-guide/style-conventions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,17 @@ There are some situations where you must mention another company, such as in dat

## Address users clearly

To address users clearly and directly, write directives in the imperative second person where the unspoken 'you' is implied.
<!-- vale Grafana.We = NO -->

To address users clearly and directly, use second person ("you") and avoid first person ("I", "our", or "we").
Use first person plural pronouns like 'our' carefully.
Don't use 'we' when you're talking about the reader, instead use 'you'.
You can use 'we' when you're talking about Grafana Labs.

<!-- vale Grafana.We = YES -->

Write directives in the imperative second person where the unspoken 'you' is implied.

Avoid making the user or their role, such as _system administrator_, the subject of a sentence, as in: "Users configure the Cloud using a secure shell.".

Exception:
Expand Down

0 comments on commit cee0a40

Please sign in to comment.