-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
Revise language that assumes ease ('simply', 'obviously', etc.) #1120
Comments
robwierzbowski
changed the title
Remove language that assumes ease ('simply', 'obviously', etc.)
Revise language that assumes ease ('simply', 'obviously', etc.)
Sep 11, 2017
@robwierzbowski That sounds great. PRs more than welcome! 👍 |
All right! I'll give it a shot. |
@robwierzbowski |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Vue is more easy, simple, and fun to use than other reactive frameworks 🎆.
But pointing out how 'simple', 'obvious', or 'easy' something is can have the opposite-of-intended effect. If a person doesn't understand the 'simple' code, the project can seem inaccessible. "If I don't understand this, what chance do I have to understand the rest?" There are plenty of articles on this effect, and I've observed it personally when working with junior co-workers.
To make the Vue documentation more friendly, I'd like to remove/revise some words that assume ease from the docs. Here's a list of potentially problematic words: https://css-tricks.com/words-avoid-educational-writing/. I can find more reference articles if you'd like.
In most cases removing the word in question makes a sentence flow better; in some cases replacing the word with a more explicit one is a good option ('simple module' with 'small module', for example).
Would you be interested in a PR that revises one or two pages? If it looks good I could continue with the rest of the site.
The text was updated successfully, but these errors were encountered: