NewcastleRSE / nhs_readability_react

ReactJS version of the NHS Document Readability project based on MUI-rte
1 stars 0 forks source link

Tips for first time users box #1

Open ldawson13 opened 1 year ago

ldawson13 commented 1 year ago

Tips for first time users box • Like this :-) • Could it be centralised? • Suggest cutting ‘first-time’. They could be tips for any user, not specifically first-time ones. • How do you get this box back if you want to refer back to the tips? Can there be a mechanism for this?

ldawson13 commented 1 year ago

I've drafted a bit of text for this as a starter for 10. Feel free to edit if you like.

The NHS Document Readability Tool helps you write simple and clear health information.

Copy and paste in text you’re working on already. Or start writing something new directly in the tool.

Use the options on the right hand side to get suggestions on how to make you writing easy to understand.

Once you’ve finished, copy and paste your text from the tool into a word document, email etc.

Please note: the tool does not check for spelling and grammar mistakes. You will need to use another programme to check for these.

rosselton commented 1 year ago

Text changed to 'Tips for users'. The box is now hidden permanently after being closed for the first time, so we need to think about where to put a 'show tips' button to bring it back.

ldawson13 commented 1 year ago

Perhaps we could have it at the top near the 'docs', 'contact' and 'login' text?

rosselton commented 1 year ago

The page has Hints and Tips modal which can be used as a duplicate of this box or can have more of different information.

ldawson13 commented 1 year ago

I think the hints and tips should be a separate thing and the 'Tips for first time users' should still pop up when people open the tool. Perhaps it could be called 'Welcome to the NHS Document Readability Tool'.

I've checked the reading age of the initial instructions and made some edits to lower it a bit. Text below.

The average reading age of adults in the UK in 9 to 11 years old. The information we write often has a higher reading age than this. This tool helps you write in a simple and clear way for the average UK reading age.

How to use this tool

Copy and paste text that you have written into the tool and make edits. Or start writing something new directly in the tool.

Use the options on the right hand side to find out the reading age of your text. Also find out what might make your writing hard to read. Edit your text and see the reading age change.

Once you’ve finished, copy your text from the tool into a word document, email etc.

Please note: the tool does not check for spelling and grammar mistakes. You will need to use another programme to check for these.

rosselton commented 1 year ago

Updated text

ldawson13 commented 1 year ago

Is it possible to get this box back now so it appears automatically when someone opens the tool in the browser?

rosselton commented 1 year ago

Done