Thunderbird:Help Documentation:Style Guidelines: Difference between revisions

Thunderbird:Help Documentation:Style Guidelines (view source)

Revision as of 03:56, 10 January 2005

1,061 bytes added , 10 January 2005

Adding...

Waldo

Confirmed users

446

edits

@@ Line 2: / Line 2: @@
 ==Language==
+'''Keep it clear, structured, and generally useful.'''  If it's something that the average user isn't likely to do, it probably shouldn't be in the built-in Help.  The excellent [http://texturizer.net/thunderbird/ Thunderbird Help site] and other such resources are available for the power user.  We can't fill every need because of space restrictions, so we should let other resources fill them.
+'''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.  Also, if there are multiple ways to spell something, choose one way and spell it that way consistently.
+'''Use the text from the UI.'''  If the menu item's written a certain way, then you should write it out that way, capitalization and all.
 Refer to the application as "Mozilla Thunderbird" once at the beginning of each document and in the article title (if you'd want to refer to the application by name), but after that refer to it as "Thunderbird".
+'''Short and concise''' are the rules of the game.  We don't want verbosity if it can be avoided.
 ==Coding==
 The big rule:  '''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.