Opened 3 years ago
Last modified 3 years ago
#6001 new enhancement
Lack of Context for Docs (no learning path) under https://wordpress.org/support/
Reported by: | juanmaguitar | Owned by: | |
---|---|---|---|
Milestone: | Priority: | normal | |
Component: | HelpHub (wordpress.org/documentation) | Keywords: | |
Cc: |
Description
Issue Description
When we visit a doc like [Blocks](https://wordpress.org/support/article/blocks/) there are no resources to follow a "learning path"
![diagram docs blocks](https://user-images.githubusercontent.com/422576/147488372-9bfdf277-04ea-4313-9a62-2c2cc7bb1415.png)
So when a user get to this documents there is no answer to the questions: Where am i? Where should I go next? What should I have read before?
URL of the Page with the Issue
This one is an example https://wordpress.org/support/article/blocks/ but any page under https://wordpress.org/support/ have the same problem
Why is this a problem?
Because I think is super hard for any user to learn about any of the topics provided in the docs if they cannot establish an order and hierarchy of the docs they are reading
Suggested Fix
- Establish a clear hierarchy of docs and categories
- Highlight in the sidebar the category the current document belongs to
- Suggest knowledge recommended to understand the current document
- Suggest docs to read after reading the current document
- Highlight in the top bar where we are
Thank you, @juanmaguitar, for raising this topic! While providing support in the forums, I also found the documentation difficult to navigate. I can't imagine how challenging this must be for newcomers to WordPress.
I would like to add some additional observations and suggestions to explore. There is some overlap here with the ticket description, but I would like to include it for context.
Support Is Inconsistent with Other WordPress.org Documentation
Unlike the Make WordPress handbooks and much of the Developer documentation, the Support docs use categories, rather than pages. This presents challenges like:
Why Does This Matter?
Suggestions to Improve Discoverability of Support Documentation
tl;dr
To summarize, make the Support documentation follow a hierachical structure like that of the Make and Developer sections of WordPress.org. This includes left-side navigation that shows the position of the current document in the overall tree.
Support Landing Page
This page features a curated list of key starting points for support seekers. It should continue to function as such, so no change recommended.
Support Articles
Once a user has searched or navigated to a particular support article, the power of the left sidebar becomes evident. Articles and the "single page" view could be updated like this:
https://wordpress.org/support/
, create an intro page for each section, corresponding with each high-level category. For instance, the intro to "Installing WordPress" would be located athttps://wordpress.org/support/installing-wordpress/
.Final URLs for the migrated hierarchical content might appear similar to this:
Existing Category Pages
The category page has random ordering of articles under each category (e.g. "Getting Started"), and lacks page or article counts in its pagination.
This "random support article" view is of questionable utility to users looking for specific information. Rather than keep these pages around, each "category archive" page should be redirected to their new section intro pages.
Summary
These changes would make Support more easily navigable, similar to the Make and Developer documentation. With more accessible documentation, users should be able to find answers more quickly than asking on the forums, or seeking help on 3rd party sites that may have outdated content.
Thank you, @annezazu, for pointing me to this existing ticket!