Click/Press Replacement Rule

This rule enforces consistent terminology by suggesting the use of the word "select" instead of "click" or "press" in documentation. The motivation behind this rule is to create platform-agnostic documentation that remains relevant across different devices and input methods. While "click" implies a mouse action and "press" implies a physical button, "select" is more universal and inclusive of various interaction methods (touchscreens, keyboard navigation, screen readers, etc.).

Examples:

✗ Incorrect:

  • "Click the submit button"
  • "Press the menu icon"

✓ Correct:

  • "Select the submit button"
  • "Select the menu icon"

The rule will flag any instances of "click" or "press" and suggest replacing them with "select", making your documentation more accessible and future-proof across different platforms and interaction methods.

Rule Source

This rule comes from: https://github.com/mesosphere/dcos-docs-site

Rule Definition

---
extends: substitution
message: Consider using '%s' instead of '%s'
ignorecase: true
level: warning
swap:
  (?:click|press): "'select'"