Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #176

Merged
merged 1 commit into from
Dec 10, 2024
Merged

Update README.md #176

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 14 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,35 +14,34 @@ If you want to contribute to the NHS prototype kit guidance, then read our [cont

### Style guide

We normally use the [NHS content guide](https://service-manual.nhs.uk/content) for terms. But there are some terms that are only used in the guidance for the kit:
We normally use the [NHS digital service manual content guide](https://service-manual.nhs.uk/content) for terms. But there are some terms that are only used in the guidance for the kit.

#### command line

Lower case. Only use for Windows instructions. Normally it will be 'the command line'.
Lower case. Only use for Windows instructions. Normally it will be "the command line".

#### Git, git, Github
#### Git, git, GitHub

Git has an upper case G when talking about a version control system (for example 'use GitHub '), and lower case G when part of code, for example `git status`.
Git has an upper case G when talking about a version control system (for example "use GitHub"), and lower case G when part of code, for example `git status`.

GitHub is camel case with an upper case H - for example, 'use GitHub Desktop'.


#### GOV.UK Prototype Kit, GOV.UK Design System and other GOV.UK products
#### GOV.UK prototype Kit, GOV.UK design system and other GOV.UK products

Title case.
Sentence case.

#### Headings and tab titles
Use sentence case, for example 'How to download the prototype kit'.
Tab titles (the title of the page as shown in the browser tab) may be different from the page H1, for example a tab title may say 'How to download the prototype kit' and the H1 say 'Download the prototype kit'.
Use sentence case, for example "How to download the prototype kit".
Tab titles (the title of the page as shown in the browser tab) may be different from the page H1, for example a tab title may say "How to download the prototype kit" and the H1 say "Download the prototype kit".

#### JavaScript

Camel case with an upper case S.

#### NHS, NHS.UK, NHS England


We are changing how we talk about tools for delivery teams. These used to be called 'NHS.UK' products but we are now removing the '.UK'. This means that we talk about the:
We are changing how we talk about tools for delivery teams. These used to be called "NHS.UK" products but we are now removing the ".UK". This means that we talk about the:

* NHS frontend (though this is still sometimes called 'NHS.UK frontend')
* NHS digital service manual
Expand All @@ -51,26 +50,25 @@ We are changing how we talk about tools for delivery teams. These used to be cal

For talking to the public about the website (find out more on the [NHS health writing A-Z](https://service-manual.nhs.uk/content/a-to-z-of-nhs-health-writing#N))


#### NHS England laptops

Use 'NHS England Windows laptops' instructions for people using corporate laptops.
Use "NHS England Windows laptops" instructions for people using corporate laptops.

#### NHS prototype kit

'NHS' is in caps and 'prototype kit' in lower case (except where it is shown next to the NHS logo when it is capitalised as 'NHS Prototype kit'). Write out in full the first time it is used on a page, then call 'the kit'. Try to avoid 'prototype kit'.
"NHS" is in caps and "prototype kit" in lower case (except where it is shown next to the NHS logo when it is capitalised as "NHS Prototype kit"). Write out in full the first time it is used on a page, then call "the kit". Try to avoid "prototype kit".

#### quotation marks

Use straight quotes only (not smart or curly quotes). More detail is in the <a href="https://service-manual.nhs.uk/content/formatting-and-punctuation#quotation-marks">Formatting and punctuation</a> part of the Digital service manual content guide.
Use double straight quotes only (not smart or curly quotes). More detail is in the <a href="https://service-manual.nhs.uk/content/formatting-and-punctuation#quotation-marks">Formatting and punctuation</a> part of the NHS digital service manual content guide.

#### terminal

Lower case. Usually it will be 'the terminal'.
Lower case. Usually it will be "the terminal".

#### Visual Studio Code

Title case. When you use it for the first time in a guide, start with 'Visual Studio Code (also known as VS Code)'.
Title case. When you use it for the first time in a guide, start with "Visual Studio Code (also known as VS Code)".


## Support
Expand Down
Loading