Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- The Linux Foundation
- Technischer Redakteur:
- xiaoya
- Projektname:
- Dokumentation für das CHAOSS-D&I-Badge-Projekt erstellen
- Projektlänge:
- Standardlaufzeit (3 Monate)
Projektbeschreibung
Ich fasse die Hauptinhalte wie folgt zusammen: Die Hauptziele bestehen darin, die dokumentenbezogenen Aufgaben im Workflow zu bereichern, eine Community-spezifische Dokumentation für Diversitäts- und Irrelevante Aktivitäten zu erstellen und die mehrsprachige Dokumentation auf der Spezialplattform zu hosten, die in folgende Mikroaufgaben unterteilt werden kann: Aktuelle PR-Vorlage aktualisieren und integrieren und dabei weitere D&I-Messwerte und vielfältige Fragen verwenden. Einen konzeptionellen Überblick über das D&I-Kennzeichenprogramm verfassen Richtlinien für Bewerber anhand der JOSS-Dokumente verfassen Richtlinien für Prüfer anhand der JOSS-Dokumente verfassen Ein Dokument, in dem die verschiedenen Rollen und die jeweiligen Verantwortlichkeiten im gesamten Workflow erläutert werden. Ein Dokument, in dem erläutert wird, wie GitHub Probot für den Workflow verwendet wird Eine Leitlinie für Mitwirkende, die zeigt, wie ein Neuling entweder zum Projekt oder zum Dokument beitragen kann. Sie können bei der Übersetzung von Dokumenten helfen, die Leistung der automatischen Übersetzung insbesondere auf Chinesisch prüfen und bei Bedarf manuelle Übersetzungsarbeiten ausführen. Organisieren Sie die Dokumentation in einem mehrsprachigen Format, das der Übersetzungsarbeit entspricht. Verwenden Sie Gitbook, Read the Doc oder GitHub Wiki, um das Dokument zu hosten.
Liefergegenstand 1. Bereichern Sie die PR-Vorlage für Projekte und Veranstaltungen mit weiteren Metriken und vielfältigen Fragen. Diese Auslieferung umfasst alle dokumentbezogenen Arbeiten im Workflow, insbesondere die PR-Vorlage, die für die Bewerber ausgefüllt werden muss. Dies ist meiner Meinung nach die Kernkomponente des Workflows, da sie eine entscheidende Rolle bei der Bewertung der Prüfer spielt. Daher werden Form und Inhalt der Fragen während der Erstellung des Workflows optimiert. Ich werde dies anhand der folgenden Punkte erreichen: Auf verschiedenen Arten von Veranstaltungen oder Projekten basieren Mit mehr D&I-Messwerten kombinieren Vielfaltsfragen mit beweisbasierten Antworten verwenden
Liefergegenstand 2. Unten finden Sie einen Entwurf für die Dokumentation, die für die Community sichtbar ist.
Übersicht über die D&I-Badges
Einführung
Ziel
Badge-Stufen
Antrag auf ein Badge
Antrag auf ein Veranstaltungs-Badge
Vorlage für das PR-Dokument für Veranstaltungen
Antrag auf ein Projekt-Badge
Vorlage für das PR-Dokument für Projekte
Überprüfung
So werden Sie Prüfer
Richtlinie zu Interessenkonflikten bei D&I-Badges
Überprüfungskriterien
Überprüfungscheckliste
Rollen und Verantwortlichkeiten
Bewerber – PR-Dokument erstellen
Prüfer – PR-Dokument prüfen
Moderatoren – sich Rezensionen und Prüfaufträge ansehen
Administrator – abschließende Prüfung und Zusammenführen von PR-Dokumenten
Der Probot
Verhaltenskodex für D&I-Badges
So können Sie beitragen
Liefergegenstand 3. Die Dokumente in einem mehrsprachigen Format organisieren und auf Plattformen wie Read the Docs oder Gitbook hosten.
Im aktuellen Workflow werden einige automatisierte Übersetzungen untersucht. Ich werde dabei helfen, zu prüfen, wie gut das Übersetzungsergebnis insbesondere auf Chinesisch ist, z. B. hinsichtlich Richtigkeit und Flüssigkeit der Übersetzung. Das Dokument wird als Format vorliegen. Ich werde die technischen Dokumentationen auf Hostingplattformen wie Dokumentation lesen, Gitbook und GitHub-Wiki untersuchen und eine Plattform auswählen, die am besten zum Hosten der Open-Community-Dokumentation geeignet ist.