Work on Documentation Issues

You’ll review documentation issues for accuracy and relevance, then either review existing fixes or write new ones when needed. This takes the heavy lifting off team members and helps publish fixes faster.

Steps

  1. Set up your testing environment. Open WordPress Playground for testing changes.

  2. Pick an issue to review from these ready-for-review issues. Comment /assign to claim it as a reviewer. Multiple reviewers per issue are welcome.

  3. Understand the problem. Read the issue description, visit the live documentation page, and confirm the reported problem still exists.

  4. Check if a fix exists:

    • If there’s a proposed fix: Review it for accuracy, grammar, style, tone, links, screenshots, and accessibilityAccessibility Accessibility (commonly shortened to a11y) refers to the design of products, devices, services, or environments for people with disabilities. The concept of accessible design ensures both “direct access” (i.e. unassisted) and “indirect access” meaning compatibility with a person’s assistive technology (for example, computer screen readers). (https://en.wikipedia.org/wiki/Accessibility) against the standards in the Documentation Team Handbook. Check the pages linked in Further Reading below.
    • If there’s no fix yet AND the issue is valid: Write a proposed fix following the Documentation Team Handbook standards. Include the corrected text in your comment using markdown formatting.
  5. Leave a summary comment with what you checked, any problems found, and specific suggestions (or your proposed fix if you wrote one). Mention a team member (@zzap or @atachibana) when ready for a final check.

Contribution checklist

  • Confirmed the reported problem still exists on the live page
  • Either reviewed the existing fix OR wrote a new one if needed
  • Checked against the Documentation Team Handbook standards
  • Posted a summary comment and mentioned a team member for final check

What happens next

A team member will review your feedback and either request changes or 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, pick up another issue or try filing one.

Help

Stuck? Check the getting help guide, then ask in #docs.

Further reading:
Documentation Grammar Guide
Style and Formatting Guide
Tone and Voice Guide
External Linking Policy
Screenshot best practices
What is WordPress Playground? — learn more about using WordPress Playground

Write
Beginner-friendly task

New here? Get set up with accounts, community basics, and info on badges.