New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rule to flag documentation of self-explanatory fields #889

Closed

apinnick opened this issue Sep 30, 2024 · 0 comments · Fixed by #890

Collaborator

apinnick commented Sep 30, 2024 •

edited

Loading

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."

apinnick mentioned this issue

Add ObviousTerms rule #890

Merged

apinnick closed this as completed in #890

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment