Web style
Text styles
Text styles associated with the Software Help template should be used without modification. Additional styles and screen components may be coded into the webpage. Access additional style codes.
Bullet points
Use bullet points to describe steps that must be completed in
sequence. Bullet points should be introduced by a colon. Full stops should be used at the end of bullet points if the bullet
point is a complete sentence. If the sentence is incomplete, no full stop is
necessary. Note that full sentences should be grammatically correct and
begin with a capital letter. Incomplete sentences are written in lower case.
For example:
- This is a complete sentence which has a full stop at the end.
- incomplete sentences
Numbered points
Use numbered points for steps that must be completed in sequence to match number graphics on an accompanying image. Use the recommended number graphics for Software Help resources
Numbered points should be written as complete sentences and end with a
full stop. Note that full sentences should be grammatically correct and
begin with a capital letter.
For example:
- Select the assignment from the drop down list.
- Select the submission date range.
- Select Get Assignments.
Object names
Object names (eg buttons, windows) should be in bold text and written in the same case as the text used in the software application. For example:
"Select Save."
"The Insert Picture window will open."
Note: It is not always necessary to refer to objects as "buttons". For example, it is appropriate to write "Select OK" rather than "Select the OK button". Refer to a "button" only if necessary for clarification if there are several objects on a screen.
Hyperlinks
From an accessibility perspective, hyperlink text should be descriptive and make sense when taken out of context. For example:
"Download the Acrobat Reader software for free from the Adobe website." instead of "Download the Acrobat Reader software for free from the Adobe website."
Omit the full stop if a hyperlink is used at the end of a sentence. For example:
To read this file you will need to download the Acrobat Reader software
Advise if the link will open in a new browser window.
Windows
All browser windows and dialog boxes should be referred to as windows.
Windows open (ie do not refer to windows 'appearing' or being 'displayed').
Other
eg
Don't use full stops after letters. It may be best to write "for example" rather than using the abbreviation.
ie
From the Latin "id est", meaning "that is". Don't use full stops or commas after letters.