DEV Community

loading...

Discussion on: How to remove condescending language from documentation

Collapse
syntaxseed profile image
SyntaxSeed (Sherri W)

Embarrassed to say I've never thought of this before. I will be reviewing the docs for my OSS projects because of this article. Thank you.

Collapse
themanthel3g3nd profile image
Comment marked as low quality/non-constructive by the community. View Code of Conduct
Tyrone

You've never thought of it because it's silly. Devs have better things to do than worry about "condescending language".

Collapse
chetbox profile image
Chetan Padia

"Silly" is far more condescending than any of the language mentioned in this article. Please think about the language you use and try to empathise.

Thanks for the excellent post, Carolyn.

Thread Thread
themanthel3g3nd profile image
Comment marked as low quality/non-constructive by the community. View Code of Conduct
Tyrone

Please don't attack me. Let me be me. If you don't like it - tough. Ok, Gupta.

Collapse
syntaxseed profile image
SyntaxSeed (Sherri W)

It's literally the foundation of what we do: create things for users. If you create libraries & tools that have documentation... that documentation is also something we create for the users.

And much like we try to be aware of tuning our creations to the accessibility, aesthetics, demographics, & skill levels of our users... a few simple adjustments to consider the confidence level of our users & not degrade them unintentionally is as valuable as any other usability feature.

Happy users = successful development, no matter how you ensure that happiness.

Collapse
scottshipp profile image
scottshipp

Being respectful of differing viewpoints and experiences is one of the values at DEV. Even if something is "silly" to you, that doesn't mean it is for someone else. Comments like that also don't contribute anything to the conversation but close down conversation instead. It's better to follow the old adage, if you can't say anything nice don't say anything at all.

Collapse
pinotattari profile image
Riccardo Bernardini

I agree.

Honestly, I never considered words like "easy", etc. as "condescending," neither as writer nor as reader. It sounds like a variation on "mental fun on language"