The Linux Foundation project
Stay organized with collections
Save and categorize content based on your preferences.
This page contains the details of a technical writing project accepted for
Google Season of Docs.
Project summary
- Open source organization:
- The Linux Foundation
- Technical writer:
- xiaoya
- Project name:
- Build Documentation for CHAOSS D&I Badging Project
- Project length:
- Standard length (3 months)
Project description
I put the main content in the following:
The main goals are enriching the document-related works within the workflow, write a community-faced D&I badging documentation, and host the multi-language processed documentation on specialty platform, which can be separated into the following micro tasks:
Update and integrate the current PR template in the use of more D&I metrics and diverse the questions.
Draft a conceptual overview to introduce the D&I badging program
Draft the applier guidelines using JOSS docs as a reference
Draft the reviewer guidelines using JOSS docs as a reference
A document explaining different roles and respective responsibilities throughout the workflow.
A document explaining how GitHub probot is applied for the workflow
A contributor guideline to show how a newcomer can contribute either the project or the document.
Help with the translation work of documents, check the performance of the automatic translation especially in Chinese, and do manual translation works if necessary.
Organize the documentation in a multi-language format based on the translation work.
Use Gitbook, Read the Doc, or GitHub Wiki to host the document.
Deliverable 1. Enrich the project and event PR template with more metrics and diverse questions.
This deliverable includes all the document-related work within the workflow, particularly the PR template prepared for applicants to complete, this is what I think the core component of the workflow as it plays a decisive role on reviewers evaluation, so the form and content of questions will be perfected throughout the construction of the workflow, and I will deliver this from the following points:
Basing on different types of events or projects
Combining with more D&I metrics
Using diversity ways of questions with requiring of proof-based answers
Deliverable 2. Below is a draft community-facing documentation structure
Overview of the D&I Badging
Introduction
Goal
Badge levels
Applying for a badge
Apply for event badge
The event PR template
Apply for project badge
The project PR template
Reviewing
How to become a reviewer
D&I Badging Conflict of Interest Policy
Review criteria
Review checklist
Roles and Responsibility
Applicants - Create PR
Reviewers - Review PR
Moderators - To have a look at reviews and review assignments
Maintainer - Final Check and PR merge
The Probot
D&I Badging Code of Conduct
How to contribute
Deliverable 3. Organize the docs in a multi-language format and host them on platforms like Read the docs or Gitbook.
In the current workflow, some automated translation works are being explored, I will help with checking how well the result of translation is performed especially in Chinese, such as the correctness and fluency of translation.
The document will exist as a format, I will investigate the technical docs hosting platforms like Read the docs, Gitbook and GitHub wiki, and choose a best-suited platform to host the open community faced documentation.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-08 UTC."],[[["\u003cp\u003eThis project focuses on enhancing the documentation for the CHAOSS D&I Badging Project, an initiative of The Linux Foundation.\u003c/p\u003e\n"],["\u003cp\u003eThe primary objective is to improve the application and review process through refined templates, guidelines, and role definitions.\u003c/p\u003e\n"],["\u003cp\u003eDeliverables include enriched PR templates, comprehensive documentation, and multi-language support hosted on an appropriate platform.\u003c/p\u003e\n"],["\u003cp\u003eThe project aims to facilitate the D&I badging workflow and improve accessibility for both applicants and reviewers.\u003c/p\u003e\n"],["\u003cp\u003eThis Google Season of Docs project will be conducted over a standard three-month period.\u003c/p\u003e\n"]]],["The technical writing project aims to enhance the CHAOSS D&I Badging project's documentation. Key actions include: updating the PR template with diverse D&I metrics, drafting conceptual overviews, and creating guidelines for applicants, reviewers, and contributors. The project will also define roles and responsibilities within the workflow, explain GitHub probot's application, and organize the documentation in a multi-language format, focusing on Chinese translation accuracy. Finally, the content will be hosted on a suitable platform like Gitbook or Read the Docs.\n"],null,["# The Linux Foundation project\n\nThis page contains the details of a technical writing project accepted for\nGoogle Season of Docs.\n\n### Project summary\n\nOpen source organization:\n: The Linux Foundation\n\nTechnical writer:\n: xiaoya\n\nProject name:\n: Build Documentation for CHAOSS D\\&I Badging Project\n\nProject length:\n: Standard length (3 months)\n\n### Project description\n\nI put the main content in the following:\nThe main goals are enriching the document-related works within the workflow, write a community-faced D\\&I badging documentation, and host the multi-language processed documentation on specialty platform, which can be separated into the following micro tasks:\nUpdate and integrate the current PR template in the use of more D\\&I metrics and diverse the questions.\nDraft a conceptual overview to introduce the D\\&I badging program\nDraft the applier guidelines using JOSS docs as a reference\nDraft the reviewer guidelines using JOSS docs as a reference\nA document explaining different roles and respective responsibilities throughout the workflow.\nA document explaining how GitHub probot is applied for the workflow\nA contributor guideline to show how a newcomer can contribute either the project or the document.\nHelp with the translation work of documents, check the performance of the automatic translation especially in Chinese, and do manual translation works if necessary.\nOrganize the documentation in a multi-language format based on the translation work.\nUse Gitbook, Read the Doc, or GitHub Wiki to host the document.\n\nDeliverable 1. Enrich the project and event PR template with more metrics and diverse questions.\nThis deliverable includes all the document-related work within the workflow, particularly the PR template prepared for applicants to complete, this is what I think the core component of the workflow as it plays a decisive role on reviewers evaluation, so the form and content of questions will be perfected throughout the construction of the workflow, and I will deliver this from the following points:\nBasing on different types of events or projects\nCombining with more D\\&I metrics\nUsing diversity ways of questions with requiring of proof-based answers\n\nDeliverable 2. Below is a draft community-facing documentation structure\nOverview of the D\\&I Badging\nIntroduction\nGoal\nBadge levels\nApplying for a badge\nApply for event badge\nThe event PR template\nApply for project badge \n\nThe project PR template\nReviewing\nHow to become a reviewer\nD\\&I Badging Conflict of Interest Policy\nReview criteria\nReview checklist\nRoles and Responsibility\nApplicants - Create PR\nReviewers - Review PR\nModerators - To have a look at reviews and review assignments\nMaintainer - Final Check and PR merge\nThe Probot\nD\\&I Badging Code of Conduct\nHow to contribute\n\nDeliverable 3. Organize the docs in a multi-language format and host them on platforms like Read the docs or Gitbook.\n\nIn the current workflow, some automated translation works are being explored, I will help with checking how well the result of translation is performed especially in Chinese, such as the correctness and fluency of translation.\nThe document will exist as a format, I will investigate the technical docs hosting platforms like Read the docs, Gitbook and GitHub wiki, and choose a best-suited platform to host the open community faced documentation."]]
