End user roles

End user documentation roles:

General end user documentation

Project code name: HelpHub
Project URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.orghttps://wordpress.org/support/
Project 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/ issues label: user documentation
Project GitHub issues URLuser documentation

Responsibilities

  • Work on end user documentation issues in Issue Tracker repo, whether it’s creating a new page or just fixing a part of existing one.
  • Report on progress at the Documentation team meetings – Project updates agenda item.

How do I do this job?

  • Look for issues labeled with user documentation label.
  • Communicate with General end user docs project reps for any clarifications on the tasks and review of your work. All questions can be asked in the actual GitHub issue, pinging any of the project reps.
  • Updating the documentation page/article is usually done by one of the project reps or active contributors who have access to the dashboard where end user documentation lives. Consistent contribution over time allows project reps to get to know you and gain trust in you, which can result in giving you access to the dashboard for updating the pages after the review is completed and content approved.
  • Report on your progress at the Documentation team meetings – Project updates agenda item.

Recommended onboarding sessions

Top ↑

Block editor end user documentation

Project code name: HelpHub
Project URLhttps://wordpress.org/support/article/blocks/
Project GitHub issues labels: user documentation, block editor
Project GitHub issues URLuser documentation + block editor

Responsibilities

  • Work on blockBlock Block is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage using the WordPress editor. The idea combines concepts of what in the past may have achieved with shortcodes, custom HTML, and embed discovery into a single consistent API and user experience. editor end user documentation issues in Issue Tracker repo, whether it’s creating a new page or just fixing a part of existing one.
  • Report on progress at the Documentation team meetings – Project updates agenda item.

How do I do this job?

  • Look for issues labeled with user documentation and block editor labels.
  • Communicate with Block editor end user docs project reps for any clarifications on the tasks and review of your work. All questions can be asked in the actual GitHub issue, pinging any of the project reps.
  • Updating the documentation page/article is usually done by one of the project reps or active contributors who have access to the dashboard where end user documentation lives. Consistent contribution over time allows project reps to get to know you and gain trust in you, which can result in giving you access to the dashboard for updating the pages after the review is completed and content approved.
  • Report on your progress at the Documentation team meetings – Project updates agenda item.

Recommended onboarding sessions

Top ↑

Feedback curator

Project code name: HelpHub
Project URLhttps://wordpress.org/support/wp-admin/edit-comments.php
Project GitHub issues labels: user documentation, block editor
Project GitHub issues URLuser documentationblock editorany of the version labels

Responsibilities

  • Regularly check on new Feedback (comments) being submitted to End user documentation, triage and create issues for them at Issue Tracker repo.
  • Report on progress at the Documentation team meetings – Project updates agenda item.

How do I do this job?

  • Regularly check new feedback/comments at end user documentation.
  • Delete spam and unrelated comments – anything that is not feedback on actual article (good or bad).
  • Create issue in Issue Tracker repo.
  • Label the issue with user documentation label, add block editor and any of the version labels if applicable.
  • Report on your progress at the Documentation team meetings – Project updates agenda item.

Recommended onboarding sessions

Last updated: