Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to write content #87

Closed
jeddy3 opened this issue Mar 22, 2018 · 1 comment

Comments

Projects
None yet
2 participants
@jeddy3
Copy link
Contributor

commented Mar 22, 2018

As a user of the design system
I want to know how to write content
So that there is a consistent experience across products

Description

Writing content is an integral part of any product. There are comprehensive Barnardo's content guidelines. However, it could be beneficial for designers and developers building products to be provided with a summary of these guidelines within the design system.

Links and resources

Acceptance Criteria

  • Confirm that a summary of the guidelines can be made open.
  • Add the guidance design system
  • Get feedback and approval from content teams
  • Addresses accessibility/usability considerations
  • Works on target devices and browsers
@jeddy3

This comment has been minimized.

Copy link
Contributor Author

commented Apr 11, 2018

Here's the list of guidance. It'll need to be tweaked to fall in line with the style within the Design system e.g.

"Dates should be written as: 9 January 2018, never use suffixes
Numbers between one and nine should be spelt out in full"

becomes:

You should:

  • write dates as 9 January 2018
  • spell out numbers between one and nine

Imagine you're talking to your reader
Straightforward and simple
Clear and concise
Avoid jargon
Use active verbs
Use inclusive language
One main idea per sentence
Short sentences
Use a bulleted list when paragraphs have more than four points
Start bullets with a lowercase
End bullets without a full stop

Punctuation and grammar

Avoid excessive use of bold
Use italics for general emphasis within body text
Use as few capital letters as possible
Dates should be written as: 9 January 2018, never use suffixes
Use the 12-hour clock
Numbers between one and nine should be spelt out in full
Use single quotation marks for quotes speech
Only use the ampersand when space is tight

Spelling

Barnardo’s (always with apostrophe)
email (no hyphen)
http:// (is not required, begin web addresses with www)
intranet (always lowercase)
online (one word)
per cent (should be spelt in words, unless used in tables)
postcode (no hyphen)
website (no hyphen)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.