Conversation
Generated with AI Co-Authored-By: Claude Code <ai@netwrix.com>
…ond person rule; remove sentence length rule Generated with AI Co-Authored-By: Claude Code <ai@netwrix.com>
…iews Generated with AI Co-Authored-By: Claude Code <ai@netwrix.com>
Generated with AI Co-Authored-By: Claude Code <ai@netwrix.com>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
vale
netwrix_style_guide.md|652 col 11| [Netwrix.CondescendingWords] Avoid 'Easily'. Remove it or rewrite without language that minimizes task difficulty.
netwrix_style_guide.md|653 col 11| [Netwrix.CondescendingWords] Avoid 'Obviously'. Remove it or rewrite without language that minimizes task difficulty.
netwrix_style_guide.md|659 col 45| [Netwrix.NegativeAssumptions] Avoid negative assumptions about what users can or cannot do ('you wouldn't be able to'). Describe the benefit positively instead.
netwrix_style_guide.md|660 col 11| [Netwrix.NegativeAssumptions] Avoid negative assumptions about what users can or cannot do ('You couldn't'). Describe the benefit positively instead.
netwrix_style_guide.md|663 col 62| [Netwrix.May] Avoid 'may'. Use 'might' for possibility or 'can' for capability.
netwrix_style_guide.md|666 col 31| [Netwrix.May] Avoid 'may'. Use 'might' for possibility or 'can' for capability.
netwrix_style_guide.md|667 col 15| [Netwrix.May] Avoid 'may'. Use 'might' for possibility or 'can' for capability.
netwrix_style_guide.md|676 col 64| [Netwrix.WordyPhrases] Use a concise alternative instead of 'before'.
netwrix_style_guide.md|676 col 87| [Netwrix.WordyPhrases] Use a concise alternative instead of 'after'.
netwrix_style_guide.md|676 col 114| [Netwrix.WordyPhrases] Use a concise alternative instead of 'if'.
netwrix_style_guide.md|676 col 142| [Netwrix.WordyPhrases] Use a concise alternative instead of 'because'.
netwrix_style_guide.md|676 col 178| [Netwrix.Utilize] Use 'use' instead of 'use'.
netwrix_style_guide.md|676 col 190| [Netwrix.Utilize] Use 'use' instead of 'use'.
netwrix_style_guide.md|682 col 11| [Netwrix.WordyPhrases] Use a concise alternative instead of 'before'.
netwrix_style_guide.md|683 col 11| [Netwrix.WordyPhrases] Use a concise alternative instead of 'after'.
netwrix_style_guide.md|684 col 11| [Netwrix.WordyPhrases] Use a concise alternative instead of 'if'.
netwrix_style_guide.md|685 col 38| [Netwrix.WordyPhrases] Use a concise alternative instead of 'because'.
netwrix_style_guide.md|686 col 11| [Netwrix.Utilize] Use 'use' instead of 'use'.
netwrix_style_guide.md|688 col 4| [Netwrix.ProvidesAbilityTo] Use 'lets you' or 'can' instead of 'lets you'.
netwrix_style_guide.md|689 col 37| [Netwrix.ProvidesAbilityTo] Use 'lets you' or 'can' instead of 'lets you'.
netwrix_style_guide.md|689 col 64| [Netwrix.IsAbleTo] Use 'can' instead of 'can'.
netwrix_style_guide.md|689 col 81| [Netwrix.IsAbleTo] Use 'can' instead of 'can'.
netwrix_style_guide.md|692 col 24| [Netwrix.ProvidesAbilityTo] Use 'lets you' or 'can' instead of 'lets you'.
netwrix_style_guide.md|693 col 30| [Netwrix.IsAbleTo] Use 'can' instead of 'can'.
netwrix_style_guide.md|695 col 4| [Netwrix.MakeSure] Use 'ensure' instead of 'ensure'.
netwrix_style_guide.md|696 col 26| [Netwrix.MakeSure] Use 'ensure' instead of 'ensure'.
netwrix_style_guide.md|698 col 11| [Netwrix.MakeSure] Use 'ensure' instead of 'ensure'.
netwrix_style_guide.md|700 col 4| [Netwrix.WishTo] Use 'want to' instead of 'want to', or rewrite as a direct imperative.
netwrix_style_guide.md|701 col 49| [Netwrix.WishTo] Use 'want to' instead of 'want to', or rewrite as a direct imperative.
netwrix_style_guide.md|703 col 18| [Netwrix.WishTo] Use 'want to' instead of 'want to', or rewrite as a direct imperative.
netwrix_style_guide.md|706 col 61| [Netwrix.ImpersonalConstructions] Avoid 'it is recommended'. Rewrite with an active subject or a direct imperative.
netwrix_style_guide.md|706 col 82| [Netwrix.ImpersonalConstructions] Avoid 'it is necessary'. Rewrite with an active subject or a direct imperative.
netwrix_style_guide.md|706 col 101| [Netwrix.ImpersonalConstructions] Avoid 'it is possible'. Rewrite with an active subject or a direct imperative.
netwrix_style_guide.md|706 col 119| [Netwrix.ImpersonalConstructions] Avoid 'it is required'. Rewrite with an active subject or a direct imperative.
netwrix_style_guide.md|706 col 137| [Netwrix.ImpersonalConstructions] Avoid 'it is advised'. Rewrite with an active subject or a direct imperative.
netwrix_style_guide.md|706 col 158| [Netwrix.ImpersonalConstructions] Avoid 'it is suggested'. Rewrite with an active subject or a direct imperative.
netwrix_style_guide.md|709 col 11| [Netwrix.ImpersonalConstructions] Avoid 'It is recommended'. Rewrite with an active subject or a direct imperative.
netwrix_style_guide.md|710 col 11| [Netwrix.ImpersonalConstructions] Avoid 'It is necessary'. Rewrite with an active subject or a direct imperative.
netwrix_style_guide.md|712 col 4| [Netwrix.NoteThat] Avoid 'Note that'. Use a proper admonition block (Note, Warning, or Tip) for supplementary information.
netwrix_style_guide.md|712 col 18| [Netwrix.NoteThat] Avoid 'Please note'. Use a proper admonition block (Note, Warning, or Tip) for supplementary information.
netwrix_style_guide.md|712 col 18| [Netwrix.Please] Avoid 'please' in instructions. Be direct.
netwrix_style_guide.md|713 col 102| [Netwrix.NoteThat] Avoid 'note that'. Use a proper admonition block (Note, Warning, or Tip) for supplementary information.
netwrix_style_guide.md|713 col 117| [Netwrix.NoteThat] Avoid 'please note'. Use a proper admonition block (Note, Warning, or Tip) for supplementary information.
netwrix_style_guide.md|713 col 117| [Netwrix.Please] Avoid 'please' in instructions. Be direct.
netwrix_style_guide.md|715 col 11| [Netwrix.NoteThat] Avoid 'Note that'. Use a proper admonition block (Note, Warning, or Tip) for supplementary information.
netwrix_style_guide.md|716 col 11| [Netwrix.NoteThat] Avoid 'Please note'. Use a proper admonition block (Note, Warning, or Tip) for supplementary information.
netwrix_style_guide.md|716 col 11| [Netwrix.Please] Avoid 'please' in instructions. Be direct.
netwrix_style_guide.md|718 col 4| [Netwrix.Aforementioned] Avoid 'aforementioned'. Refer to the subject directly or use 'described earlier'.
netwrix_style_guide.md|719 col 8| [Netwrix.Aforementioned] Avoid 'aforementioned'. Refer to the subject directly or use 'described earlier'.
netwrix_style_guide.md|721 col 25| [Netwrix.Aforementioned] Avoid 'aforementioned'. Refer to the subject directly or use 'described earlier'.
netwrix_style_guide.md|723 col 4| [Netwrix.FollowTheStepsTo] Avoid 'Follow the steps to'. Use a direct heading and numbered list instead.
netwrix_style_guide.md|724 col 13| [Netwrix.FollowTheStepsTo] Avoid 'follow the steps to'. Use a direct heading and numbered list instead.
netwrix_style_guide.md|726 col 11| [Netwrix.FollowTheStepsTo] Avoid 'Follow the steps to'. Use a direct heading and numbered list instead.
netwrix_style_guide.md|729 col 122| [Netwrix.BoilerplateCrossRef] Avoid 'for additional information'. Write specific cross-reference text that describes what the reader will find.
netwrix_style_guide.md|731 col 55| [Netwrix.BoilerplateCrossRef] Avoid 'for additional information'. Write specific cross-reference text that describes what the reader will find.
netwrix_style_guide.md|741 col 107| [Netwrix.HitVsClick] Use 'click' instead of 'hit' for UI elements.
netwrix_style_guide.md|745 col 11| [Netwrix.HitVsClick] Use 'click' instead of 'hit' for UI elements.
netwrix_style_guide.md|751 col 11| [Netwrix.TypeVsEnter] Use 'enter' instead of 'type' when instructing users to input text into a field.
netwrix_style_guide.md|763 col 38| [Netwrix.Dropdown] Use 'drop-down' (hyphenated) instead of 'drop-down'.
netwrix_style_guide.md|764 col 20| [Netwrix.Dropdown] Use 'drop-down' (hyphenated) instead of 'drop-down'.
netwrix_style_guide.md|769 col 42| [Netwrix.Checkbox] Use 'checkbox' (one word) instead of 'checkbox'.
netwrix_style_guide.md|775 col 11| [Netwrix.LoginVerb] Use 'log in' (two words) as a verb instead of 'log in to'.
netwrix_style_guide.md|792 col 29| [Netwrix.BoilerplateCrossRef] Avoid 'For more information'. Write specific cross-reference text that describes what the reader will find.
netwrix_style_guide.md|793 col 34| [Netwrix.BoilerplateCrossRef] Avoid 'For more information'. Write specific cross-reference text that describes what the reader will find.
netwrix_style_guide.md|811 col 103| [Netwrix.CondescendingWords] Avoid 'Just'. Remove it or rewrite without language that minimizes task difficulty.
| * **Avoid marketing language:** This documentation is intended to be informative. It's not meant to sell users the products. Don't include promotional claims. Don't use superlatives (best, fastest, most powerful). Don't use buzzwords that don't really mean anything. This type of language causes readers to lose trust in the integrity of the documentation. | ||
| * **Avoid first person:** This means both first person plural (I, me, my, mine) and first person plural (we, us, our, ours). | ||
| * **Avoid marketing language:** This documentation is intended to be informative. It's not meant to sell users the products. Don't include promotional claims. Don't use superlatives (best, fastest, most powerful). Don't use buzzwords that don't really mean anything. This type of language causes readers to lose trust in the integrity of the documentation. | ||
| * **Avoid first person:** This means both first person plural (I, me, my, mine) and first person plural (we, us, our, ours). |
There was a problem hiding this comment.
[Netwrix.FirstPersonPlural] Avoid first person plural 'we'. Rewrite without 'we', 'our', 'us', or 'ours'.
| * **Avoid marketing language:** This documentation is intended to be informative. It's not meant to sell users the products. Don't include promotional claims. Don't use superlatives (best, fastest, most powerful). Don't use buzzwords that don't really mean anything. This type of language causes readers to lose trust in the integrity of the documentation. | ||
| * **Avoid first person:** This means both first person plural (I, me, my, mine) and first person plural (we, us, our, ours). | ||
| * **Avoid marketing language:** This documentation is intended to be informative. It's not meant to sell users the products. Don't include promotional claims. Don't use superlatives (best, fastest, most powerful). Don't use buzzwords that don't really mean anything. This type of language causes readers to lose trust in the integrity of the documentation. | ||
| * **Avoid first person:** This means both first person plural (I, me, my, mine) and first person plural (we, us, our, ours). |
There was a problem hiding this comment.
[Netwrix.FirstPersonPlural] Avoid first person plural 'our'. Rewrite without 'we', 'our', 'us', or 'ours'.
| * **Avoid marketing language:** This documentation is intended to be informative. It's not meant to sell users the products. Don't include promotional claims. Don't use superlatives (best, fastest, most powerful). Don't use buzzwords that don't really mean anything. This type of language causes readers to lose trust in the integrity of the documentation. | ||
| * **Avoid first person:** This means both first person plural (I, me, my, mine) and first person plural (we, us, our, ours). | ||
| * **Avoid marketing language:** This documentation is intended to be informative. It's not meant to sell users the products. Don't include promotional claims. Don't use superlatives (best, fastest, most powerful). Don't use buzzwords that don't really mean anything. This type of language causes readers to lose trust in the integrity of the documentation. | ||
| * **Avoid first person:** This means both first person plural (I, me, my, mine) and first person plural (we, us, our, ours). |
There was a problem hiding this comment.
[Netwrix.FirstPersonPlural] Avoid first person plural 'ours'. Rewrite without 'we', 'our', 'us', or 'ours'.
| - Don't: "The system wants to verify your credentials." | ||
|
|
||
| **First person plural** | ||
| Avoid using "we" to refer to Netwrix. |
There was a problem hiding this comment.
[Netwrix.FirstPersonPlural] Avoid first person plural 'we'. Rewrite without 'we', 'our', 'us', or 'ours'.
| **First person plural** | ||
| Avoid using "we" to refer to Netwrix. | ||
| - Do: "This feature allows you to monitor SharePoint activity." | ||
| - Don't: "We've designed this feature to monitor SharePoint activity." |
There was a problem hiding this comment.
[Netwrix.FirstPersonPlural] Avoid first person plural 'We'. Rewrite without 'we', 'our', 'us', or 'ours'.
| - Don't: "Please enter your credentials." | ||
|
|
||
| **Words that assume ease** | ||
| Avoid words that minimize task difficulty or assume the reader finds it obvious. These include: simply, easily, just, basically, obviously. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Netwrix.CondescendingWords] Avoid 'just'. Remove it or rewrite without language that minimizes task difficulty.
| - Don't: "Please enter your credentials." | ||
|
|
||
| **Words that assume ease** | ||
| Avoid words that minimize task difficulty or assume the reader finds it obvious. These include: simply, easily, just, basically, obviously. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Netwrix.CondescendingWords] Avoid 'basically'. Remove it or rewrite without language that minimizes task difficulty.
| - Don't: "Please enter your credentials." | ||
|
|
||
| **Words that assume ease** | ||
| Avoid words that minimize task difficulty or assume the reader finds it obvious. These include: simply, easily, just, basically, obviously. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Netwrix.CondescendingWords] Avoid 'obviously'. Remove it or rewrite without language that minimizes task difficulty.
| **Words that assume ease** | ||
| Avoid words that minimize task difficulty or assume the reader finds it obvious. These include: simply, easily, just, basically, obviously. | ||
| - Do: "Configure the monitoring plan." | ||
| - Don't: "Simply configure the monitoring plan." |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Netwrix.CondescendingWords] Avoid 'Simply'. Remove it or rewrite without language that minimizes task difficulty.
| Avoid words that minimize task difficulty or assume the reader finds it obvious. These include: simply, easily, just, basically, obviously. | ||
| - Do: "Configure the monitoring plan." | ||
| - Don't: "Simply configure the monitoring plan." | ||
| - Don't: "Just configure the monitoring plan." |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Netwrix.CondescendingWords] Avoid 'Just'. Remove it or rewrite without language that minimizes task difficulty.
1 participant
No description provided.