Difference between revisions of "How do you write a good answer"

From Net-SNMP Wiki
Jump to: navigation, search
 
m (Reverted edits by Trevor75 (Talk); changed back to last version by Magfr)
 
(11 intermediate revisions by 5 users not shown)
Line 8: Line 8:
  
 
Well, darn, that's a good question.  Let me see if I can help.
 
Well, darn, that's a good question.  Let me see if I can help.
 +
 +
* Create a link on the [[Good Answers Page 1]] page to your article name
 +
** articles should be named carefully without a prefix (see below)
 +
* copy the following template into that page:
 +
 +
<pre>
 +
<nowiki>
 +
{{GoodAnswer}}
 +
 +
== Question ==
 +
 +
== Answer ==
 +
 +
</nowiki>
 +
</pre>
 +
 +
* Add categories to the bottom of the page.  Category names will likely be composed from pre-existing categories in the [[:Category:GoodAnswer]] category list.  But you can [[Creating a new Good Answers Category|Create a new one too]].
 +
 +
<pre>
 +
<nowiki>
 +
[[Category:agent]]
 +
[[Category:linux]]
 +
</nowiki>
 +
</pre>
 +
 +
=== Design caveats ===
 +
 +
Originally I wanted all the articles to begin with ANS: to give them their own prefix.  But it really wasn't worth it because the links and clean categorization got to be pain (they'd all end up in the "A" section of the category).  So...  name randomly at will!
 +
 +
=== Future TODO items ===
 +
 +
In the future, we should be able to mark items that are worth moving to the [[Tutorials]] or the [[FAQ]] with a special template that puts a banner or a right hand box saying this is worth moving.
 +
[[Category:Administrative]]

Latest revision as of 14:31, 9 December 2010

Good Answer

This is a Good Answer article. It was likely created as a response to a question on a Net-SNMP Mailing List and written up here for others to see. It likely covers material not yet in the FAQ or in the Tutorial but may someday be moved there

Question

How does one write up a good answer and have it appropriately documented?

Answer

Well, darn, that's a good question. Let me see if I can help.

  • Create a link on the Good Answers Page 1 page to your article name
    • articles should be named carefully without a prefix (see below)
  • copy the following template into that page:

{{GoodAnswer}}

== Question ==

== Answer ==



[[Category:agent]]
[[Category:linux]]

Design caveats

Originally I wanted all the articles to begin with ANS: to give them their own prefix. But it really wasn't worth it because the links and clean categorization got to be pain (they'd all end up in the "A" section of the category). So... name randomly at will!

Future TODO items

In the future, we should be able to mark items that are worth moving to the Tutorials or the FAQ with a special template that puts a banner or a right hand box saying this is worth moving.