The WriteTech DocReview Series is a community-driven initiative organized by WriteTech Hub, aimed at improving the quality of technical documentation. This initiative empowers members to refine their technical writing skills, build a portfolio, and make a meaningful contribution to enhancing documentation across industries.
This series is designed to:
- Enable community members to build a portfolio by reviewing technical documentation.
- Provide vetted feedback from in-house technical writers.
- Share approved reviews publicly, recognizing community contributions.
- Skill Development: Enhance the technical writing and review skills of community members.
- Portfolio Building: Provide opportunities to build and showcase portfolios.
- Collaboration: Foster collaboration and mutual learning.
- Recognition: Acknowledge and highlight valuable contributions.
- Quality Improvement: Improve the quality of technical documentation through collective feedback.
- Engagement: Increase community participation and engagement.
- Resource Development: Build a repository of high-quality, vetted documentation reviews.
To participate in the WriteTech DocReview Series, you must meet the following criteria:
-
Be a Member of the WriteTech Hub Community
If you're not already a part of our community, you can join here and gain access to valuable resources, networking opportunities, and the chance to participate in community-driven initiatives like the DocReview Series. -
Technical Writing Experience
You must have experience in technical writing to ensure quality and consistency in reviews. This program is aimed at helping technical writers refine their skills while contributing to real-world documentation projects. -
Commitment to Quality
Each participant is expected to provide thorough, thoughtful, and constructive feedback in their reviews, following the provided template and guidelines.
📄 Documentation Selection: Community members select the technical documentation they'd like to review from the curated list.
✍️ Documentation Review Submission: Members write and submit their reviews using the provided review template.
🔍 Review Process: Each submission undergoes:
- External Review: Peer-reviewed by selected community members.
- Internal Review: Verified by in-house technical writers, all within the same PR thread.
📢 Public Sharing: Approved reviews are published publicly for community access.
| Stage | Dates | Details |
|---|---|---|
| Documentation Selection | 16th September – 23rd September | Community members select documentation to review. A list of available documentation will be provided. For more information on the doc selection process, see Documentation Selection Process |
| Review Submission | 16th September – 27th September | Participants submit their reviews using the provided template. |
| Initial Review by Experienced Writers | 26th September – 3rd October | Initial reviews are conducted by experienced community writers for preliminary feedback. |
| Vetting Process by Technical Writers | 7th October – 11th October | In-house technical writers vet the submitted reviews for accuracy and provide necessary feedback. |
| Public Sharing of Reviews | 16th October – 17th October | Approved reviews are formatted and shared publicly on the platform, blog, and social media. |
| Recognition & Contribution Highlights | 16th October onwards | Contributions are recognized, and top contributors are highlighted within the community. |
reviews/: Holds individual review submissions from the community.templates/: Contains the review template for submissions.docs/: Includes the documentation selection process and additional guidelines.
We encourage you to contribute by following these steps:
- Fork this repository.
- Use the review template located in the
templates/folder to craft your review. - Submit your review by creating a Pull Request (PR) in the
reviews/folder. - External reviewers will assess your PR, followed by an internal review by WriteTech’s technical writers.
This project is licensed under the MIT License – see the LICENSE file for details.
By participating in WriteTech DocReview Series, you're not only improving your technical writing skills but also helping enhance technical documentation that impacts real-world applications. If you're not already a member, join the WriteTech Hub Community to participate in the DocReview Series and access other exciting opportunities. Let’s create exceptional documentation together!
Have questions or suggestions? Feel free to open an issue or reach out via email at info@writetechhub.org.