Use active voice
In general, always try to use an active voice. It’s clearer and stops sentences from becoming too complicated or wordy.
An exception to this rule is when writing to remove culpability, so as not to blame a partner or third-party, or imply ownership of a certain action or outcome.
ie “Jira rejected your token.” vs. “Your token was rejected by Jira.”
In this case, to soften the wording, we could allow the second.
✅ Do |
🛑 Don't |
✅ Do |
🛑 Don't |
✅ Do |
🛑 Don't |
✅ Do |
🛑 Don't |
Avoid slang and jargon
Jargon is industry-specific “insider” language that can only be understood by people in a certain group. Slang is very informal, often inspired by the internet or culture trends, and can be specific to a generation. We prefer to stay away from both of these to make our language universal.
✅ Do |
🛑 Don't |
✅ Do |
🛑 Don't |
✅ Do |
🛑 Don't |
Idioms
Idioms, proverbs, and expressions are a rich playground for copy fun, however – since they’re not literal, they rely on a native level understanding of English. Therefore, we should consider when to use them wisely.
For example, in product writing this may be blank states or loading messages, in other words, touchpoints when there is a low-risk to creating potential confusion, and a welcome space for light humour or friendliness. Don’t use them near CTAs or conversion points.
Productboard’s social media channels in different languages are also great opportunities for idioms. After all, they’re a natural part of daily speech. And being natural and human involves an odd idiom or two. See what we did there?
In the localizations section, you’ll find our stance on using idioms in different languages.
✅ Do
Not this time. |
🛑 Don't |
Educate
We’re creating a new category and also have our own Productboard lingo. We can’t possibly expect customers to know what we mean right off the bat, so where possible, take any opportunity to educate – both on our language and how to use the product. If you use technical or Productboard specific language, try to explain.
✅ Do |
🛑 Don't |
✅ Do |
🛑 Don't |
Be clear and specific
Less is more. Also, consider that the magic is to be found in knowing what to leave out. Where possible, be specific. Being vague and general is unhelpful and bland.
✅ Do |
🛑 Don't |
✅ Do |
🛑 Don't |
Be consistent
Choose one consistent verb per action and noun per subject. Make sure you decide on either shorthand or full text, and always abide by the same singular vs. plural form across the UI.
✅ Do |
🛑 Don't |
✅ Do |
🛑 Don't |
Be inclusive and respectful
Use the word “inclusive” or “accessible” to describe design, products, services and places designed to provide a more equal experience to everyone. Be respectful of age, health conditions, heritage, and race. Avoid describing social class, or price points in an on the nose way.
✅ Do |
🛑 Don't |
✅ Do |
🛑 Don't |
✅ Do |
🛑 Don't |
✅ Do |
🛑 Don't |