DFE-Digital / design

Design manual for the Department for Education. This service is owned by the Design Ops team. Changes and approvals are managed by @andyjones81 or DfE Design Ops. (See the DFE Design Manual for details)
https://design.education.gov.uk
2 stars 5 forks source link

DfE content style guide #111

Open kerryalyons opened 1 year ago

kerryalyons commented 1 year ago

Fix typo in intro:

Add 'from' to - 'This style guide includes words that differ the GDS style guide'

adyhoran1 commented 1 year ago

Could you include:

Could you also remove the extra space after 'local council' in this sentence: The GDS style guide uses [local council ](https://www.gov.uk/guidance/style-guide/a-to-z-of-gov-uk-style#local-council).

SteveMilnes commented 12 months ago

Remove Case owner and Project owner from the guide in the section about job titles.

This conflicts with our guidance to avoid the job title as a descriptor. It's not a job title, but it's the kind of description that will become a way of naming a role that will at some point become outdated.

This guidance is taken from the RSD style guide, however we will be removing mentions of Project owner and replacing them with Assigned to in the products that make up the Manage academy projects team soon.

We should also remove the examples of Prepared for advisory board by and Completed by as they are not in use. Our SME has told us that Assigned to is what users understand most clearly and is the language that is widely used.

SteveMilnes commented 11 months ago

Could you include:

Could you also remove the extra space after 'local council' in this sentence: The GDS style guide uses [local council ](https://www.gov.uk/guidance/style-guide/a-to-z-of-gov-uk-style#local-council).

Hi @adyhoran1

Thanks for your suggestions. We've spoken about them as a group and decided:

We will remove the extra space from local council.

Sarah-DfE commented 11 months ago

To add to style guide:

'SENCo' - We follow the GOV.UK style guide for SEN and SEND and apply it to SENCo (special educational needs co-ordinator) and SENDCo (special educational needs and disabilities co-ordinator).

SteveMilnes commented 11 months ago

@adyhoran1 @Sarah-DfE I've made the PR for those content changes. Should appear in the style guide later today.

frankieroberto commented 11 months ago

One term to consider for the style guide:

"Maths" v "Mathematics" (or "it depends").

SteveMilnes commented 10 months ago

Daniel Deakin has suggested some changes based on GOV.UK style.

adyhoran1 commented 8 months ago

Suggestions of things to include:

  1. Abbreviations and acronyms - Readability Guidelines. To emphasise that abbreviations and acronyms make text harder to read.

  2. If writing acronyms out in-full would make the h1 too long. In this case, you could use the acronym in the H1 and put the full explanation later on in the page. Ideally in the first line or as early as possible in the main body copy

  3. Write acronyms in capital letters. This is implied in the GDS style guide, but we should be explicit about this in the DfE guide. Our assumption is that could help some neurodivergent colleagues who might not pick up the implication

  4. Use title case for division and team names. For example:

Regions Group Regional Services Division Regional Casework Services Record Concerns and Support for Trusts Manage Academy Projects

  1. use sentence case for document names. If the document name starts a sentence, the first letter should be uppercase. If it’s mentioned within a sentence, it should all be lower case. For example:

Articles of association Make sure the articles of association have been signed by the Secretary of State

  1. Regional Director. Should this be upper case because it's an official title, or lower case because there are 9 regional directors?
adyhoran1 commented 7 months ago

Suggested terms to add:

In the job titles section, could you also link to the job titles section of the GOV.UK style guide?

SteveMilnes commented 6 months ago

We should edit the example in the 'job titles' section. It's a bit shonky.

We try to avoid generic job titles because they can change regularly. We don't use the job title as an identifier alongside a name, for example:

Delivery officer: Joe Bloggs Caseworker: Francis Blunderbuss

We describe the thing that the job role does. This should make more sense to more people and help guard against future changes, for example:

Prepared for advisory board by: Joe Bloggs Completed by: Francis Blunderbuss Case owner Project owner"

We should probably say something like this instead:

We try to avoid generic job titles because they can mean different things to different people.

For example, a school business manager might have different responsibilities from one school to another.

Instead, use language that describes the thing a job role does. Something like, "The person who manages your recruitment should upload the job advert" rather than "Your HR Lead should upload the job advert".

For internal products and services, try not to use the job title as an identifier alongside a name, for example:

Delivery officer: Joseph Bloggs Caseworker: Josephine Bloggs Project lead: Joey Bloggs

We would write that a project is assigned to a particular person, for example:

Assigned to: Josephine Bloggs

Job titles can and do change as departments and divisions reorganise and restructure. Avoiding job titles can help to reduce confusion when those titles are no longer used.

kerryalyons commented 6 months ago

I will update this.