1,365
edits
Support:Style Guide: Difference between revisions
Jump to navigation
Jump to search
remove sections which belong in best practices
(add Support navigation link at top) |
(remove sections which belong in best practices) |
||
| Line 2: | Line 2: | ||
The support.mozilla.com style guide aims to make the Firefox support Knowledge Base consistent, resulting in a knowledge base, that is easy to read and contribute to. These are not rigid rules. If you feel you have good reason not to follow any of these guidelines, feel free not to follow them. Conversely, do not be surprised if your contributions are edited, to comply the style guide. | The support.mozilla.com style guide aims to make the Firefox support Knowledge Base consistent, resulting in a knowledge base, that is easy to read and contribute to. These are not rigid rules. If you feel you have good reason not to follow any of these guidelines, feel free not to follow them. Conversely, do not be surprised if your contributions are edited, to comply the style guide. | ||
==Preferred style guides== | |||
If you have questions about usage and style not covered here, I recommend referring to the [http://www.economist.com/research/StyleGuide/ Economist style guide] or, failing that, the [http://www.amazon.com/gp/product/0226104036/ Chicago Manual of Style]. | |||
==Terminology== | ==Terminology== | ||
In cases where you are not sure of proper terminology, or if an element has more than one name, use the term in the user-interface. For instance, in the customize toolbar screen, the term used for the location bar is "Location" bar, not "Address" bar, or "URL" bar. Other often used terms: | In cases where you are not sure of proper terminology, or if an element has more than one name, use the term in the user-interface. For instance, in the customize toolbar screen, the term used for the location bar is "Location" bar, not "Address" bar, or "URL" bar. Other often used terms: | ||
*It's "web feeds", not "RSS feeds". | * Plug-ins contains a hyphen (it is not plugins). | ||
*It's "search engines", not "search plug-ins". | * Add-ons contains a hyphen (it is not addons). | ||
*Home page is two words, not one. | * It's "web feeds", not "RSS feeds". | ||
*Web site is two words, not one. | * It's "search engines", not "search plug-ins". | ||
* Home page is two words, not one. | |||
* Web site is two words, not one. | |||
== | ==Links to Mozilla.com== | ||
Links to the main Mozilla.com web site should not contain the locale. | |||
* <span style="color: #006600">Good</span>: http://www.mozilla.com/firefox | |||
* Bad: http://www.mozilla.com/en-US/firefox | |||
==Acronyms and abbreviations== | |||
When using a term, that may be presented as an acronym or abbreviation, use the method of presentation that is used in the user-interface; and do not separate the letters of an acronym by a period. | When using a term, that may be presented as an acronym or abbreviation, use the method of presentation that is used in the user-interface; and do not separate the letters of an acronym by a period. | ||
*<span style="color: #006600">Good</span>: SSL 3.0 | * <span style="color: #006600">Good</span>: SSL 3.0 | ||
*Bad: S.S.L. 3.0 | * Bad: S.S.L. 3.0 | ||
*Bad: Secure Sockets Layer 3.0 | * Bad: Secure Sockets Layer 3.0 | ||
===Acronyms not found in the user-interface=== | |||
In cases where an acronym is not in the user-interface, introduce its expansion in parenthesis on the first mention. | |||
* <span style="color: #006600">Good</span>: RSS(Really Simple Syndication) links | |||
* Bad: RSS links | |||
===Abbreviations not found in the user-interface=== | |||
In cases where an abbreviation is not in the user-interface, use the long version. | |||
* <span style="color: #006600">Good</span>: information | |||
* Bad: info | |||
== | ===Plurals of acronyms and abbreviations=== | ||
For plurals of acronyms or abbreviations, add s, without the apostrophe. | |||
*<span style="color: #006600">Good</span>: CD-ROMs | |||
*Bad: CD-ROM's | |||
==Capitalization in article title and sections== | |||
When creating the name of an article, capitalize the first word and any proper nouns. | |||
* <span style="color: #006600">Good</span>: How to make Firefox your default browser | |||
* Bad: How to make Firefox your default browser | |||
(We may need a rule on special characters depending on how TikiWiki makes pretty URLs) | (We may need a rule on special characters depending on how TikiWiki makes pretty URLs) | ||
==Dates== | ==Dates== | ||
| Line 63: | Line 77: | ||
*Bad: Search engines, e.g. Google, can be used ... | *Bad: Search engines, e.g. Google, can be used ... | ||
*Bad: Search engines, (eg: Google) can be used ... | *Bad: Search engines, (eg: Google) can be used ... | ||
===Pluralization=== | ===Pluralization=== | ||
| Line 79: | Line 88: | ||
*Bad: Clear your cache, cookies and history. | *Bad: Clear your cache, cookies and history. | ||
==Common | ==Common types of text== | ||
===Preference names / values=== | ===Preference names / values=== | ||