I'm hoping to establish some sort of guideline for writing tag wiki excerpts (or usage guidance).

Examples of tag wiki excerpts I find usually fall into two categories. The first references the tag itself:

  • Use this tag for questions about [tag], which is [definition] (ie. )
  • For questions about [tag] (ie. )

While the second directly defines the tag:

I find the first option somewhat redundant and unhelpful (I'm guilty of having written multiple). I also feel that having a long definition is not necessary, as someone using the tag should already know its meaning. So perhaps definitions should only be used to disambiguate with other tags.

Some other remarks:

  • Sometimes the phrase "Do not/only use this tag if ..." appears -- I think this is useful if the tag is prone to being misused
  • references to other tags should be written as [name] rather than [tag:name], as the latter does not render properly in wiki excerpts

I'd like to know what are some guidelines we could adopt for writing and editing tags in the future? (I'm not suggesting we rewrite all tags to fit into a single format)



You must log in to answer this question.

Browse other questions tagged .