This rule helps maintain a professional and direct writing style by identifying instances of first-person plural pronouns and expressions. The use of "we," "us," "our," and similar first-person plural language can make documentation feel less direct and can create ambiguity about who exactly is being referred to. In technical and professional writing, it's often clearer to be specific about who is performing an action or to use direct instructions.
The rule aligns with Microsoft's style guidelines, which recommend avoiding first-person plural to maintain clarity and professionalism in documentation.
This rule comes from: https://github.com/mesosphere/dcos-docs-site
extends: existence
message: "Try to avoid using first-person plural like '%s'."
link: https://docs.microsoft.com/en-us/style-guide/grammar/person#avoid-first-person-plural
level: warning
ignorecase: true
tokens:
- we
- we'(?:ve|re)
- ours?
- us
- let's