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.

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

Consolidating guidance for text editors #132

Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ If you want to contribute to the NHS.UK prototype kit guidance, then read our [c

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:

### command line
#### command line

Lower case. Only use for Windows instructions. Normally it will be ‘the command line’.

Expand All @@ -27,20 +27,36 @@ Title case.

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

Use ‘NHS.UK’ for products that are for delivery teams and not the public (find out more on the [NHS health writing A-Z](https://service-manual.nhs.uk/content/a-to-z-of-nhs-health-writing#N))This includes the NHS.UK prototype kit, NHS.UK design system, NHS.UK service manual or NHS.UK website.

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
* NHS design system
* NHS prototype kit

> We are changing how we talk about the Service M
vickytnz marked this conversation as resolved.
Show resolved Hide resolved

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.

#### NHS.UK prototype kit
#### NHS prototype kit

‘NHS.UK’ is in caps and ‘prototype kit’ in lower case (except where the NHS.UK is shown as a logo when it is then presented as ‘NHS Prototype kit’). Write out in full the first time it is used on a page, then call ’the kit’. Do not use ‘prototype kit’ if you can.
‘NHS’ is in caps and ‘prototype kit’ in lower case (except where the NHS.UK is shown as a logo when it is then presented as ‘NHS Prototype kit’). Write out in full the first time it is used on a page, then call ’the kit’. Do not use ‘prototype kit’ if you can.
vickytnz marked this conversation as resolved.
Show resolved Hide resolved

#### terminal

Lower case. Only use for Mac and Linux instructions. 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)'.


## Support

The NHS.UK prototype kit guidance website is maintained by NHS England. [Email us](<mailto:[[email protected]](mailto:[email protected])>), open a [Github issue](https://github.com/nhsuk/nhsuk.service-manual.prototype-kit.docs/issues/new) or get in touch on the [NHS digital service manual Slack workspace](https://join.slack.com/t/nhs-service-manual/shared_invite/enQtNTIyOTEyNjU3NDkyLTk4NDQ3YzkwYzk1Njk5YjAxYTI5YTVkZmUxMGQ0ZjA3NjMyM2ZkNjBlMWMxODVjZjYzNzg1ZmU4MWY1NmE2YzE).
56 changes: 26 additions & 30 deletions app/views/how-tos/build-basic-prototype/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,52 +10,48 @@
{% block makePrototype %}

<p>
This tutorial shows you how to prototype a fictional '{{exampleServiceName}}' service that will:
This tutorial shows you how to prototype a fictional '{{exampleServiceName}}'
service that will:
</p>
<ul class="nhsuk-list nhsuk-list--bullet">
<li>
ask 2 questions
</li><li>
show the user's answers for them to check
</li><li>
show a confirmation page
</li>
<li>ask 2 questions</li>
<li>show the user's answers for them to check</li>
<li>show a confirmation page</li>
</ul>
<p>
It will take about an hour to finish this tutorial, after you install the Prototype Kit.
</p>

<p>
Our prototype will look a bit like this:
It will take about an hour to finish this tutorial, after you install the
Prototype Kit.
</p>

<p>Our prototype will look a bit like this:</p>

<figure class="nhsuk-figure">
<img class="nhsuk-figure__image" src="/images/tutorial-overview.png" alt="The first page has the title 'Start page' with the button 'Start now'. This is linked to a second page with the title 'Question 1' and a 'Continue' button. This forks to 2 different pages. 1 is titled 'Ineligible'. 2 is titled Question 2. Question 2 is linked to a page titled 'Check answers'. This links to page 6, titled 'Complete'.">
<figcaption class="nhsuk-figure__caption">Diagram of 6 pages connected together.</figcaption>
<img
class="nhsuk-figure__image"
src="/images/tutorial-overview.png"
alt="The first page has the title 'Start page' with the button 'Start now'. This is linked to a second page with the title 'Question 1' and a 'Continue' button. This forks to 2 different pages. 1 is titled 'Ineligible'. 2 is titled Question 2. Question 2 is linked to a page titled 'Check answers'. This links to page 6, titled 'Complete'."
/>
<figcaption class="nhsuk-figure__caption">
Diagram of 6 pages connected together.
</figcaption>
</figure>


<h2>
Before you start
</h2>
<h2>Before you start</h2>

<p>
Before you start, you must <a href="/install/simple">install</a> and run the NHS.UK prototype kit.
Before you start, you must <a href="/install/simple">install</a> and run the
NHS.UK prototype kit.
</p>

<p>
You'll also need a code editor. These two are popular, well established and fairly accessible:
You'll also need a code editor. Any HTML text editor will do, but we recommend
<a href="https://code.visualstudio.com">Visual Studio Code</a> (also known as
VS Code). This is because it is free, fairly accessible, and has lots of
useful features.
</p>


<ul class="nhsuk-list nhsuk-list--bullet">
<li><a href="https://code.visualstudio.com">VS Code</a></li>
<li><a href="https://notepad-plus-plus.org">Notepad++</a> (Windows only)</li>
</ul>


<a class="nhsuk-button" href="open-prototype-in-editor">Start now</a>

<p>
<a class="nhsuk-button" href="open-prototype-in-editor">Start now</a>
</p>

{% endblock %}
2 changes: 1 addition & 1 deletion app/views/install/requirements.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h2>Software you need</h2>
<ul>
{% block branchingContent %}{% endblock %}
<li>Node.js (LTS version, 8 or higher)</li>
<li>HTML text editor (such as Atom, VS Code etc)</li>
<li>HTML text editor (such as Visual Studio Code)</li>
</ul>

<p>This guide will show you how to install this software.</p>
Expand Down
2 changes: 1 addition & 1 deletion app/views/install/text-editor.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ <h1>

<p class="nhsuk-lede-text">You'll need an HTML text editor to edit and make changes to your prototype.</p>

<p>Any HTML text editor will do, but we recommend Visual Studio Code which is free and has lots of useful features.</p>
<p>Any HTML text editor will do, but we recommend Visual Studio Code (also known as VS Code). This is because it is free, fairly accessible, and has lots of useful features.</p>

<p><a href="https://code.visualstudio.com/Download" target="_blank" rel="noopener">Download Visual Studio Code (opens in new window)</a></p>

Expand Down