Changes

Jump to: navigation, search

Thunderbird/Support/GetSatisfaction/TaggingConventions

191 bytes added, 14:39, 10 August 2012
m
some cleanup/updating
== How to Tag ==
In the left (as of Spring 2011 GS redesign it's on the left; used to be on the right) sidebar of a Get Satisfaction topic ([http://getsatisfaction.com/mozilla_messaging/topics/thunderbird_2_to_3_0_upgrade_unable_to_authenticate_to_smtp_server_uncheck_use_name_and_password_for_that_server example topic]), click "Add a Tag". Tags are separated by commas and can have spaces e.g. cannot send email, cannot receive email, gmail, hotmail, etc.
== Goals and Guidelines ==
 
* intuitive
* organic "pave the cowpath" i.e. use the tags that people are already using
* DO NOT use software code names i.e. Thunderbird or Mozilla module names unless you know the topic is specifically about them
* '''DO NOT use Tags like "help", "email", "Thunderbird"''', "My Thunderbird has fallen and I can't get up", etc. They are too generic to be useful. Instead select the Product "Thunderbird" and from the product the support community will know it's about Thunderbird and email and help is required.
* '''DO''' use names from the user interface Thunderbird UI e.g. "message filters", and names commonly used by users e.g. "filters"* try to use 3 word words or shorter tagsless, tags longer than 3 words are hard to use and remember
* '''DO''' use multiple tags if that make sense e.g. "Thunderbird 3 Beta 4" and "cannot send email"
== Tagging Conventions ==
* pending-<locale> - boiler plate has been posted in topicuse terse/root word form, and we are waiting for reporter to indicate (via tags closeme-<locale> or helpme-<locale>) whether further help is needed* closeme-<locale> - e.g. '''closeme-nl''' for dutch indicating the user has gone to the localized support forum e.g. geckozone for french language folks and the topic is no longer needed* helpme-<locale> - e.g. '''helpmerather than variations -es''' indicating the user is choosing to stay in getsatisfaction and needs help in that particular locale's language, e.g. Spanish for "es"* singular forms NOT plural, i.e. use "crash" NOT "crashes", unless the UI has the plural form// "crash" rather than "crashing"* "closeme" if the topic needs to be closed (since GS doesn't have a close topic feature) - consider closing or archiving the topic as well if no longer relevant using the GS archive feature and/or modifying the topic subject of the topic so it's as specific as possible, ... users tend to "pile on" to generic topics unfortunately
* "add to KB" if topic content needs to be added to the SuMoMo knowledge base; remove this tag when done and add "documented on KB"
* "'''docs required" ''' if topic content needs to be added to MDC, Help text or anything else that isn't SuMoMo, remove this tag when done and add "documented on xxx" when done e.g. "documented on MDC"* '''faq''' if the topic is a FAQ* '''canonical''' to highlight a preferred topic for a problem, tag it "faq"especially if you need to keep other reports of the same problem open for diagnosis purposes<p>
* if the topic is one of the following common issues/faq areas then tag it
** '''default email client''' - for making Thunderbird the default email client
** tag with bug number e.g. "bug 541892" if there's a bug in bugzilla referenced
** mail provider e.g. "Comcast", "gmail"
* where it makes sense use the bugzilla keywords: https://bugzilla.mozilla.org/describekeywords.cgi
* if the topic is user experience related then tag it with the appropriate ux-keyword i.e. one or more of "ux-feedback", "ux-implementation-level", "ux-jargon", "ux-discovery", etc ([http://spreadsheets.google.com/pub?key=tJxF8zTuLdEj9pUcxnLAemA&output=html full ux keyword list in a spreadsheet with explanations], {{bug|561262|bugzilla implementation}}, [http://blog.mozilla.com/faaborg/2010/04/22/dont-talk-about-users/ blog post], [http://groups.google.com/group/tb-planning/browse_thread/thread/43f560a05d68c552?fwc=1&pli=1 thunderbird context])
 * where it makes sense use locale issues:** pending-<locale> - boiler plate has been posted in topic, and we are waiting for reporter to indicate (via tags closeme-<locale> or helpme-<locale>) whether further help is needed** closeme-<locale> - e.g. '''closeme-nl''' for dutch indicating the user has gone to the bugzilla keywords: https://bugzillalocalized support forum e.g. geckozone for french language folks and the topic is no longer needed** helpme-<locale> - e.g.mozilla'''helpme-es''' indicating the user is choosing to stay in getsatisfaction and needs help in that particular locale's language, e.org/describekeywordsg.cgiSpanish for "es"
Canmove, confirm
2,082
edits

Navigation menu