Troubleshooting Headings
All headings must be in bold, only have the first letter capitalised and be in statement form (i.e. no questions!)
Headings Including:
- A forward-slash (/). Please put a space between the word before and after a slash. Eg. example / example
- Acronyms (Hd, dvd, etc.). Acronyms are always in capitals
- Make sure there is a line break between all headings and the body copy using either <br> html line breaks or by manually inserting one using enter.
- Please avoid using quotation marks (")
Troubleshooting Copy
The main block copy should be as brief as possible. Words like and/therefore and phrases like in most cases/please ensure that are superflous and can be cut completely or replaced with a single word.
For example:
Remote control not working
1. Check the batteries are correctly fitted into the battery compartment, and that they correctly match the + and - markings inside the battery compartment
After editing becomes:
Remote control not working
1. Check the batteries are inserted into the compartment correctly
Remember:
- A forward-slash (/) should not have a space between it and the text E.G. Example/example.
- Check for unnecessary capitalisation. E.G. connect to Network should be connected to the network
- When describing menu paths please use > to indicate flow. E.G. menu > control panel > settings
- Do not capitalise on menu headings
- Please use lower case.
- Individual steps are to be numbered. No dashed (-) or bullets.
- Steps should be numbered on the left margin with numbered followed by a full stop.
E.G. 1. Example
Please ensure no full stops are used at the end of the numbered steps.
- When highlighting keys that need to be pressed while troubleshooting, use bold text and do not capitalise or use quotation marks. E.G. 1. Hold ctl + alt + del to restart
This applies to all words/buttons/indicators you deem important and should be brought to the attention of the troubleshooter.
- Warnings and crucial information should be bolded and highlighted with an asterisk
E.G. * Please advise the customer prior to SRS complete restore that all data on the device will be wiped. Customers will need to back up their device.
- Acronyms (HD, DVD, etc). Acronyms are always in capitals.
- When inserting links into the text, please use the full address and bold text.
E.G. You will need to update the device. Visit http://au.support.tomtom.com/app/answers/detail
To know more about adding Troubleshooting images, visit our article Troubleshooting Style Guide - Imagery