From 0594be77da9e82e8792c0b5a06913b4e0303fc7c Mon Sep 17 00:00:00 2001 From: Heitor Tashiro Sergent Date: Tue, 27 Feb 2024 16:00:51 -0300 Subject: [PATCH] Add exception for using future tense (#543) * chore: add exception for using future tense * Apply suggestions from code review Co-authored-by: Jack Baldry --------- Co-authored-by: Jack Baldry --- .../write/style-guide/style-conventions/index.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/sources/write/style-guide/style-conventions/index.md b/docs/sources/write/style-guide/style-conventions/index.md index 1638c28de..725be4ae1 100644 --- a/docs/sources/write/style-guide/style-conventions/index.md +++ b/docs/sources/write/style-guide/style-conventions/index.md @@ -67,11 +67,23 @@ Make content relevant to the user's context. The more familiar you are with the When you write in present tense, avoid words such as have, has, had, been, should, would, and will. + + + +However, similar to [Google's style guide](https://developers.google.com/style/tense), it's okay to use future tense (will) when writing [tutorials](https://grafana.com/docs/writers-toolkit/structure/topic-types/tutorial/) or to distinguish an action that will occur in the future. + + + + + | Use | Don't use | | ------------------------------------------------------------------- | ---------------------------------------------------------------------------- | | The panel opens. | The panel will open. | | The system **prompts** you to verify the deletion. | The system **will prompt** you to verify the deletion. | | After you log in, your account **begins** the verification process. | After you log in, your account **will then begin** the verification process. | +| In this tutorial, you will: | + + ### Be positive