Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- Linux Foundation
- Escritor técnico:
- Xiaoya
- Nombre del proyecto:
- Documentación de compilación para el proyecto de insignia de CHAOSS D&I
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Incluí el contenido principal en lo siguiente: Los objetivos principales son enriquecer las obras relacionadas con documentos dentro del flujo de trabajo, escribir una documentación sobre insignias de Diversidad e información para la comunidad, y alojar la documentación procesada en varios idiomas en la plataforma especializada, que se puede separar en las siguientes microtareas: Actualizar e integrar la plantilla de relaciones públicas actual con más métricas de inclusión y diversidad y diversificar las preguntas. Redacta una descripción general conceptual para presentar el programa de insignias de D&I. Redacta los lineamientos para aplicadores usando documentos JOSS como referencia. Redacta los lineamientos para revisor con documentos JOSS como referencia. Un documento en el que se expliquen las diferentes funciones y responsabilidades correspondientes a lo largo del flujo de trabajo. Un documento en el que se explica cómo se aplica el Probot de GitHub para el flujo de trabajo. Un lineamiento para el colaborador que muestra cómo un principiante puede contribuir con el proyecto o con el documento. Ayuda con el trabajo de traducción de documentos, verifica el rendimiento de la traducción automática especialmente en chino y realiza trabajos de traducción manual 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 Wiki de GitHub para alojar el documento.
Entrega 1. Enriquece la plantilla de RR.PP. del proyecto y el evento con más métricas y preguntas diversas. Este entregable incluye todo el trabajo relacionado con los documentos dentro del flujo de trabajo, en particular la plantilla de relaciones públicas preparada para que los postulantes completen. Creo que este es el componente central 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 entregaré desde los siguientes puntos: Basarse en diferentes tipos de eventos o proyectos que requieren pruebas combinando con más D&I.
Entrega 2. A continuación se muestra un borrador de la estructura de documentación para la comunidad.
Descripción general de las insignias de D&I
Introducción
Objetivos
Niveles de insignia
Postularse para una insignia
Solicitar insignia del evento
La plantilla de RR.PP. del evento
Solicitar insignia del proyecto
La plantilla de RR.PP. del proyecto
Revisión
Cómo convertirse en revisor
Insignias de D&I Conflicto de intereses Política
Revisar criterios
Revisar lista de tareas
Roles y Responsabilidades
Responsables de revisión y RR.PP.
Entrega 3. Organiza los documentos en un formato de varios idiomas y alójalos en plataformas como Leer los documentos o Gitbook.
En el flujo de trabajo actual, se están explorando algunos trabajos de traducción automática. Ayudaré a verificar qué tan bien se realiza el resultado de la traducción, especialmente en chino, como la precisión y fluidez de la traducción. El documento existirá como formato. Investigaré las plataformas de hosting de documentos técnicos, como Leer los documentos, Gitbook y la wiki de GitHub, y elegiré la plataforma más adecuada para alojar la documentación abierta a la comunidad.