From d5125034b5ce2f075d0fc6a8cd80da333f032bce Mon Sep 17 00:00:00 2001
From: Amy Qualls <aqualls@gitlab.com>
Date: Fri, 23 Oct 2020 02:25:56 +0000
Subject: [PATCH] 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.
---
 doc/.vale/gitlab/Simplicity.yml | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 doc/.vale/gitlab/Simplicity.yml

diff --git a/doc/.vale/gitlab/Simplicity.yml b/doc/.vale/gitlab/Simplicity.yml
new file mode 100644
index 0000000000000..fa7a07c3e81d0
--- /dev/null
+++ b/doc/.vale/gitlab/Simplicity.yml
@@ -0,0 +1,18 @@
+---
+# 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
-- 
GitLab