Inspired by a tweet from Anjana Vakil, I set a goal for Hacktoberfest 2019 to remove words like simple, easy or any other variation from open-source documentation.
Over the next month, I submitted over a dozen pull requests to projects like Jest, Cypress, Storybook and even some of our own repositories at Meeshkan (🙈). This initiative also inspired pull requests to webpack, Tailwind CSS and React Native. The React Native team even took it a step further and linted all 56 versions of their documentation in 6 days with help from 30 outside contributors.
Throughout this process, I learned a lot about the value of creating more inclusive docs and the practicalities of making it happen. So I've compiled these learnings into a guide!
Table of Contents
- Why focus on condescending language?
- What is condescending language?
- As promised, a guide!
- Finally, a thank you 🎉
Why focus on condescending language?
Rick Hanlon from the React Native team summed this up well in a recent tweet:
When we say things are "easy" or "simple" then it makes people feel inadequate or otherwise hurt if they don't immediately understand it.
Language is subjective - a simple concept for one person isn't always simple for another. By banning condescending terms from our documentation, we're taking a proactive step towards making our material more inclusive.
If you're interested or want more information on this topic, I'd highly recommend watching Jim Fisher's Don't Say Simply talk from Write the Docs Prague 2018.
What is condescending language?
Some examples of language considered condescending includes...
simply
easy
basically
clearly
everyone knows
just
obviously
of course
If you're interested in why these words are considered condescending, retext-equality (a plugin that checks for insensitive language) has a full list with explanatory notes.
As promised, a guide!
⚠️ Prerequisites:
- Download and install Node.js and npm
- An open-source project whose documentation you want to make more inclusive
✅ Steps:
- Open an issue describing your mission
- Use the alex.js linter to flag condescending terms
- Remove or replace instances of condescending language
- Create a pull request with your proposed changes
1. Open an issue describing your mission
If you aren't a regular contributor to the project, I'd suggest opening an issue before starting any work. If you're new to open source, GitHub has step-by-step documentation on creating an issue.
This step isn't always necessary, but it does give you the opportunity to describe the value a change like this will bring and see if the maintainers are open to this type of change (not all of them are).
On the other hand, this allows maintainers to suggest a preferred format for the changes - for example, submitting one pull request for every section instead of all at once - and let you know if they have any existing language linters you can work with or modify.
Reference: An issue I opened on the Cucumber Documentation.
2. Use the alex.js linter to flag condescending terms
You've gotten the OK from the maintainers. You've forked and cloned the repository. Now, you need to identify condescending terms to potentially remove.
You could manually search for terms within the documentation... but that can be tedious. Plus then you're more likely to miss variations (for example, easily instead of easy) or words you weren't aware were offensive. So to help, I'd suggest using alex.js.
alex.js is an open-source language linter designed to catch polarizing writing in Markdown files and suggest helpful alternatives. Because its rules are rooted in retext-equality, alex is able to flag the condescending language we're looking to remove as well as language that is ableist, gendered, homophobic, racist and anything else that's better left out of our documentation.
To use alex for linting open source docs, there are two approaches you could take:
Run npx alex within the repo directories
Using npx allows you to run the linter without installing alex as a dependency to the project. I'd suggest this as a first step because, speaking from experience, asking maintainers to add an additional dependency will take much more convincing than changing the wording in their docs.
To run alex locally, use your terminal to move into the directories containing the Markdown files you want to lint. In many projects, this folder will be called docs/. Once you're there, run the following command:
npx alex
You can also lint specific files by adding the file name to the end of the command. In this example, we're checking our project's README.md file:
npx alex README.md
Install alex as a dependency within the project
As mentioned, this one might take more convincing upfront - but if a project is dedicated to keeping this type of language out of their documentation, then this a proactive step they can take.
To set up alex in a project's workflow, you can follow this step-by-step tutorial. Because this requires additional configuration, a maintainer may ask you to tackle this in a separate pull request.
3. Remove or replace instances of condescending language
As tempting as it is, you don't want to remove every instance that is flagged by alex or your own search. Because, sometimes, these terms can be present out of necessity or as an attempt to be more welcoming.
Before changing anything, take a look at each instance and ask the following...
Is it actually condescending or offensive?
For instance, words like simple can be used to describe a specific type of network protocol or alex will flag terms like host which could refer to network hosts. So you want to be sure that you aren't removing or altering terms that are essential for comprehension.
Is it necessary?
In many cases, these condescending terms are adverbs that can be removed without any replacement. I've found that this is especially true for the words just and of course.
If it's necessary, what is it trying to say?
With documentation, it's rare for terms like easy to be intentionally condescending. Often times, writers use them to show that something isn't as intimidating as it sounds. If this is the case, think about what the docs are trying to communicate and replace the condescending language with word choices that better represent the intention.
If you're struggling to find alternatives, Jim Fisher has some suggestions:
- Be specific: Maybe it's easy because it's quick to set up, doesn't require much typing or has few moving parts.
- Be comparative: Something is smaller than something else. Compared to another product, your product requires less custom configuration.
- Be absolute: It takes 5 lines of code to integrate this library. There are two form fields required.
- Show, don't tell: Instead of using time as an indicator for how easy something is, create a video.
4. Create a pull request with your proposed changes
Now that the work is done, you can propose your changes with a pull request. If you're new to open source, GitHub has step-by-step documentation on creating a pull request.
Be sure to follow the project's contributing guidelines and reference your original issue (if you opened one). Even if you're referencing an issue, it helps to include:
- A summary of what you're trying to accomplish with this pull request
- Any agreements that were decided in the issue
- Examples of the terms you removed or replaced
This way, if another maintainer reviews your changes, they can gain context without having to read the entire issue and discussion.
Reference: A pull request I created for Prisma.
Finally, a thank you 🎉
Thanks for taking the time to read this guide and taking steps towards more inclusive open-source documentation! We need more wonderful, caring people like you. This effort also requires awareness. So I'd encourage you to share your journey with your colleagues, friends, Twitter followers - whoever will listen.
Top comments (37)
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.
You've never thought of it because it's silly. Devs have better things to do than worry about "condescending language".
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.
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.
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"
"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.
Please don't attack me. Let me be me. If you don't like it - tough. Ok, Gupta.
We're trying to be a friendly, helpful community, and in that light, your comment is not constructive.
I think this is a very useful post. People, myself included, genuinely feel put off when we try to follow documentation that suggests we should be able to do something, and that it's our fault when we fail. It might be our fault, but it might also be down to missing or outdated documentation, and I'm sure you've felt some measure of frustration with scrappy documentation in the past?
Nobody likes to feel like an impostor (to crowbar that word in), but that's sometimes the result of telling people a task is "easy" when it's not.
Perhaps "condescending" is not the best word to describe such expressions, but I can relate to the sentiment. It has annoyed me many times when documentation claims it's "easy", but there was an "unclear" assumption that didn't make things easy in practice. In general, one should strive to convey only reproducible facts in documentation without subjective/unnecessary expressions. If you claim something is "simple and easy" in the documentation, show me the evidence. I've seen tutorials and docs with phrases like "just type xxx". Do you really need that extra word "just" there? How does that improve readability or change meaning? Doc is not an essay or pitch.
The Symfony documentation use the term "belittling". Maybe it fit you best: "Avoid belittling words", github.com/symfony/symfony-docs/bl...
Could you take a step back and consider why this makes you 'completely livid'? You are perfectly entitled to consider this suggestion beneath you, and other people are perfectly entitled to not agree with you.
I suggest you try to calm down and look at this more maturely. I don't know how this such a significant issue to make you 'completely livid' - you don't have to follow the suggestion if you don't want to, and if other people start considering how they write documentation differently, what is it to you?
Is it really, though?
I love this and thank you for writing about your approach - it's really useful!
It's so easy to accidentally add this kind of language to docs and tutorials and I really like the idea of adding a linter for it to help catch it all 👍
This is a great article, and I appreciate your efforts to push open source projects to be more inclusive in their documentation.
I'm curious about situations where you've encountered resistance from maintainers / other contributors, and how you've managed to convince them (or not) of the benefits of these changes?
I would omit adjectives because they are superfluous to technical documentation.
I never thought about how they affected tonality.
Before Grammarly reported tonality I had no idea what tone my writing came across since I write in draconian style treating every textbox as documentation.
I cannot fathom the people who take issue with others looking for ways to be nice.
Don't want to apply this to your docs? Then don't.
But being angry that some of us like this idea, is a waste of your time taken to type your comment.
"everyone knows": Everybody knows this phrase is clearly false. See what I did there? :P But seriously, I can't think of a single good reason to use this phrase in documentation. Removing it is a-okay in my book.
"just", "obviously", "of course", and "clearly": They do have slight negative connotations. But whether they could actually be construed as condescending or not highly depends on their usage. I'm not entirely opposed to switching these out but I'm somewhat skeptical.
"simply", "easy", "basically": These are very common words and are not inherently condescending. Replacing all uses of these is going too far. Effort in helping newcomers and marginalized groups would be better spent elsewhere.
This is great and so important! Thank you so much for your work! Nothing is worse that someone telling you how simple something is and getting stuck on it.
Some comments may only be visible to logged-in visitors. Sign in to view all comments.