Content principles
Principles and tactics for writing at Stack Overflow. These will help produce clear, consistent content for users of different professions, identities, and levels of English fluency.
Write for a 7th grade reading level. Stack Overflow users are busy people with limited time and attention. They’re also located all over the world with different levels of English fluency. You can help everyone follow along by choosing simple, consistent words and phrases, and being careful about jokes and cultural references.
If there’s a simpler word to say what you mean, use it. Always choose the short, simple word over the long, complicated one. Don’t complicate your ideas with business or insider jargon. Only use jargon when you have reason to believe it will improve user understanding.
| Don’t | Do |
|---|---|
| Optimize | Improve |
| Falsified | Fake |
| In order to | To |
| Leverage | Use |
| Garner | Get |
| Despite the fact | Although |
Trim word bloat. Don’t make people read more than they need to.
| Don’t | Do |
|---|---|
| Questions should be merged when they are 99% identical and it would be beneficial to have all the answers from multiple duplicate questions in one place. | Merge questions that are almost alike. This option will also merge answer lists. |
| If you need to delete your account, merge accounts, or have an issue that can't be addressed by Meta, please use the form below: | Questions? Contact us. |
Be careful with jokes and cultural references. Jokes, idioms, slang, and regional or cultural references don’t always translate well for our global audience. The next time you’re making a reference, ask yourself if there’s a more universal way to make your point.
| Don’t | Do |
|---|---|
| “It was like trying to take care of your kids while playing WoW at the same time.” | “It was like trying to rub your stomach and pat your head at the same time.” |
| “This person likes to keep an air of mystery to them.” | In this situation, humor isn’t appropriate. See more about tone. |
Pick names early and implement them consistently. Consistent language reduces the number of things your users have to learn or remember. If multiple names already exist, identify and eliminate them.
| Don’t | Do |
|---|---|
| Inbox alerts | Inbox notifications |
| Inbox notifications | |
| Inbox messages |
Avoid exaggerated statements. When possible, back up your claims with facts and data. Be careful with adjectives and modifiers.
| Don’t | Do |
|---|---|
| Endless possibilities | Choose from external hosting options or host on stackoverflow.com. |
| Dynamic | |
| Innovative | |
| Powerful | |
| Your privacy is our #1 priority. | Manage your privacy through simple settings. |
Users are trying to get things done. Write and structure your content so that people can easily scan and take the most important actions. Avoid using negative language.
Use headings and bullets to make your content easier to scan.
Think about what people need to know right away, and move that information to the top.
Use the active voice, particularly in product content. Start every CTA with a strong verb.
| Don’t | Do |
|---|---|
| Your company can use Stack Overflow to reach the world’s developers. We’re excited to help you start the developer hiring process. | Reach the world’s developers. Create job listing |
| For 14 days, you can try Teams for free. We make it easy for you to create a team. | Get started with a 14-day free trial. Create Team |
Be careful with negative language. It is usually longer, less friendly, and less active than positive language.
| Don’t | Do |
|---|---|
| “It doesn’t work” is not a problem statement. | Use specific examples in your problem statement. |
| Password cannot be empty. | Enter your password to continue. |
This content was adapted from Nicely Said and the Shopify Content Guide.