Difference between revisions of "Template:KCS Article"
(Created template) |
m (Instructions, added Categories) |
||
| Line 1: | Line 1: | ||
<noinclude> | <noinclude> | ||
<big>KCS Article Template usage</big> | <big>KCS Article Template usage</big> | ||
| + | |||
| + | # Copy text below into a new article | ||
| + | # The article name should reflect the Issue | ||
| + | # Replace the indented text with information that will appear in the article | ||
| + | |||
| + | |||
<nowiki>{{</nowiki>'''KCS Article''' | <nowiki>{{</nowiki>'''KCS Article''' | ||
|'''Issue''' = | |'''Issue''' = | ||
| − | + | :(Symptom, problem, or question)—the issue is described in the requestor's words and phrases—what are they trying to do, what is not working, or what are they are looking for? It is helpful to view this field as belonging to the requestor (even though it may be captured by the responder). It must represent the requestor's perspective and context. | |
| − | (Symptom, problem, or question)—the issue is described in the requestor's words and phrases—what are they trying to do, what is not working, or what are they are looking for? It is helpful to view this field as belonging to the requestor (even though it may be captured by the responder). It must represent the requestor's perspective and context. | ||
|'''Environment''' = | |'''Environment''' = | ||
| − | + | :What product(s), category, or business process does the requestor have? Has anything been changed recently, such as upgrades, additions, deletions? The environment description should be as precise as possible, with standard ways to document product names, versions, or processes. The environment will remain the same after the issue is resolved. | |
| − | What product(s), category, or business process does the requestor have? Has anything been changed recently, such as upgrades, additions, deletions? The environment description should be as precise as possible, with standard ways to document product names, versions, or processes. The environment will remain the same after the issue is resolved. | ||
|'''Resolution''' = | |'''Resolution''' = | ||
| − | + | :The answer or the steps taken to resolve the issue. | |
| − | The answer or the steps taken to resolve the issue. | ||
|'''Cause''' = | |'''Cause''' = | ||
| + | :The underlying cause of the issue. Cause is an optional field as it is not appropriate or necessary for some types of articles. A simple Q&A, for example, doesn't need a cause. However for complex technical issues, a cause can be very helpful in assisting the user in determining if an article is relevant to them. | ||
| − | + | |'''Categories''' = | |
| + | :Examples <br><nowiki>[[Category:T4S]]</nowiki><br><nowiki>[[Category:Feedback]]</nowiki><br><nowiki>[[Category:Third Party Device]]</nowiki> | ||
<nowiki>}}</nowiki> | <nowiki>}}</nowiki> | ||
| Line 42: | Line 47: | ||
== Cause (Optional)== | == Cause (Optional)== | ||
{{{Cause|The underlying cause of the issue. Cause is an optional field as it is not appropriate or necessary for some types of articles. A simple Q&A, for example, doesn't need a cause. However for complex technical issues, a cause can be very helpful in assisting the user in determining if an article is relevant to them. }}} | {{{Cause|The underlying cause of the issue. Cause is an optional field as it is not appropriate or necessary for some types of articles. A simple Q&A, for example, doesn't need a cause. However for complex technical issues, a cause can be very helpful in assisting the user in determining if an article is relevant to them. }}} | ||
| + | |||
| + | ---- | ||
| + | {{{Categories| | ||
| + | [[Category:T4S]] | ||
| + | [[Category:Feedback]] | ||
| + | [[Category:Third Party Device]] | ||
| + | }}} | ||
Revision as of 11:19, 24 August 2018
KCS Article Template usage
- Copy text below into a new article
- The article name should reflect the Issue
- Replace the indented text with information that will appear in the article
{{KCS Article
|Issue =
- (Symptom, problem, or question)—the issue is described in the requestor's words and phrases—what are they trying to do, what is not working, or what are they are looking for? It is helpful to view this field as belonging to the requestor (even though it may be captured by the responder). It must represent the requestor's perspective and context.
|Environment =
- What product(s), category, or business process does the requestor have? Has anything been changed recently, such as upgrades, additions, deletions? The environment description should be as precise as possible, with standard ways to document product names, versions, or processes. The environment will remain the same after the issue is resolved.
|Resolution =
- The answer or the steps taken to resolve the issue.
|Cause =
- The underlying cause of the issue. Cause is an optional field as it is not appropriate or necessary for some types of articles. A simple Q&A, for example, doesn't need a cause. However for complex technical issues, a cause can be very helpful in assisting the user in determining if an article is relevant to them.
|Categories =
- Examples
[[Category:T4S]]
[[Category:Feedback]]
[[Category:Third Party Device]]
}}
Template will render as it appears below this line.
Issue
(Symptom, problem, or question)—the issue is described in the requestor's words and phrases—what are they trying to do, what is not working, or what are they are looking for? It is helpful to view this field as belonging to the requestor (even though it may be captured by the responder). It must represent the requestor's perspective and context.
Environment
What product(s), category, or business process does the requestor have? Has anything been changed recently, such as upgrades, additions, deletions? The environment description should be as precise as possible, with standard ways to document product names, versions, or processes. The environment will remain the same after the issue is resolved.
Resolution
The answer or the steps taken to resolve the issue
Cause (Optional)
The underlying cause of the issue. Cause is an optional field as it is not appropriate or necessary for some types of articles. A simple Q&A, for example, doesn't need a cause. However for complex technical issues, a cause can be very helpful in assisting the user in determining if an article is relevant to them.