Confirmed users
446
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 04:19, 10 January 2005
, 10 January 2005no edit summary
No edit summary |
|||
| Line 1: | Line 1: | ||
The guidelines for how Help documents should be written | The guidelines for how Help documents should be written fall into two main areas: language and coding style. Because the coding style issues are more applicable to when the documents are actuallly in the mozilla.org tree for building, most of the issues covered will be those of language. These guidelines are based upon those listed in the Resources section below. However, they differ in some areas, so you shouldn't need to refer to the originals unless you're redirected there or you're just curious what they say. | ||
==Language== | ==Language== | ||
| Line 10: | Line 10: | ||
'''It's "Mozilla Thunderbird" -- usually once per article.''' 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". | '''It's "Mozilla Thunderbird" -- usually once per article.''' 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". | ||
''' | The voice of Help documentation is '''enabling, authoritative, and friendly'''. We're focused on helping the user do what he wants to do. We should sound authoritative yet friendly. That's the basics of it, but you should probably look at [http://www.mozilla.org/projects/help-viewer/documentation_language-style#voice the Voice guidelines] to get a fuller idea of what is meant here. | ||
==Coding== | ==Coding== | ||