Ta strona zawiera szczegóły projektu technicznego do pisania w sezonie Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- The Linux Foundation
- Pisarz techniczny:
- xiaoya
- Nazwa projektu:
- Tworzenie dokumentacji w ramach projektu dotyczącego przyznawania certyfikatów CHAOSS D&I
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Główne treści znajdują się w tych miejscach: Główne cele to wzbogacenie zadań związanych z dokumentami w ramach procesu roboczego, napisanie dokumentacji dotyczącej certyfikatów D&I dla społeczności oraz udostępnienie przetworzonej dokumentacji w wielu językach na specjalnej platformie. Można to podzielić na te mikrozadania: Zaktualizować i zintegrować obecny szablon PR, aby używać większej liczby wskaźników D&I i zapewnić różnorodność pytań. Opracowanie ogólnego zarysu koncepcji przedstawiającego program przyznawania certyfikatów w zakresie danych i informacji; Opracowanie wytycznych dla podmiotów aplikujących, korzystając z dokumentów JOSS jako materiału odniesienia; Opracowanie wytycznych dla recenzentów, korzystając z dokumentów JOSS jako materiału odniesienia; Dokument wyjaśniający różne role i odpowiadające im obowiązki w ramach przepływu pracy. Dokument wyjaśniający sposób stosowania sond GitHub w przepływie pracy Wytyczne dla współtwórców pokazujące, w jaki sposób nowy uczestnik może przesłać projekt lub dokument. pomagać w tłumaczeniu dokumentów, sprawdzać skuteczność tłumaczenia automatycznego, zwłaszcza w języku chińskim, oraz w razie potrzeby wykonywać tłumaczenia ręczne; uporządkować dokumentację w wielojęzycznym formacie na podstawie pracy związanej z tłumaczeniem; Użyj Gitbook, Read the Doc lub GitHub Wiki do hostowania dokumentu.
Wynik 1. wzbogacić szablon dotyczący projektu i działań PR-owych o dodatkowe dane i różnorodne pytania; Ten cel obejmuje całą pracę związaną z dokumentami w ramach przepływu pracy, a w szczególności szablon PR przygotowany dla kandydatów. Jest to moim zdaniem podstawowy element przepływu pracy, ponieważ odgrywa on decydującą rolę w procesie oceny treści przez weryfikatorów. Z tego powodu podczas tworzenia przepływu pracy dopracujemy formę i treść pytań. Omówię teraz następujące punkty: Posługiwanie się różnymi rodzajami zdarzeń i projektami wymaga połączenia różnych rodzajów danych i projektów.
Wynik 2. Poniżej przedstawiamy projekt struktury dokumentacji skierowanej do społeczności:
Omówienie systemu przyznawania odznak
Wprowadzenie
Cel
Poziomy odznak
Ubieganie się o odznakę
Ubieganie się o odznakę wydarzenia
Szablon PR dotyczący wydarzenia
Ubieganie się o odznakę projektu
Szablon PR dotyczący projektu
Weryfikacja
Jak zostać recenzentem
Polityka dotycząca konfliktu interesów w systemie przyznawania odznak
Kryteria weryfikacji
Lista kontrolna weryfikacji
Role i odpowiedzialność
Wnioski – tworzenie PR
Recenzenci – weryfikacja PR
Moderatorzy – przeglądanie opinii i przypisywanie zadań
Administratorzy – ostateczna weryfikacja i scalanie PR
Probot
Kodeks postępowania dotyczący systemu przyznawania odznak
Jak się zaangażować
Wynik 3. Uporządkuj dokumenty w wielojęzycznych formatach i hostuj je na platformach takich jak Read the Docs czy Gitbook.
W ramach bieżącego procesu pracy testujemy niektóre automatyczne tłumaczenia. Pomogę Ci sprawdzić, jak dobrze działają, zwłaszcza w języku chińskim, m.in. poprawność i płynność tłumaczenia. Dokument będzie dostępny w danym formacie. Zapoznam się z platformami do hostowania dokumentacji technicznej, takimi jak Read the Docs, Gitbook i GitHub Wiki, i wybiorę najlepszą platformę do hostowania dokumentacji dla otwartej społeczności.