Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Die Linux Foundation
- Technischer Redakteur:
- Xiaoya
- Projektname:
- Dokumentation für das CHAOSS-D&I-Abzeichenprojekt erstellen
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
Die wichtigsten Inhalte sind Folgendes: Das Hauptziel besteht darin, die dokumentenbezogenen Arbeiten innerhalb des Workflows zu bereichern, eine Community-Dokumentation zu Di&I-Logos zu schreiben und die mehrsprachige Dokumentation auf einer speziellen Plattform zu hosten, die in folgende Mikroaufgaben unterteilt werden kann: Die aktuelle PR-Vorlage aktualisieren und integrieren, um mehr Diversitäts-Messwerte zu verwenden und die Fragen vielfältiger zu gestalten. Entwurf einer konzeptionellen Übersicht zur Einführung des D&I-Logos Entwerfen Sie die Richtlinien für Anwender mit JOSS-Dokumenten als Referenz Entwerfen Sie die Richtlinien für Prüfer unter Verwendung von JOSS-Dokumenten als Referenz Ein Dokument, in dem verschiedene Rollen und die jeweiligen Verantwortlichkeiten im gesamten Workflow erläutert werden. Ein Dokument, in dem erläutert wird, wie GitHub Probot auf den Workflow angewendet wird. Eine Richtlinie für Beitragende, die zeigt, wie Neulinge entweder das Projekt oder das Dokument beitragen können. Sie unterstützen Sie bei der Übersetzung von Dokumenten, überprüfen die Leistung der automatischen Übersetzung insbesondere für Chinesisch und führen bei Bedarf manuelle Übersetzungen durch. Organisieren Sie die Dokumentation basierend auf der Übersetzungsarbeit in einem mehrsprachigen Format. Verwenden Sie Gitbook, Read the Doc oder GitHub Wiki, um das Dokument zu hosten.
Ergebnis 1. Die PR-Vorlage für Projekte und Veranstaltungen mit mehr Metriken und vielfältigen Fragen bereichern. Dieser Liefergegenstand umfasst alle dokumentenbezogenen Arbeiten innerhalb des Workflows, insbesondere die für die Bewerber vorbereitete PR-Vorlage. Dies ist meiner Meinung nach die Kernkomponente des Workflows, da sie eine entscheidende Rolle bei der Bewertung von Prüfern spielt. Form und Inhalt der Fragen werden also während der Erstellung des Workflows perfektioniert und ich werde dies unter folgenden Punkten präsentieren: Die Verwendung verschiedener Arten von Ereignissen oder Projekten mit mehr Nachweisbarkeit von Metriken und der Kombination von Fragen mit mehr Nachweismöglichkeiten.
Ergebnis 2. Unten finden Sie einen Entwurf für die Community-basierte Dokumentationsstruktur
Übersicht über das D&I-Logo
Einführung
Ziel
Badge-Stufen
Für ein Logo bewerben
Für Veranstaltungslogo beantragen
PR-Vorlage für die Veranstaltung
Projektlogo beantragen
PR-Vorlage für Projekt
Überprüfung
Wie werde ich zu Prüfern
D&I-Badge
Richtlinien zu Interessenkonflikten überprüfen
Prüfliste für Prüfteams und Moderatoren – Prüfung des Prüfteams und Moderatoren – Überprüfung der PR-Prüfliste
Überprüfung des Codes und Verantwortlichkeit des Prüfteams
Ergebnis 3. Organisieren Sie die Dokumente in einem mehrsprachigen Format und hosten Sie sie auf Plattformen wie „Dokumente lesen“ oder Gitbook.
Im aktuellen Workflow werden einige automatisierte Übersetzungen erkundet. Ich helfe dabei, zu prüfen, wie gut die Übersetzungsergebnisse speziell auf Chinesisch angezeigt werden, z. B. die Richtigkeit und Vollständigkeit der Übersetzung. Das Dokument wird als Format vorliegen. Ich prüfe die technischen Dokumentationsplattformen wie „Lesen Sie die Dokumente“, „Gitbook“ und „GitHub-Wiki“ und wähle eine Plattform aus, die sich am besten für die Open-Community-Dokumentation eignet.