Patterns

Best practice design solutions for specific user-focused tasks and page types

Writing summaries

Use the summary to give more information on what the content is about.

Why should we include a summary

Summaries provide several purposes in LocalGov Drupal.  They:

  • act as a 'teaser text' on the parent page (or the page that comes before it)
  • show up on all pages (guide pages all take the summary from the overview page, and service pages will take the summary from the service landing page)
  • show up in external and internal search results

Note:  Even though the summaries don't show up on individual guide pages or service pages, they should still be written (in the back end), as they will be used in internal and external search results.

What to include in a summary

A summary should provide:

  • more information than what the title suggests
  • what a user can do
  • key information the page or section includes – for example, you could include the fee or the type of user the content is aimed at

Correct use of a summary:

Title:  Get married or form a civil partnership: Overview

Summary:  What you need to know and do to get married or form a civil partnership in Essex. Includes booking a registrar, a venue and giving notice. 

Incorrect use of a summary:

Title: Get married or form a civil partnership: Overview

Summary: We are offering notice appointments for ceremonies taking place before 1 September 2023.

Summaries should also end in a period (full stop) for accessibility reasons.