Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- The Linux Foundation
- Rédacteur technique:
- xiaoya
- Nom du projet:
- Documentation de création pour le projet de badgeage de l'innovation et de la recherche CHAOSS
- Durée du projet:
- Durée standard (trois mois)
Project description
Le contenu principal est le suivant : Les principaux objectifs sont d'enrichir les travaux liés aux documents dans le workflow, de rédiger une documentation sur les badges D&I présentés à la communauté, et d'héberger la documentation traitée en plusieurs langues sur une plate-forme spécialisée, qui peut être divisée en trois tâches : Mettre à jour et intégrer le modèle de RP actuel afin d'utiliser davantage de métriques de D&I et de diversifier les questions. Rédigez une présentation conceptuelle pour présenter le programme de badges D&I. Rédigez les consignes relatives aux applicateurs en vous appuyant sur des documents JOSS comme référence. Rédigez les consignes du réviseur en vous appuyant sur des documents JOSS comme référence. Un document expliquant les différents rôles et responsabilités respectives tout au long du workflow. Un document expliquant comment le probot GitHub est appliqué au workflow. Une consigne pour les contributeurs expliquant comment un nouveau contributeur peut contribuer au projet ou au document. Aider à la traduction de documents, vérifier les performances de la traduction automatique, en particulier en chinois, et effectuer des traductions manuelles si nécessaire. Organisez la documentation dans un format multilingue en fonction du travail de traduction. Hébergez le document sur Gitbook, Read the Doc ou GitHub Wiki.
Livrable 1. Enrichissez le modèle de relations publiques pour le projet et l'événement avec plus de métriques et diverses questions. Ce livrable comprend tout le travail lié aux documents dans le workflow, en particulier le modèle de communiqué de presse préparé pour les candidats. C'est ce que je pense être le composant principal du workflow, car il joue un rôle décisif dans l'évaluation des examinateurs. Par conséquent, la forme et le contenu des questions seront perfectionnés tout au long de la construction du workflow. Je vais le faire en m'appuyant sur les points suivants : Basé sur différents types d'événements ou de projets Combiné à d'autres métriques d'inclusion et de diversité Utilisation de différentes façons de poser des questions avec des réponses basées sur des preuves
Livrable 2. Vous trouverez ci-dessous un projet de structure de documentation destinée à la communauté.
Présentation du programme de badges pour la diversité et l'inclusion
Introduction
Objectif
Niveaux de badges
Demander un badge
Demander un badge pour un événement
Modèle de demande de publication pour un événement
Demander un badge pour un projet
Modèle de demande de publication pour un projet
Examen
Devenir examinateur
Règlement sur les conflits d'intérêts liés au programme de badges pour la diversité et l'inclusion
Critères d'examen
Checklist d'examen
Rôles et responsabilités
Demandeurs : créer une demande de publication
Examinateurs : examiner les demandes de publication
Modérateurs : examiner les examens et les attributions d'examens
Mainteneur : vérification finale et fusion des demandes de publication
Probot
Code de conduite du programme de badges pour la diversité et l'inclusion
Contribuer
Livrable 3. Organisez les documents dans un format multilingue et hébergez-les sur des plates-formes telles que Read the docs ou Gitbook.
Dans le workflow actuel, certaines traductions automatiques sont en cours d'exploration. Je vais vous aider à vérifier la qualité des résultats de traduction, en particulier en chinois, par exemple en vérifiant la justesse et la fluidité de la traduction. Le document existera sous forme de format. Je vais examiner les plates-formes d'hébergement de documentation technique telles que Read the docs, Gitbook et le wiki GitHub, et choisir la plate-forme la plus adaptée pour héberger la documentation destinée à la communauté ouverte.