wporg-documentation-2022 icon indicating copy to clipboard operation
wporg-documentation-2022 copied to clipboard

Consider adding introduction to what is included in the documentation site.

Open StevenDufresne opened this issue 1 year ago • 9 comments

WordPress.org has a lot of different types of documentation in many different places. We have this product documentation, developer documentation, process documentation (handbooks), etc..

When I arrive on /documentation, it isn't clear what documentation I'm about to see. For me as a developer, I think of WordPress as a developers ecosystem and therefore assume documentation is code documentation.

Although there are probably larger changes to how we talk about documentation, could we add a simple clarifying statement to contextualize what I'm going to find on this sub site?

Screenshots

Current Rough Idea
Screenshot 2024-02-08 at 2 09 38 PM Screenshot 2024-02-08 at 2 14 50 PM

If this is better clarified in newer designs, feel free to close.

StevenDufresne avatar Feb 08 '24 05:02 StevenDufresne

I think the word "Help Center" has emerged as the most common way to talk about this type of information.

StevenDufresne avatar Feb 08 '24 05:02 StevenDufresne

"Help Center" can be confused with Support or the Forums, in the case of WP.org.

But I do agree with you that we need to start differentiating the type of documentation each repository has. So a tagline or an intro paragraph describing the type of information and who is it for, is doable.

FYI, the documentation in this repository is geared to non-developers

estelaris avatar Feb 08 '24 09:02 estelaris

Maybe:

  • Self-serve articles to help you get started with WordPress.
  • Articles to help you get started with WordPress.
  • Written guides to help you navigate WordPress from launch to usage.
  • Written guides to get you started with WordPress.
  • Written guides for using WordPress.
  • WordPress usage articles
  • Using WordPress

jennimckinnon avatar Feb 20 '24 14:02 jennimckinnon

Another suggestion, "Learn how to use WordPress"

ndiego avatar Feb 21 '24 19:02 ndiego

I would suggest the following ones:

  • WordPress User Manual
  • WordPress User Guide
  • WordPress Handbook

sagargurnani99 avatar Feb 27 '24 10:02 sagargurnani99

There are several proposals that could be used, but because we already have "documentation" in the URL and the title, I think is better to add a tagline to the title, something like

Documentation / non-developer user guide

estelaris avatar Feb 29 '24 14:02 estelaris

The tagline in the browser title is "We’ve got a variety of resources to help you get the most out of WordPress." so I tried that:

Desktop Mobile
doc-home-large doc-home-small

It's a bit long, but it works pretty well. Or maybe just "Resources to help you get the most out of WordPress."?

ryelle avatar Aug 07 '24 20:08 ryelle

Yeah, I like "Resources to help you get the most out of WordPress." better. I don't think "we" should be used.

ndiego avatar Aug 07 '24 20:08 ndiego

"Resources to help you get the most out of WordPress."

It sounds good, but I feel it still needs clarification that they are non-dev/no code resources

estelaris avatar Aug 08 '24 16:08 estelaris