Function: Write
Type: Task
Level: Beginner
You’ll report documentation problems — outdated content, typos, dead links, missing info — or propose new pages by opening issues in the WordPress Documentation Issue Tracker. Well-filed issues help the team prioritize fixes and get documentation updated faster.
Before you start
Complete the common setup first, then:
- Setup: Set up WordPress Playground for testing.
- Read: Read through the reporting an issue workflow so you understand how the team tracks and manages documentation work.
- Connect: Join #docs on 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/ and introduce yourself.
Steps
- Search existing issues on the Documentation Issue Tracker to make sure yours hasn’t already been reported.
- Open a new issue using the appropriate template — Fix Doc Issue Report for problems with existing pages, or New Doc Request for proposing new pages. Use a clear, action-oriented title following the format:
[Documentation area] + description(e.g.[HelpHub] Block Editor page missing character shortcut info). - Assign yourself by commenting
/assignon the issue. If that doesn’t work, leave a comment and a team member will assign you. - Submit for review when your work is ready by commenting
/reviewon the issue to move it to the[Status] Reviewlabel automatically.
Contribution checklist
- Searched existing issues to avoid duplicates
- Used the correct issue template with a clear
[Documentation area] + descriptiontitle - Issue includes enough detail for a contributor to understand and act on it
- Content follows the documentation style guides
What happens next
A contributor will review your work and comment with suggestions. Once the review is finalized, a team member will apply the fix and close the issue. If there’s no response after 2–3 weeks, pingPing The act of sending a very small amount of data to an end point. Ping is used in computer science to illicit a response from a target server to test it’s connection. Ping is also a term used by Slack users to @ someone or send them a direct message (DM). Users might say something along the lines of “Ping me when the meeting starts.” in #docs.
When you’re ready, file another issue or try working on one.
Help
Stuck? Check the getting help guide, then ask in #docs.
Further reading:
– Documentation Issue Tracker handbook page
– Documentation Grammar Guide
– Style and Formatting Guide
– Tone and Voice Guide
– External Linking Policy
– Screenshot best practices
– Issue labels reference
