WriteTech DocReview Series Report 1.0

Background

WriteTech Hub is committed to fostering excellence in technical documentation and empowering individuals to contribute meaningfully to open-source projects. This dedication to documentation expertise and open-source collaboration inspired the creation of the WriteTech DocReview Series—a community-powered initiative to improve the quality and accessibility of technical documentation.

Introduction

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.

Goals

Community Goals

1. Skill Development: Enhance technical writing and review skills.
2. Portfolio Building: Offer participants opportunities to build and showcase professional portfolios.
3. Collaboration: Foster collaboration and mutual learning among community members.
4. Recognition: Acknowledge and highlight participant contributions.

Organisational Goals

1. Quality Improvement: Elevate the quality of technical documentation with community feedback.
2. Engagement: Increase active community participation.
3. Reputation Building: Position WriteTech Hub as a leader in technical writing and documentation.
4. Resource Development: Establish a repository of high-quality, vetted documentation reviews.

Want to know more about the program? Click here for more information.

Program Details

Process Overview

The DocReview Series was in three phases, here’s the structure it followed:

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.

Program Timeline

• Pre-Launch (August 20 – September 6):
  • Program designs and flyers were prepared.
  • Social media and email campaigns created awareness.
  • Webinars provided detailed guidance.
    
• Launch (September 10):
  • Official program launch announced.
  • Participants onboarded and began documentation reviews.
    
• Post-Launch:
  • Feedback from contributors and reviewers gathered.
  • Published reviews on community platforms and social media.
    

Highlights and Feedback

Key Highlights

• Community Participation: Participants contributed insightful reviews to improve documentation accessibility and clarity.
• Expert Guidance: External reviewers provided valuable feedback, enriching the learning experience.
• Collaboration: The collaborative effort fostered a sense of community and mutual growth.

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:

1. This first feedback is from our external reviewer, Christine

3. Feedback from Hikmah

4. Here is what Ayu Adiati shared
   

5. Review by Ebenezar;

Lessons Learned

1. Community Engagement:
   • Encouraging consistent participation through structured timelines and regular updates fosters better engagement.
     
2. Collaboration Opportunities:
   • Partnering with experienced reviewers and technical writers significantly enhances the quality of contributions.
     
3. Clear Communication:
   • Providing clear instructions and templates ensures consistency and reduces confusion among participants.
     
4. Skill Recognition:
   • Acknowledging participant contributions motivates continued involvement and builds community trust.
     

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 collaboration, 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.