• Home
  • Content Playbook

Content design playbook

This playbook helps CPNI staff develop better content and increase engagement with their audience. Following these principles informs how to structure new content and provide a framework for ongoing development

Last Updated 15 July 2021

Writing content for CPNI

We have developed the CPNI content playbook to assist staff in developing clear, easy to understand information. The steps outlined here provide a guide for content owners to follow, outlines the design system and how to meet accessibility requirements. 

This is an ALPHA version of the content playbook. We welcome your feedback on how it can be improved.

Please speak to the CPNI communications team for further information.

1 - Start with a user need

When creating content, its important to understand your users. Asking the right questions will help you do that. You’ll need to find out:

  • who your likely users are
  • what they’re trying to do
  • how they’re trying to do it now
  • how their life or work influences what they do and how
  • there current working experience and organisational risks

 

2 - Writing your content

Use meaningful headings

Meaningful headings make your content more accessible as they help users navigate the page. You should remember to format headings correctly using markdown.

Explain all abbreviations and acronyms

Before using the acronyms, you should explain the term first and include the acronym in brackets e.g. Operational Requirement (OR). You do not need to explain acronyms that are well known and in common use, such as UK, EU or VAT.

Keep sentences short

Read the sentence aloud. If you have to take a breath, you need to shorten or break up the sentence. Avoid wordiness by cutting useless modifiers and breaking up long thoughts into several sentences. If the topic is complicated, balance it by using short sentences to explain things.

Keeping sentences short helps with accessibility.

Using descriptive links helps users know where a link will take them, or what downloadable linked content is. Do not use ‘click here’ as link text.

Example 1 Example 2 Example 3

Click here to download our terms and conditions

Change to: Download our terms and conditions (PDF, 4.2MB)

Go to this webpage for our master’s course list. 

Change to: The Courses for 2019-20 page has a full list of our master’s courses.

Visit us our webpages: ww.example.co/openaccess

Change to: Visit our Open Access site

Plain English Examples

3 - Embedding videos within content

Videos can be displayed in two ways:

1. Embedded Video

When using videos within content, we can embed them onto the page where they will appear as full width. This is to meet accessiblity regulations and provide consistency across the platforms. The sample video below shows the correct dimension. Please speak with one of the communications team for further assistance.

2. Pop-up Video

We can also use our new functionality of the pop-up video. This video can be linked from any word, however, for accessiblity reasons, they must have a transcript attached. Here is an example: ​TBYL GLITCH video​ 

Please speak with one of the communications team for further assistance.

4 - Selecting images

These websites provide images, icons, etc to be used within your content.

  Description Paid
iStock Discover royalty-free images, illustrations and videos that will make you stand out. Yes
Unsplash

The internet’s source of freely-usable images.The internet’s source of freely-usable images.

Free
nounproject

Icons and Photos For Everything

Mixture
freepik.com

Graphic resources for everyone - Find Free Vectors, Stock Photos and PSD

Free
icons8.com Free icons, photos, etc Free

 

5 - Meeting accessibility requirements

Government regulations require accessiblity to be thought about from the start. 

Perceivable

Content must be available to at least one of your senses. 

  • e.g. for visual impairments can text be increased in size? For hearing impairments is there a transcript available for a video to be read?
Operable

Ensure users can find and use your content, regardless of how they choose to access it. Not everyone uses a mouse, some may have to use a keyboard or speech recognition software.

  • Can your content be accessed using different input devices?
Understandable

The content needs to be understandable and accessible to a range of cognitive abilities. Can users understand your content and how the service works?

  • Use clear and simple language that's easy to understand, e.g. plain English and short sentences.
  • Make sure interfaces are consistent and predictable. 
Robust

Webpages need to be built to be compatible with the technologies that people are using. Compatibility with assistive technology agents and can accurately interpret content.

  • Can your content be interpreted reliably by a wide variety of user agents?
  • Does the content work with screen readers or older browsers? 

More guidance on designing for accessilbility can be found on the gov.uk website. 

    6 - Style guide principles

    Copyright your documents

    • It is good practice to mark your work with the copyright symbol (©) and the year of creation.
    • This should be visible on each page of your document 
    • ®  is used within the Catalogue of security only

    Web page Design 

    • Blue banner text provides a brief overview of what the page contains.
    • The Excerpt is pulled in to other pages (such as landing pages and search results) and provide a preview of what the page contains too. In most cases this can be the same as is used in the blue banner. Please note, there are restrictions regarding the length, with a maximum number of characters allowed.
    • All blue banners and excerpts will have no full stops at the end
    Page level/layout Modules available to use on the page Page Example

    Level 1 landing page

    blue banner with excerpt

    grid layout displaying all related pages/topics

    Personnel and People Security
    Level 2 landing page

    blue banner with excerpt

    overview content

    grid layout for associated content

    Windows and Glazed Facades
    Level 3 page layout - left hand side navigation

    blue banner or optional image with excerpt                                  

    side navigation to act as anchor links for longer content pages

    include the use of bulleted text and call out quotes

    adaptable content blocks that can be used with background image, colour blocks, content with link and images, gradient content and iconography to highlight content

    Professionalising Security

    Disrupting Hostile Reconnaissance

    Marauding Terrorist Attacks

    Level 3 page layout - full width

    blue banner or optional image with excerpt 

    include the use of bulleted text and call out quotes

    adaptable content blocks that can be used with background image, colour blocks and  iconography to highlight content

    Forcible Attack Resistant Material (FARM) Project

    7 - Promotion of content on the digital platforms

    Home slider (Extranet only)

    • Imagery to be provided by content owner or request put to Comms Team (preferably landscape orientation)
    • 6 home slides at one time
    • 4-week duration of home slide
    • Limit banner title to 4-5 words
    • Limit banner description to 15 words
    • Text can be black or white, and be positioned left, right or centre, depending on the image

    What's New box (Public website only)

    • Imagery to be provided by content owner or request put to Comms Team
    • 5 What's New content boxes at one time
    • Limit excerpt to 22 words
    • 6-week duration of content in What's New box

    Featured Guidance (Public website only)

    • For campaigns/guidance collections
    • 3 featured guidance pieces displayed at one time
    • Descriptive text (excerpt) is pulled from the landing page
    • Imagery is pulled from the landing page

    Alert (Extranet only)

    • Send an email alert as a means of making users aware of new content helping them to keep up to date with the latest information
    • Subject of email to be catchy and attention-grabbing
    • Include page title, URL of new/updated page and a short description of your content
    • If the member is not logged in they will need to login before they can view the page
    • Once logged in they will be redirected automatically to the new/updated page

    8 - Logo usage guidelines

    The CPNI logo is used to distinguish our brand quickly and simply. There are a few guidelines which should be followed whenever using the logo.

    • Space around the logo - There should be sufficient clear space around the logo to let it breathe and prevent it’s clarity and visual impact from being obstructed.
    • Logo size -  The logo should be legible at any size. Do not use our full logo unless there is ample space to allow for legibility.
    • Do not stretch or distort the logo.
    • Images uploaded should be ‘optimised for web' (i.e. the file size should ideally be under 200kb).

     

    9 - Analytics

    We use two web analytic services:

    • For Public website only - Google Analytics to track and report website traffic 
    • For Public and Extranet -  Matomo provides reports on the websites and its visitors, including the search engines and keywords users have used, the files they have downloaded and more and information on what type of device has been accessing the site (desktop, tablet, smartphone).

    Further tools and resources

    • Hemingway plain english checker tool - The Hemingway app is a third party tool. You must not use it for any sensitive or personal information. You can use the browser-based version, which is free, or the app, which is paid for. Check with your organisation’s IT policy if you are unsure.
    • Plain English Campaign - An organisation promoting plain english communications. Their website features resources to help improve your writing.
    • GDS Style Guide - The Government Digital Service style guide covers style, spelling and grammar conventions for all content published on GOV.UK, arranged alphabetically.

     

     

    Did you find this page useful? YesNo
    Thank you for your feedback. If you have any further suggestions on how this information can be made even more useful to improve your experience, feel free to share details below.
    Thank you for your feedback. Sorry to hear that you haven't found this information useful. Please help us improve your experience and share how we can make this information more useful for you.