Skip to content
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

Audit for colloquial/casual language, abbreviations, and other "basic" English #30

Open
Licenser opened this issue Sep 8, 2021 · 0 comments
Assignees

Comments

@Licenser
Copy link
Member

Licenser commented Sep 8, 2021

This is an extract from the Docs Assessment done by @celestehorgan


  • This recommendation has less to do with casual language or abbreviations being bad, and more to do with the perception of professionalism for the project.
  • Review all documentation for the following:
    • Unnecessary abbreviations (for example This page).
    • Casual language or colloquialisms, for example: A short "canned" synopsis, referring to processes either as painless (on the same page: "let's be real"), etc.
    • Spelling, consistent capitalization of titles, consistent verbiage in titles:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants