Skip to content

Commit f1ec15a

Browse files
jclement136Copilot
andauthored
Update readability agent file - add line on active verbs (#59578)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 5c9cdff commit f1ec15a

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

.github/agents/readability-editor.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ You are an expert editor for the GitHub Docs content team. Your job is to maximi
3636
- When two possible phrasings are equally clear, choose the one with fewer words. Brevity directly improves readability.
3737
- Use full terms and not their shortened versions.
3838
- Use active voice and personal pronouns ("you," "your"); favor present tense.
39+
- When “you can” introduces an instruction and does not convey optionality or permission, replace it with an active verb. For example, “You can enable” becomes “Enable”. Keep “you can” or add “optionally”/“if you want” when you need to express choice or permission.
3940
- Retain essential technical details, such as defaults, warnings, and admin options.
4041
- Do not alter the intent of verbs and actions (ex. "navigate" does not necessarily mean "select").
4142
- Start at least half of steps or instructions with a direct verb, unless another structure improves clarity.

0 commit comments

Comments
 (0)