Skip to content
This repository has been archived by the owner on Aug 10, 2024. It is now read-only.

docs: lots of condescending language #114

Open
jorgeorpinel opened this issue Jun 27, 2022 · 2 comments
Open

docs: lots of condescending language #114

jorgeorpinel opened this issue Jun 27, 2022 · 2 comments
Labels
A: docs Area: user documentation (gatsby-theme-iterative)

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Jun 27, 2022

I know it's not intentional but the current writing style includes a lot of "of course", "obviously", "you can just do x or y", etc. This can scare off readers. We should address this sooner than later, I think.

More context and examples: iterative/dvc.org#1394

For now I'll update this language as it comes when I write or update things for other reasons.

@jorgeorpinel jorgeorpinel added the A: docs Area: user documentation (gatsby-theme-iterative) label Jun 27, 2022
alex000kim added a commit that referenced this issue Jul 5, 2022
@jorgeorpinel jorgeorpinel mentioned this issue Oct 27, 2022
@aguschin
Copy link
Contributor

aguschin commented Nov 1, 2022

Is this THAT serious? I don't see why this is "condescending", maybe with is the why I underestimate the importance. I like that docs will be more brief and to the point though.

@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Nov 8, 2022

I cannot tell you how major it is for us specifically. We'd need to A/B test bounce rates with and without, or something like that. But it's a well known best practice in the field + being inclusive is one of Iterative's core values. Some examples:

Up to you triage and prioritize this though.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A: docs Area: user documentation (gatsby-theme-iterative)
Projects
None yet
Development

No branches or pull requests

2 participants