Make WordPress Core

Opened 8 weeks ago

Last modified 8 weeks ago

#64889 new enhancement

Include link to documentation for all plugins

Reported by: hartzhomestead's profile hartzhomestead Owned by:
Milestone: Awaiting Review Priority: normal
Severity: normal Version:
Component: Plugins Keywords:
Focuses: Cc:

Description

As a new WordPress user who just spent 3 months moving an OpenCart website to WordPress, one frustration I've often run into is installing a plugin that's recommended to fill a need, only to have a hard time finding clear instructions on how to use it. Sometimes it's even hard to find where it's hiding, under Tools or Users as a sub-menu item, or only as an added feature in Appearance>Customize.
The format in Admin Menu>Installed Plugins for each plugin usually lists the developer, settings, de-activate and auto-update links, and "View Details" which has tabs for Description, FAQ, Reviews and other info about the plugin but almost never how to use it.
6 out of my 24 plugins do have a "Documentation" link. Seems to me that should be a requirement for all plugins. Often there is a page somewhere with instructions, but it is not listed here, takes a while to find, and it's quicker for me to just ask Google Ai for instructions, which usually are quite good.
If we want WordPress to be user-friendly for average business owners or anyone else to create their own website, I'd say there's a long way to go in providing clear instructions. I've built 2 websites before and while this one will be faster, more secure, and work well with Google Shopping, I'm astounded at how complicated it has been.

Change History (2)

#1 @audrasjb
8 weeks ago

  • Focuses accessibility removed
  • Version 6.9.4 deleted

Hello, welcome to WordPress Core Trac, and thanks for sharing your thoughts as a WordPress user, that's of course an interesting feedback :)

However, there are +60000 plugins on the repository… the majority of them don't have any documentation at all and it is ok since we didn't require them to have one at the first place, and I think it is just impossible to make it a hard rule as many of them don't need any documentation at all as the plugin doesn't have any settings screen (it just works after you install it). This request is just impossible to fulfill.

By the way, I think adding a "Documentation URL" readme metadata would be a nice improvement for themes and plugins. Then we could link to that documentation in the plugin/theme links. This should first be addressed on meta.trac.wordpress.org though, as this Trac is dedicated to WordPress Core (= the source code of the CMS itself).

#2 @hartzhomestead
8 weeks ago

OK, thanks for the feedback. I had posted in the forum and was told I should comment here, did not know these even existed. I realize my perspective is limited to a few months experience. I do think adding a Documentation URL, and link to it, should be encouraged whenever possible and useful.

Note: See TracTickets for help on using tickets.