El proyecto Linux Foundation
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la
GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- La base de Linux
- Redactor técnico:
- xiaoya
- Nombre del proyecto:
- Documentación de compilación para el proyecto de insignias de D&I de CHAOSS
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Puse el contenido principal en lo siguiente:
Los objetivos principales son enriquecer los trabajos relacionados con los documentos dentro del flujo de trabajo, escribir una documentación de insignias de I&D orientada a la comunidad y alojar la documentación procesada en varios idiomas en una plataforma especializada, que se puede separar en las siguientes microtareas:
Actualizar e integrar la plantilla de relaciones públicas actual en el uso de más métricas de I&D y diversificar las preguntas.
Redacta un borrador de la descripción general conceptual para presentar el programa de insignias de D&I.
Redacta el borrador de los lineamientos para los postulantes con los documentos de JOSS como referencia.
Redacta el borrador de los lineamientos para los revisores con los documentos de JOSS como referencia.
Un documento en el que se expliquen los diferentes roles y sus respectivas responsabilidades a lo largo del flujo de trabajo.
Un documento en el que se explica cómo se aplica GitHub Probot para el flujo de trabajo.
Un lineamiento para colaboradores que muestre cómo un recién llegado puede contribuir con el proyecto o el documento.
Ayudar con el trabajo de traducción de documentos, verificar el rendimiento de la traducción automática, especialmente en chino, y realizar traducciones manuales si es necesario
Organiza la documentación en un formato multilingüe según el trabajo de traducción.
Usa Gitbook, Read the Doc o GitHub Wiki para alojar el documento.
Entrega 1. Enriquece la plantilla de relaciones públicas del proyecto y el evento con más métricas y preguntas diversas.
Este producto final incluye todo el trabajo relacionado con los documentos dentro del flujo de trabajo, en particular, la plantilla de RP preparada para que los postulantes la completen. Creo que este es el componente principal del flujo de trabajo, ya que desempeña un papel decisivo en la evaluación de los revisores, por lo que la forma y el contenido de las preguntas se perfeccionarán a lo largo de la construcción del flujo de trabajo, y lo haré en función de los siguientes puntos:
Basarse en diferentes tipos de eventos o proyectos
Combinar con más métricas de I&D
Usar diversas formas de preguntas con respuestas basadas en pruebas
Entrega 2. A continuación, se incluye un borrador de la estructura de la documentación para la comunidad.
Descripción general de las insignias de D&I
Introducción
Objetivo
Niveles de insignias
Cómo solicitar una insignia
Cómo solicitar una insignia de evento
La plantilla de relaciones públicas del evento
Cómo solicitar una insignia de proyecto
La plantilla de relaciones públicas del proyecto
Revisión
Cómo convertirse en revisor
Política de Conflicto de Intereses de las Insignias de D&I
Criterios de revisión
Lista de tareas de revisión
Roles y responsabilidades
Solicitantes: Crear relaciones públicas
Revisores: Revisar las relaciones públicas
Moderadores: Revisar las tareas de revisión y la combinación de relaciones públicas
Mantenedor: Realizar la verificación final y la combinación de relaciones públicas
Probot
Código de Conducta de las Insignias de D&I
Cómo contribuir
Entrega 3. Organiza los documentos en un formato multilingüe y alójalos en plataformas como Read the Docs o Gitbook.
En el flujo de trabajo actual, se están explorando algunas obras de traducción automatizada. Te ayudaré a verificar qué tan bien se realiza el resultado de la traducción, en especial en chino, como la corrección y la fluidez de la traducción.
El documento existirá como formato. Investigaré las plataformas de alojamiento de documentos técnicos, como Read the Docs, Gitbook y la wiki de GitHub, y elegiré la plataforma más adecuada para alojar la documentación abierta para la comunidad.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[[["Fácil de comprender","easyToUnderstand","thumb-up"],["Resolvió mi problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Falta la información que necesito","missingTheInformationINeed","thumb-down"],["Muy complicado o demasiados pasos","tooComplicatedTooManySteps","thumb-down"],["Desactualizado","outOfDate","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Problema con las muestras o los códigos","samplesCodeIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 2025-07-25 (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."]]
