Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- The Linux Foundation
- Pisarz techniczny:
- Xiaoya
- Nazwa projektu:
- Dokumentacja tworzenia identyfikatorów projektu CHAOSS D&I
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Jej główne cele to: Główny cel: ulepszenie prac związanych z dokumentami w ramach przepływu pracy, stworzenie dokumentacji dotyczącej znaczników D&I przeznaczonych dla społeczności i przeprowadzanie wielojęzycznej dokumentacji na specjalnej platformie, którą można podzielić na następujące mikrozadania: Aktualizowanie i integrowanie bieżącego szablonu PR z wykorzystaniem większej ilości danych D&I i zróżnicowania pytań. Przygotuj wersję roboczą programu plakietki D&I Utwórz wersję roboczą wytycznych dla kandydatów w oparciu o dokumentację JOSS Utwórz wersję roboczą wytycznych dla weryfikatorów z użyciem dokumentów JOSS Dokument objaśniający różne role i obowiązki w trakcie całego przepływu pracy. Dokument wyjaśniający sposób stosowania probota GitHuba do przepływu pracy. Wytyczne dla współtwórców, które pokazują, jak osoba początkująca może wnieść swój projekt lub dokument. Pomoc w tłumaczeniu dokumentów, sprawdzanie wydajności automatycznego tłumaczenia (szczególnie na język chiński) i w razie potrzeby tłumaczenie ręczne. Uporządkuj dokumentację w wielojęzycznym formacie na podstawie zadania tłumaczeniowego. Hostuj dokument za pomocą Gitbooka, sekcji Read the Doc lub witryny GitHub Wiki.
Realizacja 1. Uzupełnij szablon PR dotyczący projektu i wydarzenia o więcej danych i zróżnicowane pytania. Ten projekt obejmuje wszystkie prace związane z dokumentami, a zwłaszcza przygotowane dla kandydatów szablony PR. Sądzę, że jest to podstawowy element przepływu pracy, ponieważ odegra on kluczową rolę w procesie oceny weryfikatorów. Pytania będą dopracowywane w ramach całego procesu tworzenia i sprawne, jeśli chodzi o formę i treść. Pytania będą wymagały:
Realizacja 2. Poniżej znajduje się wersja robocza dokumentacji dla społeczności
Omówienie projektów weryfikacji i oznaczania D&I
Wprowadzenie
Cel
Poziomy odznaki
Składanie wniosku o plakietkę
Składanie wniosku o plakietkę wydarzenia
Szablon PR wydarzenia
Składanie wniosku o plakietkę projektu
Szablon PR projektu
Ocena
Jak zostać weryfikatorem
Jak zostać weryfikatorem
Jak zostać weryfikatorem
D&I Zgodność z procedurą weryfikacji i stosowanie zasad
weryfikacji w ramach procesu scalania
Zasada weryfikacji i stosowanie zasad weryfikacji
kodu weryfikacji
Konkurencji i prowadzenia przez moderatora
Przygotowania do weryfikacji
Poziomów weryfikacji i odpowiedzialności
Przygotowania do weryfikacji
uprawnień i odpowiedzialności
Realizacja 3. Porządkuj dokumenty w wielojęzycznym formacie i hostuj je na platformach takich jak Read the docs lub Gitbook.
W ramach bieżącego procesu analizowane są niektóre zadania tłumaczenia automatycznego. Pomogę sprawdzić, jak działa tłumaczenie (zwłaszcza w języku chińskim), na przykład prawidłowość i płynność tłumaczenia. Dokument będzie dostępny w formie formatu. Sprawdzę platformy hostujące dokumentację techniczną, takie jak „Read the docs”, Gitbook czy GitHub wiki, a potem wybiorę najlepszą platformę do hostowania otwartej dokumentacji przeznaczonej dla społeczności.