19
edits
Thunderbird:Help Documentation:Style Guidelines: Difference between revisions
Jump to navigation
Jump to search
Thunderbird:Help Documentation:Style Guidelines (view source)
Revision as of 11:33, 9 February 2006
, 9 February 2006→Format: +'task-based'
Randywombat (talk | contribs) (+format section) |
Randywombat (talk | contribs) (→Format: +'task-based') |
||
| Line 18: | Line 18: | ||
==Format== | ==Format== | ||
'''Start with a summary.''' At the top of each general help topic should be a summary of Thunderbird's capabilities in that area. This gives the user an immediate idea of what areas the help topic covers, and therefore whether (s)he's looking in the right place. Remember, many users who consult inline help are doing so because they have a good idea what they need to do and want to find out if Thunderbird can do it. Only once this question is answered do they need specific instructions on ''how'' to do it. | '''Start with a summary.''' At the top of each general help topic should be a summary of Thunderbird's capabilities in that area. This gives the user an immediate idea of what areas the help topic covers, and therefore whether (s)he's looking in the right place. Remember, many users who consult inline help are doing so because they have a good idea what they need to do and want to find out if Thunderbird can do it. Only once this question is answered do they need specific instructions on ''how'' to do it. | ||
'''Make it task-based.''' Most users dip in and out of help topics to find specific instructions for specific tasks. So break each topic down into the relevant key tasks, then use numbered step-by-step instructions to describe how to carry them out. | |||
==Coding== | ==Coding== | ||