Create acronyms test for Vale
Problem to solve
Acronyms can be problematic in documentation if the user does not know the meaning of the acronym, and it isn't explained. Consider creating a Vale test to alert the Technical Writing team of undefined acronyms on a page.
Further details
A Vale test is floating out in the wild, and could potentially be adapted here. It would require populating the exceptions list. It's worth noting that in @aqualls' experience, this test can generate a lot of false positives at first.
Proposal
description: "Spell out the words in an acronym the first time it's used, unless the acronym is well known."
level: warning
first: \b([A-Z]{3,5})\b
second: (?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)
exceptions:
- ABC
- DEF
Who can address the issue
@marcel.amirault, @eread, @mjang1, @aqualls
Other links/references
Part of &2497 (closed) #31025 may be related
Edited by Amy Qualls