Skip to content

PDOCS-3613: Action verbs rules#29

Merged
dfinn5-do merged 5 commits intomainfrom
action-verbs-rule
Jan 28, 2026
Merged

PDOCS-3613: Action verbs rules#29
dfinn5-do merged 5 commits intomainfrom
action-verbs-rule

Conversation

@dfinn5-do
Copy link
Collaborator

Introduces consistent, accessible action verb usage in our product documentation. The rules align with our team's preference for "enter" over "type" while ensuring accessibility best practices for all UI interaction verbs.

ActionVerbs.yml

Enforces consistent verb usage through automatic substitution:

  • "Type" → "Enter" for text input fields and form values
  • "Click" → "Select" for buttons, links, checkboxes, and other UI elements

InputVerbs.yml

Flags misuse of "press" with UI buttons:

  • Ensures "press" is reserved for keyboard keys (Enter, Esc, Tab, etc.) and hardware buttons
  • Suggests "select" when "press" is incorrectly used with UI buttons

Industry Alignment

These rules also follow Microsoft Manual of Style and Microsoft Accessibility Guidelines, which recommend:

  • Generic verbs that work with any input method
  • "Enter" for text input fields
  • "Select" for UI elements (not "click")
  • "Press" reserved for keyboard keys

WCAG Compliance

These changes support Web Content Accessibility Guidelines (WCAG) as well.

@dfinn5-do dfinn5-do requested a review from a team as a code owner January 28, 2026 16:44
@dfinn5-do dfinn5-do merged commit 48ef3e0 into main Jan 28, 2026
2 checks passed
@dfinn5-do dfinn5-do deleted the action-verbs-rule branch January 28, 2026 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant