-
Notifications
You must be signed in to change notification settings - Fork 0
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.
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
Update policy documentation to use plain language #162
Comments
I wonder if there's a "plain language" automation we could add, so it could fail a PR if things get over a certain grade reading level or something. |
Looks like syllable has an automated-readability formula. |
That's fun. It'll be tricky, though, because by nature a security policy is going to have a lot of big words. This will probably cause us fail a readability test—but the big words might be necessary. It could be a good first step? Would require some fine-tuning. |
So for stuff like the quote below, I wonder whether the language is intended to be formal for legal reasons, or if it can be made a bit more friendly.
Friendly version:
|
The original policy was written using https://www.iso.org/isoiec-27001-information-security.html as a reference, so much of the terminology comes from there. While this policy is used for employees, it is also given to clients who usually ask for it. So while we'll want to be careful about some of the terminology, we certainly can remove or simplify the verbose language. |
Proposed changes
Explain acronyms on first use
Use simple words and terms when possible
Change to active voice where appropriate
Include or link to instructions for for software set-ups and settings changes
Create a new branch
Create a PR with the handbook changes and link it to this issue.
Review the PR with the security team
The text was updated successfully, but these errors were encountered: