Przewodnik mentora

Obecny etap:
Program Sezon Dokumentów 2020 zakończył się 15 marca 2021 r. Zobacz oś czasu.

Ten przewodnik jest przeznaczony dla mentorów zajmujących się tworzeniem oprogramowania open source, czyli członków organizacji open source, które uczestniczą w sezonie Dokumentów jako mentorzy dla twórców treści technicznych.

Wstęp

Ten przewodnik ułatwia wykonywanie zadań, za które odpowiadasz na poszczególnych etapach sezonu Dokumentów.

Jednym z Twoich celów jako mentora jest dopilnowanie, by tegoroczny sezon dokumentów był satysfakcjonujący dla twórców treści technicznych. Zwiększy to szanse, że autorzy materiałów technicznych będą nadal wnosić swój wkład do Twojego projektu open source po zamknięciu tegorocznego Sezonu Dokumentów, a inni autorzy techniczni będą chętniej pracować na licencji open source.

Etap wysyłania zgłoszenia do organizacji

Etap składania zgłoszeń trwa od 13 kwietnia 2020 r. do 4 maja 2020 r. W tym czasie administrator organizacji może przesłać zgłoszenie organizacji do udziału w sezonie Dokumentów. Administratorzy programu Google publikują listę organizacji odnoszących sukcesy 11 maja 2020 r.

Twoje zadania jako mentora na tym etapie

Utwórz listę pomysłów.

Wspólnie z administratorem organizacji utwórz listę pomysłów na projekty. Lista powinna zawierać co najmniej 1 projekt z dokumentacją, którym chcesz zająć się jako autor dokumentacji technicznej w tegorocznym sezonie Dokumentów.

Pomysły na projekty dotyczące pisania technicznego

Zarejestruj się na sezon dokumentów.

Zarejestruj się jak najszybciej, aby wziąć udział w tym sezonie.

Rejestracja na sezon Dokumentów 2020 została zakończona.

Opowiedz o sezonie dokumentów.

Poinformuj innych o tym, że Twoja organizacja bierze udział w świątecznym sezonie Dokumentów. Nawet jeśli Twoja organizacja nie znajdzie się na ostatecznej liście zaakceptowanych organizacji w tym roku, to i tak mamy dla Ciebie dobrą wiadomość: udało Ci się wziąć udział w procesie wyborczym.

Materiały promocyjne

Etap eksploracji scenarzystów technicznych

Etap odkrywania scenariuszy technicznych trwa od 11 maja do 8 czerwca 2020 r. W tym okresie pisarze zajmujący się kwestiami technicznymi analizują listę organizacji uczestniczących w programie i pomysły na projekty tych organizacji. Autorzy rozwiązań technicznych mogą kontaktować się bezpośrednio z jedną lub większą liczbą organizacji, aby omówić pomysły związane z projektem.

Twoje zadania jako mentora na tym etapie

Omawiaj pomysły na projekty z zainteresowanymi autorami materiałów technicznych.

Pomysły na projekty możesz omówić bezpośrednio z twórcą (kontakt z Twoją organizacją), który zwraca się bezpośrednio do Twojej organizacji. Dzięki temu może on przygotować dobrą propozycję projektu do przesłania do administratorów programu Google. Pomysły na projekt mogą pochodzić z listy pomysłów zaproponowanej przez Twoją organizację, a także z innych pomysłów zaproponowanych przez autora projektu.

Pomysły na projekty dotyczące pisania technicznego

Ocena propozycji twórców technicznych

Etap przesyłania zgłoszenia technicznego

Etap przesyłania zgłoszeń do scenariuszy technicznych trwa od 9 czerwca 2020 r. do 9 lipca 2020 r. W tym czasie pisarze mogą zgłosić się do udziału w sezonie Dokumentów, a organizacje wybierają projekty, którymi chcą się zająć.

Twoje zadania jako mentora na tym etapie

Ocenia oferty autorów tekstów technicznych.

Wspólnie z administratorem organizacji oceń propozycje autorów tekstów technicznych i wybierz projekty tekstów technicznych, którymi Twoja organizacja chce zarządzać podczas tegorocznego sezonu Dokumentów.

Ocena propozycji twórców technicznych

Etap budowania więzi ze społecznością

Etap budowania więzi ze społecznością trwa od 17 sierpnia do 13 września 2020 roku. W tym czasie mentorzy pomagają zaakceptowanym twórcom treści technicznych poznać projekt open source.

Twoje zadania jako mentora na tym etapie

Zaprezentuj autora technicznego projektu i społeczności open source.

Przedstaw autora projektu technicznego organizacji open source i pomóż redaktorowi zapoznać się z używanymi przez Ciebie narzędziami i procesami.

Współpraca z twórcą treści technicznych

Obowiązki Użytkownika

Opisz usługę autorowi technicznemu.

Poświęć trochę czasu na wyjaśnienie usługi (zwłaszcza koncepcyjnie) i dopilnuj, aby autor techniczny rozumieł odbiorców dokumentacji.

Współpraca z twórcą treści technicznych

Skonfiguruj kanały komunikacji.

Zachęć autora tekstu, by zaprezentował się na listach adresowych społeczności, na czacie, na kanale Slack i w innych udostępnianych kanałach komunikacji. Zadbaj o to, aby osoba odpowiedzialna za kwestie techniczne mogła komunikować się z Tobą w niezawodny sposób.

Obowiązki Użytkownika

Ustal cele i oczekiwania.

Współpracuj z twórcą technicznym, aby dopracować cele technicznego projektu pisania i określić oczekiwania po obu stronach. Celem jest osiągnięcie sukcesu.

Obowiązki Użytkownika

Faza tworzenia dokumentu

Faza tworzenia dokumentów trwa od 14 września 2020 roku do 30 listopada 2020 roku. W tym okresie pisarze techniczni pracują nad projektami pod bliskimi konsultacjami ze swoimi mentorami.

Twoje zadania jako mentora na tym etapie

Doradzaj autorom tekstów technicznych i zachęcaj ich do tego.

Ściśle współpracuj z autorem projektu ds. technicznych, by zapewnić pomyślne zakończenie projektu.

Współpraca z twórcą treści technicznych

Obowiązki Użytkownika

Wypełnij dowolne ankiety od administratorów programu Google.

Administratorzy programu Google mogą wysłać w trakcie projektu ankietę, aby ocenić postępy. Wypełnij ankietę i prześlij odpowiedzi do administratorów programu Google zgodnie z instrukcjami w dokumencie z ankietą.

Etapy finalizacji i oceny projektu

Faza finalizacji projektu trwa od 3 do 10 grudnia 2020 r. (daty są inne w przypadku długotrwałych projektów). W tym czasie twórcy treści technicznej przesyłają gotowe produkty i są oceniani przez mentora.

Etap oceny mentora trwa od 3 grudnia 2020 r. do 10 grudnia 2020 r. o godz. 18:00 czasu UTC. W tym czasie mentorzy oceniają powodzenie projektów dotyczących pisania technicznego oraz swoje doświadczenie we współpracy z twórcami treści technicznych.

Twoje zadania jako mentora na tym etapie

Napisz i prześlij swoją ocenę projektu technicznego.

Przejdź i prześlij swoją ocenę do 12 marca 2021 r. do godz. 18:00 czasu UTC.

Ocena projektu technicznego

Etap długotrwałej oceny projektu został zamknięty.

Długotrwałe projekty

W przypadku standardowych projektów pisania technicznego w sezonie Dokumentów etap opracowywania dokumentów trwa od 14 września do 30 listopada 2020 r. Niektórzy dziennikarze zajmujący się kwestiami technicznymi mogą ubiegać się o długotrwały projekt po konsultacji z organizacją open source. W przypadku długotrwałego projektu etap tworzenia dokumentów trwa od 14 września 2020 r. do 1 marca 2021 roku.

Okres finalizacji i oceny długo trwających projektów to 1–8 marca 2021 r. W tym czasie autorzy oceniają swoje produkty i usługi, a mentorzy dokonują oceny.

Twoje zadania jako mentora w długoterminowym projekcie

Doradzaj redaktorowi technicznemu i przesyłaj ocenę projektu.

Twoje zadania i obowiązki są takie same jak opisane na tej stronie w przypadku standardowych projektów pisania technicznego, z tym że daty zakończenia i oceny projektu przypadają później.