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.