Skip to content

Docs: create Flesch-Kincaid readability test

Amy Qualls requested to merge 219511-docs-readability-test into master

What does this MR do?

Check for readability levels that are too high, so we can ensure we don't make our documentation more technical than our users can actually read. Uses the Flesch-Kincaid readability test. (Other tests are available, see https://errata-ai.github.io/vale/styles/#readability for options.)

Related issues

Closes #219511 (closed)

Author's checklist (required)

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.

Merge request reports