Skip to content

Commit 8aaec7e

Browse files
authored
Style guide various 2 (#1689)
* docs: remove duplicate entry for unlock list * docs: 3 new entries * docs: removing MOJ changes from style guide entry * docs: code tweaks * docs: code tweak
1 parent 63c3647 commit 8aaec7e

File tree

2 files changed

+46
-13
lines changed

2 files changed

+46
-13
lines changed

docs/style-guide-updates.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,42 @@ lede: 'New and updated entries in the <a href="/content-standards/style-guide/">
1313
<th scope="col" class="govuk-table__header" aria-sort="none">Type</th>
1414
<th scope="col" class="govuk-table__header" aria-sort="none">Description</th>
1515
<th scope="col" class="govuk-table__header" aria-sort="descending">Date</th>
16-
</tr>
16+
</tr>
1717
</thead>
1818
<tbody class="govuk-table__body">
19+
<tr class="govuk-table__row">
20+
<td class="govuk-table__cell">
21+
<a href="/content-standards/style-guide#acronyms-and-initialisms"><b>acronyms and initialisms</b></a>
22+
</td>
23+
<td class="govuk-table__cell">
24+
<span class="govuk-tag govuk-tag--blue">Updated</span>
25+
</td>
26+
<td class="govuk-table__cell">
27+
<p>This change involves adding guidance on using sentence case when writing acronyms out in full. Strengthened the guidance on using upper case for initialisms rather than mixing cases.</p>
28+
<td class="govuk-table__cell" data-sort-value="20250829">29 August 2025</td>
29+
</tr>
30+
<tr class="govuk-table__row">
31+
<td class="govuk-table__cell">
32+
<a href="/content-standards/style-guide#rosh-%28risk-of-serious-harm%29"><b>ROSH (risk of serious harm)</b></a>
33+
</td>
34+
<td class="govuk-table__cell">
35+
<span class="govuk-tag govuk-tag--blue">Updated</span>
36+
</td>
37+
<td class="govuk-table__cell">
38+
<p>This change involves using sentence case when writing ROSH out in full.</p>
39+
<td class="govuk-table__cell" data-sort-value="20250829">29 August 2025</td>
40+
</tr>
41+
<tr class="govuk-table__row">
42+
<td class="govuk-table__cell">
43+
<a href="/content-standards/style-guide#rotl-%28release-on-temporary-licence%29"><b>ROTL (release on temporary licence)</b></a>
44+
</td>
45+
<td class="govuk-table__cell">
46+
<span class="govuk-tag govuk-tag--blue">Updated</span>
47+
</td>
48+
<td class="govuk-table__cell">
49+
<p>This change involves using sentence case when writing ROTL out in full.</p>
50+
<td class="govuk-table__cell" data-sort-value="20250829">29 August 2025</td>
51+
</tr>
1952
<tr class="govuk-table__row">
2053
<td class="govuk-table__cell">
2154
<a href="/content-standards/style-guide#victim-survivor-%28of-domestic-abuse%29"><b>victim-survivor (of domestic abuse)</b></a>
@@ -28,7 +61,7 @@ lede: 'New and updated entries in the <a href="/content-standards/style-guide/">
2861
<p>However, if you’re developing a product or service that victim-survivors use, it may be more appropriate to reference their experience instead of using this term.</p>
2962
<p>For example, you could use the question ‘Have you experienced domestic abuse?’ rather than ‘Are you a victim-survivor of domestic abuse?’. See <a href="/content-standards/style-guide#domestic-abuse">guidance on using the term domestic abuse</a>.</p>
3063
<td class="govuk-table__cell" data-sort-value="20250812">12 August 2025</td>
31-
</tr>
64+
</tr>
3265
<tr class="govuk-table__row">
3366
<td class="govuk-table__cell">
3467
<a href="/content-standards/style-guide#domestic-abuse"><b>domestic abuse</b></a>

docs/style-guide.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ First published: 18 December 2024
1616
</p>
1717

1818
<p class="govuk-!-margin-bottom-0">
19-
Last updated: 12 August 2025
19+
Last updated: 29 August 2025
2020
</p>
2121

2222
<p class="govuk-!-margin-bottom-6">
@@ -28,22 +28,22 @@ Last updated: 12 August 2025
2828

2929
### acronyms and initialisms
3030

31-
Acronyms and initialisms in services do not need to be spelt out if they are well understood by your audience. This also helps if it's difficult to spell them out, such as in a table.
31+
Acronyms and initialisms in services do not need to be spelt out if they are well understood by your audience. This also helps if its difficult to spell them out, such as in a table.
3232

33-
If users are familiar with the acronym or initialism but you would still like to help them, you can spell it out afterwards, for example 'PDU (probation delivery unit)'.
33+
If users are familiar with the acronym or initialism but you would still like to help them, you can spell it out afterwards, for example PDU (probation delivery unit).
3434

3535
For guidance or long-form content, spell them out on first mention (following the [abbreviations and acronyms guidance on GOV.UK](https://www.gov.uk/guidance/style-guide/a-to-z-of-gov-uk-style#abbreviations-and-acronyms)).
3636

37-
There is little consensus in the department about how to style some acronyms and initialisms, especially if one letter refers to a preposition.
38-
39-
However, you should consider writing acronyms and initialisms entirely in upper case. For example, ROSH instead of RoSH and MOJ instead of MoJ. This is because:
37+
You should write acronyms and initialisms entirely in upper case, even if some words are prepositions like 'of'. For example, ROSH instead of RoSH. This is because:
4038

4139
- studies, such as in the [Memory and Cognition journal article on reader ability](https://link.springer.com/article/10.3758/BF03198246), suggest that abbreviations written in a mix of upper and lower case are harder to read, especially for less skilled readers
42-
- it follows the convention established by the abbreviation of [ROTL for Release on Temporary Licence](#rotl-%28release-on-temporary-licence%29) and so helps to improve consistency
40+
- it follows the convention established by the abbreviation of [ROTL for release on temporary licence](#rotl-%28release-on-temporary-licence%29) and so helps to improve consistency
4341
- guidance from the Guardian and GOV.UK recommends writing similar abbreviations such as MOT and FOI entirely in upper case
4442

4543
You should use a mix of upper and lower-case letters when referring to the names of systems such OASys and NDelius.
4644

45+
When spelling acronyms out in full, you should use sentence case unless there is a good reason to capitalise it. For example, ROSH (risk of serious harm). This is because it is easier to read and consistent with the [Service manual guidance on writing for user interfaces](https://www.gov.uk/service-manual/design/writing-for-user-interfaces).
46+
4747
### alerts (DPS only)
4848

4949
Only use 'alerts' when talking about alerts created in NOMIS or DPS (Digital Prison Services).
@@ -502,17 +502,17 @@ Read the [full list of release dates (MoJ staff only)](https://justiceuk.sharepo
502502

503503
Someone is on remand if they are placed in custody whilst awaiting trial. Read [guidance on how to talk about people in the justice system (MoJ staff only)](https://justiceuk.sharepoint.com/:w:/r/sites/Contentdesigncommunity/_layouts/15/Doc.aspx?sourcedoc=%7B3D0B8958-EB4D-4183-A284-D507A4AE29E5%7D&file=How%20we%20talk%20about%20people%20in%20the%20justice%20system%20.docx&action=default&mobileredirect=true).
504504

505-
### ROSH (Risk of Serious Harm)
505+
### ROSH (risk of serious harm)
506506

507507
One of the risk categories used in risk and need assessments in OASys.
508508

509-
Use upper case.
509+
Use upper case for the acronym (ROSH, not RoSH). Use sentence case when spelling out the full meaning (risk of serious harm, not Risk of Serious Harm).
510510

511511
Users may well understand the acronym on its own. You could also consider using the acronym first and then spelling it out in brackets.
512512

513-
### ROTL (Release on Temporary Licence)
513+
### ROTL (release on temporary licence)
514514

515-
Use upper case.
515+
Use upper case for the acronym (ROTL, not RoTL). Use sentence case when spelling out the full meaning (release on temporary licence, not Release on Temporary Licence).
516516

517517
Users may well understand the acronym on its own. If you have evidence of this, use the acronym first and then spell out in brackets.
518518

0 commit comments

Comments
 (0)