About my WP technical writing work
- After working on the web as a developer since 2007, I started to explore ways to follow my passion for documenting technical information and getting more involved in the WordPress community.
- In 2021, I began a new role as a WordPress Contributor and a WordPress technical writer at WordPress.org.
- In 2022, I took up the role of the Block Editor end-user Rep and Release co-lead.
- Since then I have actively worked on every WordPress release co-leading the Documentation team, from 5.8 to 6.4.
- I have also been one of the Noteworthy Contributors to the 6.4, 6.3, 6.2, 6.1, 6.0, and 5.8 releases.
Technical writing skills
- I have advanced WordPress experience – setting up new WordPress sites, installing and configuring themes and plugins, and troubleshooting errors.
- I have the ability to research and understand technical concepts and explain the features and capabilities of WordPress in simple terms.
- I write well-structured articles, edit and proofread my own work, and format posts and pages.
- I am proficient in image editing– taking screenshots and designing images so that they are clear, useful, and look good.
- I am skilled in SEO and know how to research keywords and use them in the content I write.
- I am well-versed in GitHub, Markdown, Google Analytics, HTML, and Photoshop.
- I love tinkering with code, and sharing what I learn by creating technical content.
“Femy is hard working and thorough, and have wide development experience to independently deliver high quality technical documentation with deep understanding of the topic. ”
Milana Cap
WordPress Engineer at XWP
Projects
Release co-lead for WordPress
- Release co-lead the Documentation team for 6.4, 6.3, 6.2, 6.1 releases.
- Triage the closed Gutenberg Pull Requests (PRs) in GitHub for each of the WordPress releases.
- Identify the PRs that require End User documentation update and add a label ‘Needs User Documentation’.
- Sort through the labeled PRs and group them into tasks based on the pages that need to be worked on, in the end-user documentation for each release.
- Create GitHub Projects in the Documentation repository for each of the WordPress releases.
- Add trackers with a detailed task list, and assign priorities and labels.
- Write a “Call for Volunteers” blog post requesting help from contributors for updating the pages for the release.
- Create videos for the Docs team to help understand the process of triaging and gardening and creating issues for every WordPress release.
- Work on the End User block editor documentation for the high-priority pages – Styles overview, Template Editor, Site Editor, etc. And have the high-priority pages ready for the release.
- Review and close the trackers once the contributors have worked on the content and make sure all the content is in line with the style guide in terms of content and design.
Block editor rep for Docs team
- As the Block Editor, I got the developers in the Core team to add a new label “Needs User Documentation” into the Gutenberg repository so it is easier to track the PRs that need an End User documentation update. This label is now used after each Gutenberg release, for user-facing changes in UI and screens. The end-user documentation team uses this label to triage their work, especially around new WordPress releases.
- Created a Contributor Day Task list and identified the tasks that can be done during the Contributor Days.
- Revamped the End User documentation Project board in GitHub and created workflows, priority, and status, to make them work better with the current workflow.
- Triage the closed Gutenberg Pull Requests (PRs) in GitHub for each of the WordPress releases and add issues to the End User documentation Project board in GitHub while prioritizing the tasks based on the About page drafts.
- Created clear processes and trackers with a detailed task list in the Project boards for each of the GitHub trackers for every release.
- Started writing regular “Call for Volunteers” blog posts requesting help from contributors for updating the pages for the release.
- Added a process for documenting the Deprecated blocks in the WordPress Documentation. And created a separate section for the deprecated blocks and documented clearly when it was deprecated and what block it replaced.
- Made it mandatory to add ALT tags to the images in the End user documentation. And added this task to the Contributor Day Tasks list.
- Create videos for the Docs team to help onboard new contributors to work on the documentation.
WordPress Docs contributor
- Work on the 6.0, 5.9, and 5.8 versions of the End User block editor documentation.
- Create new pages and update existing pages in the HelpHub block editor documentation for the WordPress release. Below are a few examples I worked on:
- Reworked the following pages:
- WordPress Block Editor (this replaced the previous 5.9 version)
- Working with blocks (new page created)
- Site Editor
- Template Editor
- Rewrite pages in the end-user docs(also called HelpHub) to remove the technical details, move the technical bits to the developer documentation and rebuild HelpHub. Below are a few pages I reworked for this project:
- Write meeting minutes for the Docs team meetings and publish them on the Make blog.
