search

redhat-documentation / vale-at-red-hat

Vale config files, styles, and docs to help individuals and teams roll out Vale
https://redhat-documentation.github.io/vale-at-red-hat/
MIT License
39 stars 59 forks source link

Rule to flag documentation of self-explanatory fields #889

Closed apinnick closed 1 month ago

apinnick commented 1 month ago

Create a rule that flags self-explanatory fields in procedure steps. The purpose of this rule is to reduce 'overdocumentation' of UI procedures.

Example: "Enter your user name in the Username field."

Message: "Your procedure mentions %s. Consider not documenting fields that are self-explanatory."