Commit d5125034 authored by Amy Qualls's avatar Amy Qualls Committed by Marcel Amirault

Create a Vale test for ease-of-use words

Words describing ease-of-use shouldn't appear in documentation.
While that statement may seem outrageous and odd from a Product
view, it's an empathy issue at heart. As technical writers, we're
aware that what's easy for an experienced user can be complex and
frustrating (dare I say "hard"?) for new users, and telling a user
a seemingly-impossible task is "easy" causes cognitive dissonance
and frustration.
parent 777e2d07
---
# Suggestion: gitlab.Simplicity
#
# Checks for words implying ease of use, to avoid cognitive dissonance for frustrated users.
#
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
extends: existence
message: 'Avoid words like "%s" that imply ease of use, because the user may find this action hard.'
level: suggestion
ignorecase: true
link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language-to-avoid
tokens:
- easy
- easily
- handy
- simple
- simply
- useful
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment