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 How do we want to organize the help center?

Parent

How do we want to organize the help center?

+11
−0

Jon Ericson raised an interesting point in a recent Meta post:

I don't understand how the help page is organized. Oh wait! It's alphabetical by the title of the article. That's why "Advanced formatting help" comes before "Formatting Posts". I can sorta understand the difference between "Site Information" and "Guidance", but I'm not sure I understand why they should be separated.

A couple things to note here:

  • The default sort is alphabetical. However, we can specify an order through the UI. I've now gone through and ordered the "Site Information" section in rough approximation of priority - so the FAQ comes first and "Advanced formatting help" shows up last. (This change is only for Meta at the moment.)
  • The "Site Information" and "Guidance" split came about from splitting up help articles on "using the platform" and "guidance for writing posts". However, these groupings are also customizable through the UI - I can, for instance, move things from category to category or create new categories without any issues.

With that mind, how do we want to organize the help center? We've added some articles and changed others over the years, but I don't think we've overhauled the organization in quite a while. This is done entirely through the UI, so there's no dev time required - it can be adjusted quickly and easily by any admin.

This is also something we can change on a per-community basis, as well, if the need arises.

Do we need to split up the help center into more categories? Do we want to keep the existing categories, but rename them? Any other suggestions?

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

0 comment threads

Post
+5
−0

Right now, the help center is structured with a main landing page with sections containing lists of specific help content, with each of these contents being on specific pages (example). That's fine, and I suggest keeping the design mostly as is. However, on each specific page, the sidebar should be replaced with a table of contents (ToC) of the help center (pretty much like Somewhere Else).

When selecting another page in the ToC, the currently viewed help page should be swapped inline, not requiring a full page reload. That will make browsing the help center far more pleasant. It's currently easy to get lost when navigating back and forth between pages and the main help page.


The help center consists of a set of boxes with bulleted lists; these boxes must be visually placed in the same locations on all the Codidact sites; this is not currently the situation; for example, at Meta's HC, "Guidance" is in the upper left corner, while on SS's HC, it's in the lower left corner. I think the lower left corner is a good location for it.


Most (if not all) of the sites' help centers have one or two "FAQ"s in the lists; this is quite problematic, as it's a FAQ within the FAQ (the help center itself is a sort of FAQ), so these should preferably be removed altogether. Having a FAQ (or worse, two FAQs) inside the help center, isn't useful, because it's only more searching, because you're now two levels deep of headlines. I don't have an answer for where to put all their content at this time, but one step at a time is better than no step.

Some sites have some problematic or unnecessary parts in their FAQ, such as Scientific Speculation (using this particular site as an example, but they're not the only site with this issue (same issues in Meta's FAQ too)):

  • "Who are the moderators?"

    • This should be a tab on the page of users (for Meta CD, here), or at least moved to a dedicated page in the help section. If there's a dedicated page, this page can also go on to explain what the moderators are, what they do, what they don't, and how they are chosen.
  • "What are the different categories for?"

    • There should be a dedicated space for category descriptions, with a link from the category header. As pointed out to me in chat, such a page already exists, but the sites don't expose any link to it, effectively rendering it a dead page. I suggest removing the FAQ page entry, and bringing back this page in some form. Linking to it in the help center is a good choice, with the name "Category descriptions", perhaps. That page's design is currently quite superfluous, as the categories header is right above it, on the same page. I suggest either keeping it simple, by cutting down the "see posts" links, or add something else useful, such as category statistics. Apparently, for users with higher abilities, that bar contains more useful content than just "see posts", however, for users that don't have these abilities, the bar should just be removed.
  • "What open-source license are posts on Scientific Speculation created under?"

    • This is already listed under "Guidance", and so should be removed from the FAQ. The page for licenses is per-site, but ideally, it should be a shared page for all the sites, as licensing is not just a responsibility of each site.
  • "How to ask a great question"


I also suggest renaming the page titles displayed in the bulleted lists on the main help center page. They are currently too long, requiring the user to scan too much text on the page, which is not only confusing, but unnecessary. For example:

Help Center #Guidance: (example)

Currently Suggested renaming
Guidance on available licenses Licenses
Guidelines for referencing and quoting [on Codidact communities] Referencing & quoting
How to ask a great question How to ask
How to propose a community on the codidact.com network Proposing a new Codidact community
How to write good alt text Image alt text
Voting Voting

In addition, move "Licenses" and "Proposing a new Codidact community" to the bottom of the list (same order).

Some sites have additional bullet points in this list, such as Software Development:

  • "Etiquette for posting comments"

This is a good page that I think all sites should have.


Make sure these changes are committed on each site, not just CD Meta.


As a final note, I'd like to mention a thought for discussion: that the help centers on each site live in their own bubbles, cut off from the bigger network. This seems like something that happens to be wrong, but can be fixed. I don't have an answer for it, though. Policy/"About the network" may be where to start.

History
Why does this post require attention from curators or moderators?
You might want to add some details to your flag.

2 comment threads

Inline content swapping should not lose individual URLs (2 comments)
Licenses (3 comments)
Licenses
Mithical‭ wrote 9 months ago

The page for licenses is per-site, but ideally, it should be a shared page for all the sites, as licensing is not just a responsibility of each site.

Different communities1 have different licenses available; for instance, communities with imported content have some posts under CC by-SA 3.0, and other communities might have other licensing needs. That page, like almost all other help center pages, can be tweaked for that community's specific needs.

  1. Which is generally the term we use instead of "sites", as an aside.

Mithical‭ Can each community choose entirely themselves which licenses to allow, or are they limited by a shared set? Because in that case, there can be a shared page describing all the available licenses across the Codidact network, with each site listing which ones they allow, and which ones they don't.

Which is generally the term we use instead of "sites"

"Site" is much more natural for me to use to describe the subject. ;)

Mithical‭ wrote 9 months ago

In theory, a community can choose whatever licenses they want as long as it still allows us to distribute and use the content (such as for answers). There are defaults, but I don't see any reason that a community needs to be bound to a certain list.