End-user documentation roles:
General end-user documentation
Project code name: HelpHub
Project URL: https://wordpress.org/documentation/
Project GitHub issues label: user documentation
Project GitHub issues URL: user documentation
Responsibilities
- Work on end-user documentation issues in the Issue Tracker repo, whether it’s creating a new page or just fixing a part of an existing one.
- Report on progress at the Documentation team meetings – Project updates agenda item.
How do I do this job?
- Look for issues labelled with
user documentationlabel. - 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, by 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
Block editor end-user documentation
Project code name: HelpHub
Project URL: https://wordpress.org/documentation/article/blocks-list/
Project GitHub issues labels: user documentation, block editor
Project GitHub issues URL: user documentation + block editor
Responsibilities
- Work on block editor end-user documentation issues in the Issue Tracker repo, whether it’s creating a new page or just fixing a part of an existing one.
- Report on progress at the Documentation team meetings – Project updates agenda item.
How do I do this job?
- Look for issues labelled with
user documentationandblock editorlabels. - 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, by 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
Feedback curator
Project code name: HelpHub
Project URL: https://wordpress.org/documentation/wp-admin/edit-comments.php
Project GitHub issues labels: user documentation, block editor
Project GitHub issues URL: user documentation, block editor, any of the version labels
Responsibilities
- Regularly check on new Feedback (comments) being submitted to End user documentation, triage and create issues for them at the 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 the actual article (good or bad).
- Create an issue in the Issue Tracker repo. Use the
HelpHub Feedback reportstemplate. - The issue is automatically labelled with the
HelpHub feedbacklabel. Adduser documentationlabel is applicable (At this moment, in April 2023, we still have content that will be redirected to Advanced Administration Handbook. For such content, the label should be advanced administration). If applicable add ablock editorand any of the version labels. Labelling issues is important because some of the labels will send issues to appropriate GitHub projects via GitHub workflows. - Report on your progress at the Documentation team meetings – Project updates agenda item.
Recommended onboarding sessions