5

I've been looking through the tag wikis and many of them are one-line, blank, or conflate the excerpt with the rest of the wiki.

Compared to best-practice examples from other SE sites, our tag wikis could use some love. Better tag wikis can help users understand what is and is not relevant for the site, provide answers to frequently repeated questions, and catalog the best knowledge we've generated.

What should and should not be included in great tag wikis at The Workplace?


The network has had conversations on tag wikis as well:

And we've discussed it before: A note on tag wiki excerpts.

1
  • 1
    As a side note to improving the tags, I would also encourage people to vote on any pending tag synonyms. Often synonyms get suggested and then sit in limbo for years because no one thinks to vote on them.
    – David K
    Jul 11, 2019 at 14:34

3 Answers 3

3

What should and should not be included in great tag wikis at The Workplace?

From https://workplace.stackexchange.com/help/privileges/trusted-user, we can see a description on what should one write on tag wikis (emphasis mine):

What should I write in the tag wiki?

See the guidelines in the blog post announcing tag wikis in their current form. To summarize:

  • The excerpt is the elevator pitch for the tag.
  • Avoid generically defining the concept behind a tag, unless it is highly specialized.
  • Concentrate on what a tag means to your community.
  • Provide basic guidance on when to use the tag.

I think that those guidelines are useful for when writing tag wikis and excerpts.

3

Here's a composite of what was posted here and discussions on other SE sites that I think offers some practical guidance. Of course, there aren't any hard and fast rules (that I've found) other than the standards that govern contributions across the site - this is a summary of the best guidance I could find across SE.

Excerpts

Tag wiki excerpts should explain when a tag should be used. For example:

For questions about advancing one's career as a whole rather than working in a specific job function or company.

Tag wiki excerpts should not:

Wikis

Tag wikis should stand alone as a description of the tag and include all of the information needed to understand the excerpt in detail.

Wikis should do a number of things:

Wikis should not:

1
  • 1
    Great compilation Jay, thanks for taking the time to do so :), perhaps some of these things could be included in the link I shared in my answer, so we make it more thorough.
    – DarkCygnus Mod
    Jul 9, 2019 at 20:12
1

Could are tag excerpts and wikis use some love? Yes. But the changes we make need to be helpful and accurate. Don't edit for the sake of editing. I just voted to reject six of the tag edits you suggested in review because I didn't find them helpful.

Most of the excerpts I rejected because of a cyclical definition:

Tag excerpts amounting to, "[tag] is for questions about [tag]" are pointless and usually rejected. Excerpts should describe why and when a tag would be used.

Simply saying the tag should be used for "Questions about terminating employment" is not at all helpful to someone who doesn't know what termination means. Instead, excerpts should be short one- or two-liners that help to define a tag and how to apply. For example this tag could be

For questions about involuntarily losing one's job, such as being fired or laid off. Questions about voluntarily leaving a job should use the tag.

You also changed the definition from being only about involuntary termination (aka firing) to being about both voluntary and involuntary termination. I don't know which version is correct for how we use the tag here (we also have the tag for questions about leaving a job voluntarily), but if you are going to change the meaning of a tag, you need to bring it up in Meta first so the community can agree on a definition.

Lastly, you edited the wikis for two country tags to also include a list of links to every other country tag we have. These tags are not at all relevant and only add clutter to the wiki. Some of the "best-practice" tags you link to include a list of relevant tags, but they should be tags that are often closely linked to one another. Someone who uses the tag may also want to use the tag . Someone who uses the tag is not likely interested in tagging as well. Someone tagging might be interested in the tag though.

Wikis should provide more information defining the tag, and possibly include some helpful links, but they should be relevant. Generally useful links might be to canonical questions on Main or Meta that apply to a certain tag (e.g. 1, 2, 3, 4). For tags which are only relevant to a specific location (e.g. country tags, , ), it would be useful to link to sites on relevant employment laws and government agencies for that location.

5
  • @Jay I did, and they are still in the review queue. I mainly wanted to make sure you weren't wasting more effort on edits that may be rejected. Excerpts should always be a one- or two-liner that give a reference for when to use the tags. Wikis should provide more information defining the tag, and possibly include some helpful links. For location tags, it would be useful to link to sites on relevant employment laws and departments for that location.
    – David K
    Jul 2, 2019 at 17:20
  • @Jay I added more info on what information I think would be relevant.
    – David K
    Jul 2, 2019 at 17:25
  • 3
    "Someone tagging united-states might be interested in the california tag though" - I'm not 100% sure what you're proposing, but there are 50 US states; we probably don't want to include all of them in the US tag wiki (although a general reminder about state-specific tags would make sense). I would agree with the inverse though: referencing the US tag in state tag wikis. Jul 3, 2019 at 11:22
  • 2
    "helpful links" could include useful questions on the site about the topic. Jul 3, 2019 at 11:25
  • @Dukeling Good point, I've switched them. I was just trying to provide an example of two location tags that are closely related.
    – David K
    Jul 8, 2019 at 18:53

You must log in to answer this question.

Not the answer you're looking for? Browse other questions tagged .