Thunderbird/Support/GetSatisfaction/TaggingConventions: Difference between revisions

m
typo! lakrits not lakrit!!!!!
m (→‎Tagging Conventions: fix inconsistency)
m (typo! lakrits not lakrit!!!!!)
 
(17 intermediate revisions by 4 users not shown)
Line 1: Line 1:
'''WARNING: this page is obsolete as Lakrits said, thanks Lakrits! Thunderbird support is at support.mozilla.org (SUMO) and no longer uses Get Satisfaction since about April 2014. We need to make a SUMO version of this tagging conventions page. Once a SUMO version of tagging conventions is made, we can delete this page!'''
{{outdated|{{resize|<br>The links to Get Satisfaction on this page all lead to an error page with the message '''Sorry, the community that you’re looking for has been retired and is no longer available.'''<br>{{right|[[User:Lakrits|Lakrits]] ([[User talk:Lakrits|talk]]) 09:46, 8 December 2014 (PST)}}}}}}
__TOC__
__TOC__
:; What is a tag?
:; What is a tag?
Line 4: Line 7:


== How to Tag ==
== 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.
In 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 ==
== Goals and Guidelines ==
* intuitive
* intuitive
* organic "pave the cowpath" i.e. use the tags that people are already using
* organic "pave the cowpath" i.e. use the tags that people are already using
* to make it compatible with future systems, consider shorter tags without spaces
* consider shorter tags without spaces, to assure compatibility with future support forum systems
* 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 software code names, ex. Thunderbird or Mozilla module names unless 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 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 that are in the user interface e.g. "message filters" AND names that are in common use by users e.g. "filters"
* '''DO''' use names from Thunderbird UI e.g. "message filters", and names commonly used by users e.g. "filters"
* try to use 3 word or shorter tags, tags longer than 3 words are hard to use and remember
* try to not use more than 3 words, 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"
* '''DO''' use multiple tags if that make sense e.g. "Thunderbird 3 Beta 4" and "cannot send email"


== Tagging Conventions ==
== Tagging Conventions ==
* 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
* use terse/root word form, rather than variations - singular forms NOT plural, i.e. use "crash" NOT "crashes", unless the UI has the plural form // "crash" rather than "crashing"
* helpme-<locale> e.g. '''helpme-es'''  indicating the user is choosing to stay in getsatisfaction and needs help in that particular locale's language, e.g. Spanish for "es"
* '''{{Gsfntag|closeme}}''' if topic needs to be closed (since GS doesn't have a close topic feature) - consider closing or archiving the topic if no longer relevant using GS archive and/or modifying topic subject so it's as specific as possible ... users tend to "pile on" to generic topics unfortunately
* singular forms NOT plural, i.e. use "crash" NOT "crashes", unless the UI has the plural form
* '''{{Gsfntag|add_to_KB}}''' if topic content needs to be added to the SuMoMo knowledge base; remove this tag when done and add '''{{Gsfntag|documented_on_KB}}'''.
* "closeme" if the topic needs to be closed (since GS doesn't have a close topic feature) - consider archiving the topic as well using the GS archive feature and/or modifying the subject of the topic so it's as specific as possible, users "pile on" to generic topics unfortunately
<!-- *HIDEN BECAUSE NOBODY USE THAT '''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"-->
* "add to SuMoMo" if topic content needs to be added to the SuMoMo knowledge base; remove this tag when done and add "documented on SuMoMo"
* '''{{Gsfntag|faq}}''' if the topic is a FAQ
* "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"
* '''{{Gsfntag|canonical}}''' to highlight a preferred topic for a problem, especially if you need to keep other reports of the same problem open for diagnosis purposes
* if the topic is a FAQ, tag it "faq"
<!-- *HIDEN BECAUSE NOBODY USE THAT* '''{{Gsfntag|helpwanted}}''' to flag a topic for triagers to crowdsource, and remove it when not needed:
* if the topic is one of the following common faq areas then tag it
** '''{{Gsfntag|helpwanted-BUCKET}}''' where BUCKET is a category/type of problem, for example: '''{{Gsfntag|helpwanted-imap}}''', '''{{Gsfntag|helpwanted-crash}}''', '''{{Gsfntag|helpwanted-Mac}}'''-->
** "default email client" - for making Thunderbird the default email client
<p>
** "default browser" - for making Firefox the default browser
*Tag with the name of the Thunderbird feature concerned, for instance:
** "dataloss" - for emails deleted
** "account setup", "accounts" for setting up account problem
** "address book" - for address book issue
** "address book" - for address book issue
**'''{{Gsfntag|Filelink}}'''. Also add a tag about the protocol, for instance, {{Gsfntag|UbuntuOne}}, {{Gsfntag|Yousendit}},...
**'''{{Gsfntag|im}}'''. Also add a tag about the protocol, for instance, {{Gsfntag|IRC}}, {{Gsfntag|Facebook}},...
**'''{{Gsfntag|SearchTheWeb}}'''.
** "email import" - email import issue. Please aslo add the name of the original application (ie Outlook, ...). Tag with email client for import and send/receive issues e.g. "hotmail", "outlook express"
** "filters", "message filters" how to set up filters, question on filters
* if the topic is one of the following common issues/faq areas then tag it
** "cannot receive email" - when you can't receive emails
** "cannot receive email" - when you can't receive emails
** "cannot send email" - when you can't send emails
** "cannot send email" - when you can't send emails
** "password" - problems with Thunderbird passwords in general
** '''{{Gsfntag|compact}}''' - for folder compact issues
*** '''{{Gsfntag|compactask}}''' - disabling ask fails, or user has trouble with the UI (eg http://gsfn.us/t/31mr2 )
*** '''{{Gsfntag|compactcrash}}''' - compact caused crash
*** '''{{Gsfntag|compactfail}}''' - folder failed to compact
*** '''{{Gsfntag|compactlost}}''' - compact causes dataloss
*** '''{{Gsfntag|compactwhy}}'''/'''{{Gsfntag|compactwhat}}''' - user doesn't understand compact. what is it?
** '''data recovery''' - for issue related to recovering/restoring data in the profile
** "dataloss" - for emails deleted
** "default browser" - for making Firefox the default browser
** "default email client" - for making Thunderbird the default email client
** '''{{Gsfntag|disk_space}}''' - want to free and minimize disk space
** "firefox does not launch" - firefox doesn't launch when clicked on from Thunderbird
** "line breaks" - line break issue
** "master password" - problem with Tb's master password
** "master password" - problem with Tb's master password
** "filters", "message filters" how to set up filters, question on filters
** "account setup", "accounts" for setting up account problem
** "upgrade" - upgrade problems, perhaps have tags for TB2 to TB3 e.g. "TB2 to TB3 upgrade"
** "news groups" - usenet issue
** "news groups" - usenet issue
** "line breaks" - line break issue
** '''{{Gsfntag|not_responding}}''' - when windows title bar has "(Not Responding)" aka Mac beach ball (vs unresponsive script, which is something different)
** "password" - problems with Thunderbird passwords in general
** "phantom messages" - messages not being marked as read or not displayed
** "phantom messages" - messages not being marked as read or not displayed
** "firefox does not launch" - firefox doesn't launch when clicked on from Thunderbird
** '''{{Gsfntag|unresponsive_script}}''' - unresponsive script dialog/error shown
** tag with email client for import and send/receive issues e.g. "hotmail", "outlook express"
** "upgrade" - upgrade problems, perhaps have tags for TB2 to TB3 e.g. "TB2 to TB3 upgrade"
** "email import" - email import issue
** '''system recovery''' - for window system recovery
** operating system - if operating system tag whatever makes sense, e.g. "Windows Vista", "Windows XP", "Windows 7", "Windows Vista", "Linux" for generic linux stuff otherwise specific variant e.g. "Ubuntu"
** operating system - if operating system tag whatever makes sense, e.g. "Windows Vista", "Windows XP", "Windows 7", "Linux" for generic linux stuff otherwise specific variant e.g. "Ubuntu"
** Thunderbird version, e.g. "Thunderbird 2", "Thunderbird 3.0" for Thunderbird 3.0 final, "Thunderbird 3 Beta 3", "Thunderbird 2.0.0.23"
** Thunderbird version, for brevity please use "tbxx", e.g.  e.g. '''{{Gsfntag|tb10}}''' for Thunderbird 10", '''{{Gsfntag|tb14}}''' for "Thunderbird 14", '''{{Gsfntag|tb15}}''' for "Thunderbird 15", etc.
** tag with bug number e.g. "bug 541892" if there's a bug in bugzilla referenced
** tag with bug number e.g. "bug 541892" if there's a bug in bugzilla referenced
** mail provider e.g. "Comcast", "gmail"
** 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])
* 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 the bugzilla keywords: https://bugzilla.mozilla.org/describekeywords.cgi
 
* 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 localized support forum e.g. geckozone for french language folks and the topic is no longer needed
** helpme-<locale> - e.g. '''helpme-es'''  indicating the user is choosing to stay in getsatisfaction and needs help in that particular locale's language, e.g. Spanish for "es"
Confirmed users
5,365

edits