Skip to content

[HelpHub] Some end-user docs are too technical #30

@Kenshino

Description

@Kenshino

Issue Description

Some end-user docs are too technical and are reflective of a by-gone era where some hosts simply failed at supporting WordPress. Hence needing us to provide documentation.

e.g. https://wordpress.org/support/article/using-permalinks/ starts talking about htaccess etc. Really, we ought to just be telling the end-user to contact their host and work it out - perhaps with a recommended text.

URL of the Page with the Issue

https://wordpress.org/support/article/using-permalinks/

Section of Page with the issue

Why is this a problem?

I believe the technical bits (not just in this link) confuses end users.

Suggested Fix

Reassess all pages with technical bits and move those to DevHub if necessary.

How to work on these articles

What is too technical? Roughly explained:

  1. no code except for wp-config.php file
  2. only what can be done in wordpress dashboard
  3. no hosting provider specific docs, no server configuration etc

What's next?

  1. Pick up an article via creating an issue
  2. If you create an issue we assume you're working on it
  3. When you're ready, via the Projects link, push it into the Content Review Column
  4. One of us will review it for "official stamping", any others can provide suggestions, it's open source
  5. Once the content is verified to be good, it needs to be pushed into the Implementation column so teh content can be transcribed to WordPress.org
  6. After implemented, the issue needs to be pushed into the Style Guide review column so that someone can apply/review if the article is following the style guide

Project board: https://github.com/WordPress/Documentation-Issue-Tracker/projects/2

Metadata

Metadata

Assignees

Labels

[Status] DoneIssue is completedneeds discussionIssue that need discussion and team's decision. Will be discussed at the meeting.tracking issueUse to track a series of related issues.user documentation (HelpHub)Improvements or additions to end-user documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions