We want to ensure online services are easy to use, intuitive and focused on customer needs. To achieve this we have web design principles, web standards for page authors and web standards for developers.
Below you will find universal good practice to help you write for the web.
We follow gov.uk's writing style guide
- Be concise - make content brief and to the point.
- Meet user needs - publish only what customers need to know to complete their task.
- Know your audience - their search terms, questions and how they read a page.
- Don't use FAQs - answer questions in your content.
- Include keywords and meta-description in your content to boost search rankings.
- Use active voice (not passive) - this will help you write with concise and clear language.
- Break up text into subject areas with headings and sub-headings.
- Put the most important information first.
- Good content is quick and easy to read - use simple words that are easy to understand.
Use the index links below to jump to information further down this page:
- Avoid creating unnecessary new pages
- Writing for your audience
- Writing for the web
- Creating and adding documents
- Shortcut URLs
- Contact Web and Digital Services
1. Avoid creating unnecessary new pages
- Is the content needed and will it have an audience? Contact Web and Digital Services for guidance.
- If the information is not specific to Surrey County Council, link out to the information on another reputable website.
- Avoid duplication. Check if the information already exists (on our website or an external one).
- Consider adding new content to an existing page.
- If the new content is one subject or related subjects, condense the information to fit on one web page with headings for each new subject area.
2. Writing for your audience
Make sure your page completes the user's journey as follows:
- I have a question/need.
- I have found the correct page easily because the page title and description are clear.
- I understand the information on the page.
- I trust the information and can tell it is up-to-date.
- I found my answer/ I know what to do next/ I don't need anything else.
Make sure you also:
- write accessible web content that is suitable for a wide audience;
- be as clear as possible - leave out the jargon;
- answer all of your customer's most common questions in the body text and avoid FAQ pages;
- use keywords in your page titles and in your content - your audience will use these to search for your page;
- add keywords and a description to the metadata to boost internal and external (Google) search results.
3. Writing for the web
- Write from the customer's perspective using active sentences and personal pronouns (I, we, you).
- Write pages in the 'inverted pyramid/front loading style' ie start the page with the most important information.
- Write in Plain English to make sure your page can be understood by all of our customers.
- Avoid jargon and unnecessarily complicated words.
- Explain acronyms when you use them with the words spelt out first eg Surrey County Council (SCC).
- Aim to write sentences that are 15 to 20 words.
- Aim to write paragraphs that are three to four sentences.
- Use meaningful headings that can be scanned for content and context quickly.
- Follow our house style (available on s-net or from our Communications team).
- Make sure your web page content is accurate and up-to-date.
- Do not use 'Page under construction', 'content awaited' or similar on a published page.
- Make headings and sub headings short and meaningful.
4. Creating and adding documents
- Documents should always be converted to PDF and meet PDF standards unless Web and Digital Services can publish other file types on your behalf.
- Do not add documents owned by other organisations as they may be copyright protected. Create an external link to the website where they are located and the customer will always have the latest version.
- Prepare your document correctly for the web - please see the publications guidelines (on S-Net) and PDF web standards.
- Always get your document signed off by your Service before publication. Do not publish draft documents.
- Make sure your file size is 1MB or less. If it isn't, contact Web and Digital Services and we can help.
- Add a clear title and meaningful description for the document so customers know exactly what they are opening.
5. Shortcut URLs
- Decide if you will need a shortcut web address, eg www.surreycc.gov.uk/schoolmeals.
- Check with Web and Digital Services to make sure the shortcut URL address does not already exist and that it meets web standards.
- For technical reasons, we cannot set up the shortcut URL until the page it links to has been published.
- Do not publicise the shortcut URL before all of the relevant web pages are published and we the shortcut is created.
6. Contact Web and Digital Services
Please contact Web and Digital Services for further guidance on preparing your content for the web or to discuss your plans and requirements. Tel: 020 8541 8788. Email: firstname.lastname@example.org
Gov.uk's writing style guide can be found on their Content design pages.