wporg-documentation-2022
wporg-documentation-2022 copied to clipboard
Consider adding introduction to what is included in the documentation site.
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 |
---|---|
If this is better clarified in newer designs, feel free to close.
I think the word "Help Center" has emerged as the most common way to talk about this type of information.
"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
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
Another suggestion, "Learn how to use WordPress"
I would suggest the following ones:
- WordPress User Manual
- WordPress User Guide
- WordPress Handbook
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
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 |
---|---|
It's a bit long, but it works pretty well. Or maybe just "Resources to help you get the most out of WordPress."?
Yeah, I like "Resources to help you get the most out of WordPress." better. I don't think "we" should be used.
"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