Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
StevenDufresne opened this issue Feb 8, 2024 · 9 comments
Labels
[Component] Content Bugs or issues related to the page content [Status] Needs Copy Feedback [Type] Enhancement New feature or request

Comments

@StevenDufresne
Copy link
Contributor

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 StevenDufresne added [Type] Enhancement New feature or request [Type] Question Needs input from others before actionable labels Feb 8, 2024
@StevenDufresne
Copy link
Contributor Author

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

@estelaris
Copy link
Member

"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

@ryelle ryelle added the [Component] Content Bugs or issues related to the page content label Feb 8, 2024
@jennimckinnon
Copy link

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

@ndiego
Copy link
Member

ndiego commented Feb 21, 2024

Another suggestion, "Learn how to use WordPress"

@sagargurnani99
Copy link

I would suggest the following ones:

  • WordPress User Manual
  • WordPress User Guide
  • WordPress Handbook

@estelaris
Copy link
Member

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

@ryelle ryelle moved this to 🛑 Pending discussion in WordPress.org Aug 6, 2024
@ryelle ryelle added [Status] Needs Copy Feedback and removed [Type] Question Needs input from others before actionable labels Aug 6, 2024
ryelle added a commit that referenced this issue Aug 7, 2024
This was an experiment, it should not have been merged. See discussion in #82, text has not been decided on yet.
@ryelle
Copy link
Collaborator

ryelle commented Aug 7, 2024

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."?

@ndiego
Copy link
Member

ndiego commented Aug 7, 2024

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

@estelaris
Copy link
Member

"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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Component] Content Bugs or issues related to the page content [Status] Needs Copy Feedback [Type] Enhancement New feature or request
Projects
Status: 🛑 Pending discussion
Development

No branches or pull requests

6 participants