Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Linux Foundation
- Rédacteur technique:
- xiaoya
- Nom du projet:
- Créer de la documentation pour le projet d'étiquetage CHAOSS D&I
- Durée du projet:
- Durée standard (3 mois)
Project description
Voici le contenu principal : Les principaux objectifs sont d'enrichir les travaux liés aux documents dans le flux de travail, de rédiger une documentation sur les badges D&I au niveau de la communauté, et d'héberger sur la plate-forme spécialisée la documentation traitée en plusieurs langues, qui peut être divisée en plusieurs microtâches : Mettre à jour et intégrer le modèle de relations publiques actuel avec davantage de métriques de D&I et diverses questions. Rédiger une présentation conceptuelle pour présenter le programme de badges D&I Rédiger les consignes applicables aux applicateurs en utilisant les documents JOSS comme référence Rédiger les directives pour les examinateurs en utilisant les documents JOSS comme référence Un document expliquant les différents rôles et responsabilités respectives tout au long du workflow. Document expliquant comment un probot GitHub est appliqué au workflow Directives destinées aux contributeurs indiquant comment un néophyte peut apporter sa contribution au projet ou au document. Vous pouvez apporter votre aide pour traduire des documents, vérifier les performances de la traduction automatique (en particulier pour le chinois) et traduire manuellement des documents si nécessaire. Organiser la documentation dans un format multilingue en fonction du travail de traduction. Utilisez Gitbook, lisez le document ou wiki GitHub pour héberger le document.
Livrable 1. Enrichissez le modèle de relations publiques du projet et de l'événement avec d'autres métriques et des questions diverses. Ce produit livrable comprend tout le travail lié au document dans le flux de travail, en particulier le modèle de RP préparé pour les candidats. C'est l'élément central du flux de travail, car il joue un rôle décisif dans l'évaluation par les réviseurs, de sorte que la forme et le contenu des questions seront perfectionnés tout au long de la construction du flux de travail. Je fournirai ces réponses sur les points suivants : En se basant sur différents types d'événements ou de projets avec des critères plus variés, avec davantage de critères de diversité des événements ou de projets.
Livrable 2. Vous trouverez ci-dessous un brouillon de structure de documentation destinée à la communauté
Présentation des badges D&I
Introduction
Objectif
Niveaux de badge
Demande d'un badge
Demande de badge d'événement
Modèle de PR pour l'événement
Modèle de demande de badge de projet
Modèle de PR du projet
Fusion
Comment devenir examinateur
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 cadre du processus actuel, nous étudions actuellement quelques travaux de traduction automatique. Je vais vous aider à vérifier si le résultat est correctement traduit en chinois, notamment en s'il s'agit d'une traduction correcte et fluide. Le document existera sous forme de format, je vais étudier les plateformes d'hébergement de documents techniques telles que lire les documents, Gitbook et le wiki GitHub, et choisir la plateforme la mieux adaptée pour héberger la documentation de la communauté ouverte.