What it is
Any time you write something, another person should look over your work to check for:
- consistency of tone and style
- plain English
- content structure
- user-centred approach
- factual accuracy
You may need different people to check different aspects of your work. Tone and structure should be checked by another content professional to make sure it adheres to best practice, whereas factual accuracy should be checked by someone who knows the subject matter well.
We use two different terms for the review process, depending on who's reviewing the content:
- peer reviews (when another content designer is reviewing it)
- fact checks (when an expert on a subject is reviewing it)
Peer reviews are where another content professional checks things like:
- spelling and grammar
- metadata and tagging
Fact checks are where professionals in that subject area confirm the accuracy of the information. Usually they are referred to as Subject Matter Experts (SMEs). SMEs are usually involved early on to help explain complex information before you start writing.
Peer reviews and fact checks can be done by the checker alone, or they can be done in person where you work with the checker to 'pair review' or 'pair edit' your content.
Why it's important
Peer reviews help make sure your content matches your organisation's style guide and readability standards as well as meeting best practice standards, including:
- the use of thorough discovery for development
- checking of user journeys
- use of appropriate content types
- Content Management System requirements, like links to other information and metadata
Often when a content designer's working on a specific subject, they become fairly knowledgeable about the topic. Sometimes that means jargon - specific terms about the subject that the average user may not understand - can slip through into the content.
A second pair of eyes is helpful for catching jargon to make sure it's explained properly or removed.
Fact checking helps make sure your users are getting the right information. Out-of-date or wrong information can lead to problems for the user, like:
- wasted time
- missed opportunities
- loss of benefits
Incorrect information could also be a significant risk to an organisation's reputation.
How to do it
A peer review should happen before fact checking. This makes sure the fact checker sees the product in a version that's as close to complete as possible.
It's also important to do a peer review first because the reviewer may raise more questions that could require more information from a subject matter expert.
It's helpful if you have a peer review checklist. This means colleagues can make sure they check every aspect of your style guide and Content Management System (CMS) requirements as well as the more subjective aspects of style and tone.
Before your colleague starts the peer review, you should give them some background to the project - what discovery work you've done, organisational context, etc.
Your colleague will then review your content and can either make changes directly to the content in your CMS, or track changes in a Word document.
Content critiques or 'crits' can be a really useful way to get friendly constructive feedback on your content from like-minded content professionals.
If you've drafted some content, try gathering your team or work colleagues together for a short session to look collectively at what you've created and see if there are tweaks or improvements to be made.
After content has been peer reviewed, it's sent to a fact checker to make sure it's factually accurate and up to date. A fact checker is not supposed to change style or tone. You should establish this with them early on to avoid confusion when they review the content.
Often fact checkers and subject matter experts will want to change text to match a style that they're used to (like academic or policy writing), and sometimes they'll reintroduce jargon. It's the content designer's job to explain to them why the jargon has either been removed or explained in simpler language.
For situations like this, it's helpful to work with the fact checker in person and review edits through pair editing.
Pair review/pair editing
Pair reviewing involves going through any suggested changes with the peer reviewer or fact checker in person.
This is helpful because you can answer any questions they have right away. It also means if they've suggested changes to style choices you've deliberately made, you can talk through them. It also helps make sure their feedback has been understood correctly.
It is important to set a date for when each piece of published content should be reviewed and updated. Doing this when you first release the piece will stop you forgetting about it. Regularly reviewing content will let you see if it's meeting user needs or underperforming.
Plain English and readability tools
Digital Scotland Service Standard
This article offers guidance relevant to the following criterion from the Digital Scotland Service Standard:
- Understand users and their needs
- Solve a whole problem for users
- Design and deliver a joined-up experience
Peer review checklist
Peer reviewing involves recommending changes to content items so that they:
- are written in plain English
- are easy to understand
- adhere to our style guide
- are typo-free
When peer reviewing items, you don't always need to know much about the subject matter. But you do need to know what the user needs are, and whether it's a standalone content item, or part of a content plan. If it's not immediately clear, ask the person who wrote it for more details.
A citizen or business owner who's viewing the content may arrive at it because they don't know anything about the task that they need to complete. So bear this in mind when you're reading what's been drafted.
When you agree to do a review
Reply all to the request so everyone knows whether or not it's been picked up.
When you're requesting a peer review
Include the user needs in your email, so the person doing the review can check whether your content item meets them.
The peer review should be done by someone who's not part of the team you're working with. The person that you're working with should cast their eye over the content after the fact checker's got back with any changes.
What to check when you're doing a peer review
|Should be frontloaded and as short and succinct as possible.
|Should be as short as possible (try not to go over 3 words) and keyword specific.
|Should be plain English (short sentences, use the active instead of the passive, no jargon etc.). If the content's not easy to understand, run it through Hemingway or a similar tool.
|Words to use
|Short words instead of longer ones that mean the same thing, e.g. 'about' instead of 'regarding'.
|Simple positive contractions are fine (it's, you're). Be aware that users with English as a second language struggle with complex contractions. Do not use negative contractions, always write these in full (do not, cannot).
|Em vs en dashes
|Should use full stops and be non-sentence case. All bullets should start with the same part of speech e.g. a verb.
|SEO and Metadata
|If you were searching for information on how to complete this task, would you click on this listing in Google?
|Use numerals, not words.
|Check that the location's correct.
|Are they appropriate?
|Do you think someone would search for the content using these words?
|Should use a call to action that forms the basis of the hyperlink e.g. 'check your eligibility', 'complete the application form'.
|Check that all the links are working.
|Does this page meet the user needs? Cross check against them when doing your review.
|Check that the content is not duplicated or appears elsewhere on the site from a different perspective. If you search for a content item and there's a duplicate, make sure you're not publishing both.
|If you cannot find an appropriate alternative link, leave it unapproved and leave a comment in the peer review comments column.
If there are minor changes, like typos, just make the amends in the system. Flag up bigger changes in a Word document or email.
There is a problem
Thanks for your feedback