19
edits
Thunderbird:Help Documentation:Style Guidelines: Difference between revisions
Thunderbird:Help Documentation:Style Guidelines (view source)
Revision as of 11:25, 9 February 2006
, 9 February 2006+format section
(More changes...) |
Randywombat (talk | contribs) (+format section) |
||
| Line 15: | Line 15: | ||
'''Spell things right!''' Spelling and grammar are somewhat nitpicky, true, but I guarantee you'll find a user who's put off by such mistakes. Try to keep things good by yourself for now, and when docs start getting added to the main mozilla.org source code, we'll go over them again to make sure everything's right. (I have an eye for what's wrong, and others will be helping as well.) Also, if there are multiple ways to spell something, choose one way and spell it that way consistently. | '''Spell things right!''' Spelling and grammar are somewhat nitpicky, true, but I guarantee you'll find a user who's put off by such mistakes. Try to keep things good by yourself for now, and when docs start getting added to the main mozilla.org source code, we'll go over them again to make sure everything's right. (I have an eye for what's wrong, and others will be helping as well.) Also, if there are multiple ways to spell something, choose one way and spell it that way consistently. | ||
==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. | |||
==Coding== | ==Coding== | ||
'''Don't use wiki markup!''' We won't be able to use wiki markup when the docs get added to the source code, and most HTML markup is still valid in this wiki. | '''Don't use wiki markup!''' We won't be able to use wiki markup when the docs get added to the source code, and most HTML markup is still valid in this wiki. | ||
'''Use wiki markup for links!''' Link directly to the location of the page, like so | '''Use wiki markup for links!''' Link directly to the location of the page, like so: <nowiki>[http://wiki.mozilla.org/index.php/Thunderbird:Help_Documentation:Style_Guidelines Style Guidelines]</nowiki>. When the docs get moved over into the main tree, we'll do a search for "[http://" to find instances of wiki links. It's pretty bad, but at least the links will be testable without edits. | ||
'''Don't manually wrap lines!''' Let them get wrapped by the wiki. It looks bad in the wiki, and wrapping them for when they go on the mozilla.org site is relatively trivial. | '''Don't manually wrap lines!''' Let them get wrapped by the wiki. It looks bad in the wiki, and wrapping them for when they go on the mozilla.org site is relatively trivial. | ||