Introduction
WriteTech Hub is a brand dedicated to creating excellent technical documentation and guiding individuals on how to make meaningful contributions to open-source projects. This blend of documentation expertise and open-source passion was one of the inspirations for our DocReview Series 🎉 👏.
On the 10th of September 2024, WriteTech Hub officially launched the WriteTech DocReview Series, a community-powered initiative aimed at improving the quality and clarity of technical documentation.
This cohort kicked off with a webinar that outlined the program’s goals, resources, and collaboration opportunities for all participants.
If you want to know more about the program, click here.
Highlights
The DocReview Series unfolded in three phases. Here’s how the journey went:
Phase 1: Documentation Selection and Contribution
The initial phase involved selecting documentation projects from our curated list of documentation. Participants selected their documentation projects, contributing insights to improve clarity, accessibility, and relevance for diverse audiences.
Phase 2: Review by External Reviewers
In this phase, Christine Belzie—an experienced writer, open source maintainer, and member of our community—and James ‘Alexander’ Akande, also a technical writer and member of our community, reviewed each piece of documentation, providing insightful feedback on the participants’ pull requests.
Phase 3: Review by Our Technical Writers
Our in-house technical writers, Peace Ngozi Okafor and Erinle Feyijimi, then conducted a final round of reviews, verifying that each document adhered to WriteTech Hub’s standards of quality and accessibility.
Feedback from Participants
We asked our participants how they felt about the program and the impact it had on their skills and knowledge. Here’s what they shared:
- This first feedback is from our external reviewer, Christine;
- Feedback from Hikmah Olawore;
- Here is what Ayu Adiati shared;
- Review by Ebenezer Raphael;
Final Notes
Thank you to all who participated, and stay tuned for more opportunities to learn and collaborate!
Want to be part of WriteTech Hub’s documentation journey? The DocReview Series is open to anyone passionate about creating clear and inclusive technical content. In the next cohort, we would like to collaborate with communities. If you are interested in working with us, kindly reach out to us via email at info@writetechhub.org.
Feel free to follow us on social media: LinkedIn, Instagram, and Twitter for upcoming programs.
