survey – Make WordPress Documentation

Welcome to the official home of the WordPress Documentation Team.

This team is responsible for coordinating all documentation initiatives around WordPress, including the handbooks and other general wordsmithing across the WordPress project.

Want to get involved?

Start here to find out more about what we do and how to contribute:

Onboarding to Documentation Team: An overview of what we do and how to collaborate
Documentation Issue Tracker on GitHub: Submit any Documentation Team-related issues on GitHubGitHub GitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/

Weekly meetings

Join our discussions of documentation issues here on the blog and on Slack.

The documentation team holds weekly office hours and monthly Contributor Days on each Tuesday of the month in the #docs SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. channel. It’s also where you can contact the team at any time outside meetings.

@jenmylo is conducting a contributor experience survey. It’s short – only 4 questions – and none of them are required.

Link: http://wordpressdotorg.polldaddy.com/s/wordpress-contributor-experience-poll

After you’re done taking the survey, post about it on your blog, tweet the link, and tell your co-contributors and other community members about the survey so they can take it too.

Thanks!

#survey

The Codex survey is closed and the next stage is to go through the responses. We’re going to do this by user type:

Drew – Advanced Users
Eric – WP Builder & novice dev
Siobhan – Intermediate dev
Jerry – WP User

Please post your results here by Friday 14th June. We’ll be using the results along with other research that’s been going on to do a workshop on the first morning of the docs sprint.

A few notes for the reviewers:

Use the filterFilter Filters are one of the two types of Hooks https://codex.wordpress.org/Plugin_API/Hooks. They provide a way for functions to modify data of other functions. They are the counterpart to Actions. Unlike Actions, filters are meant to work in an isolated manner, and should never have side effects such as affecting global variables and output. at the top to filter by your assigned user group I’ve edited your access so you just get the results for the user group you’re looking at.
Remember that if a respondent provides a particularly insightful answer you can click on the report number to the left of their answer and read through that person’s individual report.

If there’s any other questions you feel should be added to the report, let me know in the comments.

Outline for Report

User Type:

Learning preferences (please list in descending order, noting the percentage):

Notable answers listed under other:

Top three places to look for an answer to a question (list in descending order, noting the percentage):

Are there any other places that these users are regularly looking for answers (make sure you check through the “Option option” answers)?

How useful is the Codex to this user group?

What sections of the Codex do these users find most useful?

What are the main problems these users face with the Codex?

What documentation would these users like to see more of?

Based on your review of this survey, do you have any general observations about how this user group is making use of the Codex and documentation more generally?

Based on your review of the survey, what recommendations would you make specifically about the WordPress CodexWordPress Codex Living online manual to WordPress.org https://codex.wordpress.org/ that would help these users?

Based on your review of this survey, make three recommendations for improved documentation that would serve these users:

Contributing to WordPress Docs

What percentage of these users have contributed to WordPress Docs?

What percentage are aware that they can use their WordPress.orgWordPress.org The community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/ login to edit the Codex?

How can we make it easier for these users to contribute to WordPress docs?

#codex, #survey

I’m putting together a survey which we can get people to answer about WordPress’ documentation. I’ll get it online later this week, but I thought it would be worth seeing if you guys had any suggestions for questions that you think would be useful. The aim of the survey is to:

help to create a new architecture of the documentation
help us to discover pain points
create a list of priorities for new documentation

Okay, here’s what I’ve come up with so far.

Are you:

1. WordPress user (I use WordPress to run my website/blog)
2. WordPress builder (I build and customize websites but I don’t write PHPPHP PHP (recursive acronym for PHP: Hypertext Preprocessor) is a widely-used open source general-purpose scripting language that is especially suited for web development and can be embedded into HTML. https://www.php.net/manual/en/preface.php.)
3. Novice developer (learning to write my first plugins/themes)
4. Intermediate developer (I write plugins and themes and they’re pretty good)
5. Advanced developer (I dream in PHP)

What documentation do you currently use (select all that apply):

1. Codex – guides
2. Codex – APIAPI An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways. documentation
3. Tutorials and guides on blogs
4. Books
5. Breaking WordPress/plugins/themes and putting them back together
6. Premium services
7. Screencasts
8. PHP docs and inline documentation
9. Forums (like wp.org or stack exchange)

How useful do you find the WordPress CodexWordPress Codex Living online manual to WordPress.org https://codex.wordpress.org/:

1-10

What types of documentation/learning do you prefer?

1. Tutorials
2. User Guides
3. Breaking stuff and putting it back together
4. Screencasts
5. Code references and API documentation
6. In-person training
7. PHP docs and inline documentation

What’s the first place you go when you have a question about how something in WordPress works?

Codex
Google
Other: [open]

What do you find most helpful about the Codex:

[open]

What problems do you face with the Codex (check all that apply):
Incomplete documentation
Out of date documentation
I can’t find what I need
Content isn’t clear
Content isn’t accurate
Difficult to navigate
Other:

What would you like to see more of:
Tutorials
Handbooks focused on specific tasks
Screencasts
Better code reference
Better inline help
????
Other:

What improvements to documentation would improve your experience of using or developing with WordPress:

[open field]

Have you ever contributed to the WordPress Codex:

Yes/No

Would you like to contribute to the WordPress Codex:

Yes/No

If you’ve never contributed to the Codex, can you please say why:

[open field]

#survey

Want to get involved?

Weekly meetings

Tag Archives: survey

WordPress Contributor Experience Survey

The Codex survey is closed and the next…

Outline for Report

Contributing to WordPress Docs

Documentation Survey

Want to get involved?

Weekly meetings

Outline for Report

Contributing to WordPress Docs

Site resources