Writing principles & style

Writing principles & style guideline is updated on 18 Oct 2018

Principles

Follow these principles to deliver consistent content:

1. Straightforward

Make sure content is short and scannable for users to easily navigate through UIs.

DO
Keep UI texts short:
Log in to view Saved Jobs
DON’T
Write unnecessarily long instructions:
You’ll need to log in first before you can view Saved Jobs
DO
Focus on the most important topics for the situation:
Keep your SiVA login details and password to yourself. Don’t share them with anyone.
DON’T
Complicate the message by covering too many topics:
There are many scammers these days, so keep your SiVA login details and passwords to yourself. Never reveal them to anyone, not even to your colleagues or a person who claims to be from JobStreet.com. We will never ask for your login details.
DO
Write user-related points:
Job ad package will expire on 21st Dec 2018. Renew now with a 5% discount.
DON’T
Write about the background process:
According to our system, your job ad package will expire on 21st Dec 2018. Would you like to have one of our Account Managers to renew your package with a 5% discount?

2. Inclusive

Use words that can be easily understood across all reading levels.

DO
Keep translations in mind:
EN: Don’t want to miss out on jobs like these?

TH: ไม่อยากพลาดตำแหน่งงานดีเหล่านี้ใช่หรือไม่

ID: Jangan lewatkan lowongan pekerjaan seperti ini
DON’T
Forget that translated languages take more space than the English version:
EN: According to our system, your job ad package will expire on 21st Dec 2018. Would you like to have one of our Account Managers to renew your package with a 5% discount?

TH: ตามระบบของเราแพคเกจโฆษณาตำแหน่งงานของคุณจะหมดอายุในวันที่ 21 ธันวาคม พ.ศ. 2561 คุณต้องการให้ผู้จัดการบัญชีรายใดของคุณสามารถต่ออายุแพคเกจด้วยส่วนลด 5% ได้หรือไม่?

ID: Menurut sistem kami, paket iklan pekerjaan Anda akan berakhir pada 21 Desember 2018. Apakah Anda ingin memiliki salah satu Manajer Akun kami untuk memperbarui paket Anda dengan diskon 5%?
DO
Use words that everyone can understand:
Turn off your AdBlock to keep using our services.
DON’T
Use technical jargons, unless if it’s critical:
Disable AdBlock to gain access on our platform.
DO
Use simple, expressive words:
Great job! You’ve just posted your first job ad.
DON’T
Use slangs, internet memes, or proverbs:
You go, dawg! Your first job ad, ay?

3. Empower

Encourage the users as they navigate through the UIs.

DO
Use positive language to encourage:
Great job! You’ve just posted your first job ad.
DON’T
Write automated messages, unless if it’s critical:
Job ad posted.
DO
Use positive language to reduce the effect of error messages:
Oh no… We can't seem to save your search right now. Please try again later.
DON’T
Write messages that don’t explain the error, unless if it’s critical:
Search failed. Try again later.
DO
Explain the actions that users need to take:
Hmm, your internet seems to be down. Please refresh your page.
DON’T
Expect the users to understand the actions that they need to take:
Internet not connected.

Style

Adhere to these styles for an overall look and feel that is uniformed:

1. Write in British English

Write in British English spellings as many English-reading users are from Commonwealth countries.

DO
Use suffix -ise/-yse/-isation in spellings
E.g. organise, analyse, specialisation, organisation, visualise
DON’T
Use suffix -ize/-yze/-ization in spellings
E.g. organize, analyse, specialization, organization, visualize
DO
Use suffix -re in some common spellings:
E.g. centre, litre, metre, fibre, theatre, manoeuvre, etc
DON’T
Use suffix -er in some common spellings:
E.g. center, liter, meter, fiber, theater, maneuver, etc
DO
Insert the letters OU in the middle of words that end with an R:
E.g. colour, favour, odour, neighbour, behaviour, humour, labour, flavour, etc
DON’T
Forget to insert the letter U in words that end with an R:
E.g. Color, favor, odor, neighbor, behavior, humor, labor, flavor, etc
DO
Use British English spellings:
E.g. Traveller, travelling, licence, defence, offence, practice, enquire
DON’T
Use American English spellings:
E.g. Traveler, traveling, license, defense, offense, practise, inquire

2. Write in active sentences

Active sentences keep content short.

DO
Use verbs first to help users focus on an action:
Complete these questions. Show employers that you’re serious about this role.
DON’T
Start with the objective first, unless if it’s necessary for context:
You can show employers that you’re serious about this role by completing these questions.
DO
Use present tense to guide users in the current UI:
Find for the right candidate in our Talent Search.
DON’T
Use past tense often as this may confuse users:
Found the right candidate yet? We have them here in Talent Search.
DO
Use declarative sentences:
Save this search
DON’T
Use interrogative sentences, unless if it’s meant to start a conversation and there’s no space limitations:
Would you like to save this search?

3. Address users clearly

Address users in either the first or second person form, depending on the suitability of context.

Notes:
First person (“I” or “my”): Helps emphasise the user's ownership of content or actions.
Second person (“you” or “your”): Speaks directly to users using conversational UIs.

DO
Emphasise the ownership of content with first person form:
I agree to the following terms and services.
DO
Speak directly to users with second person form:
You have 15 credits. Post a job ad now.
DON’T
Combine both first and second person forms into one sentence:
Edit your About Me description to make it more attractive for employers.

4. Use consistent words

Use words in a consistent manner across your UI features.

DO
Use the same spelling style across the UI features:
Your Stand Out Listing add-on is now available. You can use Stand Out Listing in your job ad.
DON’T
Write spelling styles differently across every UI:
Your Standout Listing add-on is now available. You can use Stand Out Listing in your job ad.
DO
Use the same term to convey a particular noun or concept:
Answer these questions that the employer has picked; the employer would like to get to know you better.
DON’T
Use different terms to convey a particular noun or concept:
Answer these questions that the hirer has picked; the employer would like to get to know you better.

5. Write in sentence case

Write in sentence case to make messages easy-to-read.

DO
Write titles or headers with only the first letter capitalised:
Get to know more about JobStreet.com.
DON’T
Put capitalised letters at the front of every word in a tile or header:
Get to Know More About JobStreet.com.
DO
Keep the first letters of each proper noun capitalised:
With Talent Search, you can find the right candidate easily.
DON’T
Spell proper nouns like regular nouns:
With talent search, you can find the right candidate easily.