Components: Do and Don't lists

Do and Don't lists

Use Do and Don't lists to help users understand more easily what they should and shouldn't do.

When to use it

Use a Do and Don't list to give users clear and simple advice, for example about what to do at an assessment or what to avoid.

How to use it

Keep your points as brief as possible.

Dos normally come before Don'ts.

It is alright to just have Don'ts if there aren't any Dos and just Dos if there aren't any Don'ts.

Treat the heading as a lead-in and the items under the heading as part of 1 long sentence. Start each bullet point lower case. With Dos, just write the action. With Don'ts, include "do not" at the beginning of each bullet point.

If using 'Assessors will look for' instead of 'Do' or 'Things to avoid' instead of 'Don't' start each bullet with a description of a 'thing', for example, 'research findings that are about user preferences', or 'a plan for ongoing research'.

Code

The ruby extension accepts 3 parameters, array (list) of items, Panel title, type (do or dont)

The first parameter is an array, these must be a comma separated list of items contained within square brackets []. Even if there is only 1 item in the list, for example: ["one list item"]

Do example

<%= do_dont_list(["Item 1","Item 2","Item 3"], "List title", "do") %>

Don't example

<%= do_dont_list(["Item 1","Item 2","Item 3"], "List title", "dont") %>

When not to use it

• If you only have 1 Do - or 1 Don't, consider using inset text or warning text instead.