Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Q&A

Welcome to Codidact Meta!

Codidact Meta is the meta-discussion site for the Codidact community network and the Codidact software. Whether you have bug reports or feature requests, support questions or rule discussions that touch the whole network – this is the site for you.

Comments on What help pages need to be written?

Parent

What help pages need to be written?

+11
−0

I've been working on the user help center recently - writing new help pages and improving old ones. You can see the latest changes and suggestions - even the ones that haven't been deployed to the site yet - over on GitHub.

Of course, though, I'm not going to be able to come up with everything - there will be things that need help pages that I'm not going to think of on my own. With that in mind... what help center topics would you like to see?

Feel free to leave suggestions in the answers below; I'll look through the responses and see what I can do (and I'll be updating the to-do list).

History
Why does this post require moderator attention?
You might want to add some details to your flag.
Why should this post be closed?

0 comment threads

Post
+2
−0

Add a list of standard close reasons to the help center. It must include the full list of shared close reasons (those that exist across all CD sites), as well as any additional standard close reasons for the specific community.

The list must talk about the scope of questions, and why these close reasons exist. Why do we close posts? What is the reasoning behind it? How should closure be applied?

This help center article is supposed to both be informative, and explain why we close questions. Can link to an MCD Q/A that goes more in depth.

I'm not sure where else I'd expect to find this particular list. In the close vote dialog, yes, but that's only available to those with the "curate" ability. The flagging dialog should also list these standard close reasons, however, a longer discussion of them isn't appropriate there. It would also better serve as a shortcut to them, rather than being the list to read.

Some communities already have somewhat of such a list, Software CD, for instance. MCD does not have one. In general, I'm lost as to where I should go to find this, and I need to perform manual searches in the help center to find them (literally clicking into each page, because I don't recognize which page would contain this, based on the titles).

History
Why does this post require moderator attention?
You might want to add some details to your flag.

1 comment thread

Static and dynamic content (5 comments)
Static and dynamic content

This post was originally posted elsewhere, and as post moving isn't implemented as of yet, I've deleted it, and reposted this one. Quoting Monica Cellio‭ in a comment under the post:

A help topic about closing should explain the general reasoning and how it works, as you said, and it'd be great to have the community-specific close reasons available. Those might need to be somewhere else, behind a link, so that the help topic itself could be static and easily shared across the network.

Reactions are also defined per community; should we take a similar approach there?

Those might need to be somewhere else, behind a link, so that the help topic itself could be static and easily shared across the network.

But why? The help center already has topics unique to each community. I'm not following along here.

Those might need to be somewhere else, behind a link, so that the help topic itself could be static and easily shared across the network.

Yeah, sure. I don't really see any downsides to that. Help pages shouldn't be too complicated to amend when need be, so better include that too, and revise it later.

Monica Cellio‭ wrote 4 months ago

But why? The help center already has topics unique to each community. I'm not following along here.

Sorry -- let me try again. Each community can "fork" help topics to locally customize them, and can also add new topics. EE, for example, has done significant rearranging of their help. That's all fine -- the issue is that if we later update one of the "core" pages, we can't push those updates to communities with local modifications. Closing seems like a topic where we might want to add or adjust guidance over time; if the community-specific reasons are part of the page, those edits would need to be made individually in each community. On the other hand, if the help topic is general and has a site-relative link where you can see the specific local close reasons, the main topic remains sharable.

Monica Cellio‭ Ah. I'd rather not sacrifice the final presentation for solving issues behind the scene. I understand how for now, we need to keep things that way, but it gives us an important point to discuss in https://meta.codidact.com/posts/290439.

if the community-specific reasons are part of the page, those edits would need to be made individually in each community

Not necessarily. We can build pages by merging subsections of them, after each time something is updated. So either, we have one list, which pulls from two data locations (shared + community local), or we have two lists, which are merged into different parts of the text on the page. The issue with merging like this, is that communities can't change the help text, only append to it. I'm not sure if that's too much of an issue, though. Ideally, I shouldn't have to read the entire help center for each different community. We can change the system to allow not only additions to the merged text, but also changes, although

that'll probably be a pain to manage.