Word Substitution - Help vs. Assist

This rule enforces consistent word choice by suggesting the use of "assist" instead of "help". It's a substitution rule that aims to maintain a more formal or precise tone in writing.

The rule is important because:

  • It helps maintain consistency across documentation or content
  • "Assist" often conveys a more professional or technical tone compared to "help"
  • Standardized terminology can improve clarity and professionalism in technical writing

Examples:

✗ Incorrect:

  • "This tool will help you configure the settings."

✓ Suggested:

  • "This tool will assist you in configuring the settings."

The rule will raise a warning-level alert when it encounters the word "help", suggesting to replace it with "assist". Note that the rule is case-sensitive (ignorecase: false), so it will only match exact cases of "help" as specified.

Rule Source

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

Rule Definition

---
extends: substitution
message: Consider using '%s' instead of '%s'
level: warning
ignorecase: false
# swap maps tokens in form of bad: good
swap:
  help: assist