Przewodnik administratora organizacji

Obecna faza:
ogłoszono wyniki. Zobacz oś czasu.

Ten przewodnik jest przeznaczony dla administratorów organizacji, którzy zgłaszają się do programu Google Season of Docs lub w nim uczestniczą.

Czy Twoja organizacja powinna wziąć udział w programie Google Season of Docs?

Odpowiedzi na te pytania pomogą Ci ustalić, czy Twój projekt lub organizacja open source powinna wziąć udział w Google Season of Docs.

Czy Twoja organizacja lub projekt:

  • Czy uważasz, że nowa lub zaktualizowana dokumentacja pomoże Ci osiągnąć cel lub rozwiązać problem w Twoim projekcie lub społeczności?
  • Czy masz już pewną wiedzę lub hipotezę na temat tego, jak zmierzyć skuteczność projektu dokumentacji?
  • Czy członkowie społeczności są gotowi pomóc w rekrutacji, ocenie i wprowadzeniu do zespołu nowego copywritera oraz czy będą dostępni do udzielania odpowiedzi na pytania i zapewniania innego wsparcia podczas projektu (6–8 miesięcy, w tym okres składania zgłoszeń)?
  • Czy masz członka społeczności, który może pełnić funkcję administratora organizacji i koordynować tworzenie aplikacji, odpowiadać na pytania administratorów programu oraz przesyłać oceny miesięczne, końcową ocenę i studium przypadku? Administrator organizacji powinien też być gotowy do odpowiedzi na ankiety uzupełniające po zakończeniu programu Google Season of Docs.

Organizacja powinna też spełniać wymagania programu, w tym mieć możliwość utworzenia konta Open Collective.

Proces rejestracji organizacji

Etap eksploracji

Chociaż aplikacje w ramach Google Season of Docs można przesyłać od 15 lutego 2023 r., zdecydowanie zalecamy, aby organizacje przed przesłaniem aplikacji wykonały czynności z fazy eksploracji.

  • Utwórz stronę propozycji projektu. Strona z ofertą zawiera listę najważniejszych potrzeb, celów lub problemów, możliwe rozwiązania dotyczące dokumentacji oraz możliwe dane. Ta strona powinna być publiczna i umożliwiać społeczności tworzenie treści oraz prowadzenie dyskusji. Dołącz informacje dla autorów technicznych, którzy chcą wziąć udział w programie. Wspomnij, gdzie mogą zadawać pytania, wyrażać zainteresowanie i uczyć się więcej o Twoim projekcie. Zalecamy dodanie adresu e-mail, aby móc kontaktować się z organizacją open source w sprawie Google Season of Docs. Zdecydowanie odradzamy jednak używanie osobistego adresu e-mail jako adresu kontaktowego organizacji open source. (przykłady znajdziesz na liście pomysłów na projekty).
  • Udostępnij stronę propozycji w kanałach społeczności i dodaj swoją organizację do listy zainteresowanych organizacji w repozytorium GitHub Google Season of Docs. Możesz też udostępnić link na kanale #season-of-docs w Slacku Write The Docs. Strona promocji i materiałów prasowych zawiera logo i inne treści, których możesz używać, gdy mówisz o Google Season of Docs.
  • W przypadku każdego pomysłu dotyczącego dokumentacji zastanów się, jakiego doświadczenia i kwalifikacji wymagałby autor tekstów technicznych, aby współpracować z Twoją społecznością i organizacją. Jakich umiejętności może nauczyć się Twój zespół, korzystając z GitHuba lub narzędzia do tworzenia dokumentacji? (Zobacz przewodnik po współpracy z twórcami treści technicznych).
  • Poproś o pomoc wolontariuszy, którzy odpowiedzą na pytania zainteresowanych autorów treści technicznych.
  • Zacznij sprawdzać przesłane oświadczenia o zainteresowaniu ze strony autorów technicznych, którzy chcą pracować nad Twoim projektem.

Faza aplikacji

  • Wybierz najbardziej obiecującą propozycję ze strony projektu. Każda organizacja może przesłać tylko jedną propozycję. Oto kilka kwestii, które warto wziąć pod uwagę:
    • Która z idei spotkała się z największym zainteresowaniem autorów tekstów technicznych?
    • Która z nich pomoże rozwiązać największy problem projektu? Lepiej wybrać ryzykowniejszy pomysł, który będzie miał większy wpływ, niż pomysł na projekt dokumentacji, który jest bardziej prawdopodobny do ukończenia, ale nie będzie miał większego znaczenia dla projektu.
    • Czy pomysł wymaga udziału konkretnych członków społeczności? Czy mają czas na udział?

  • Utwórz ofertę, korzystając z szablonu oferty. Pamiętaj, aby uwzględnić te informacje:

    • Problem, który chcesz rozwiązać
    • Zakres dokumentacji, którą chcesz ulepszyć lub utworzyć
    • Jak mierzyć skuteczność dokumentacji

    Propozycja musi też zawierać budżet. Niekompletne propozycje nie będą brane pod uwagę.

  • Prześlij formularz zgłoszeniowy do 24 marca 2023 r., do godziny 18:00 czasu UTC. Zaakceptowane oferty zostaną ogłoszone 31 marca 2023 r.

Opracowanie projektu i raportowanie

Rozpoczęcie projektu

  • Jeśli Twoja organizacja wybrała już osobę lub osoby, które będą pisać teksty techniczne na potrzeby projektu, zorganizuj spotkanie organizacyjne z tą osobą lub tymi osobami. Współpracuj z autorem dokumentacji technicznej, aby stworzyć harmonogram pracy i regularnie sprawdzać postępy.
  • Jeśli otrzymasz wiele oświadczeń zainteresowania od zainteresowanych copywriterów, opublikuj informację o wybraniu copywritera lub w inny sposób poinformuj kandydatów o swojej decyzji.

Płatności z grantów

  • Od 7 czerwca 2023 r. Google Season of Docs będzie wpłacać 40% środków z grantu na konto Open Collective każdej organizacji, która zatrudniła copywritera technicznego. Zalecamy, aby organizacje ustalały harmonogram płatności z autorami technicznymi na podstawie kamieni milowych projektu, w tym płatności na etapie rozpoczęcia projektu.
  • Pozostałe 60% zostanie wpłacone na konta organizacji, które 5 grudnia 2023 r. lub później prześlą swoje ostateczne oceny i studia przypadków. Pamiętaj, że wszystkie projekty, które zostały już zaakceptowane, niezależnie od harmonogramu ich realizacji (np. 3-miesięczny lub 6-miesięczny projekt), zaczną otrzymywać płatności końcowe 5 grudnia 2023 r.
  • Więcej informacji o tworzeniu konta Open Collective znajdziesz w przewodniku po płatnościach.

Raportowanie stanu projektu

  • Administratorzy organizacji powinni wypełniać miesięczne raporty o stanie w ciągu tygodnia od otrzymania linku do formularza raportu o stanie (link zostanie wysłany e-mailem, więc sprawdź folder ze spamem).

Ostateczna ocena projektu i studium przypadku

Aby otrzymać pozostałą część środków z grantu, organizacje muszą wypełnić i przesłać ostateczną ocenę projektu oraz przypadek badawczy przed 21 listopada 2023 r., do godziny 18:00 czasu UTC.

Ostateczna ocena

Formularz końcowej oceny będzie dostępny dla administratorów organizacji nie później niż na miesiąc przed 21 listopada 2023 r. o godzinie 18:00 czasu UTC.

Studium przypadku

Studium przypadku z Google Season of Docs to kluczowy element udziału Twojej organizacji w Google Season of Docs. Prowadzenie tygodniowego dziennika zmian w projekcie pomoże Ci stworzyć studia przypadku. W przypadku każdego tygodnia odnotuj postępy projektu (w tym linki do pull requestów, problemów i rozmów, jeśli to przydatne), co poszło dobrze (lub nie), co się udało Ci nauczyć i jakie pytania zostały zadane.

Aby uzyskać więcej informacji, przeczytaj artykuł Tworzenie studium przypadku. Pamiętaj, aby utworzyć studium przypadku, postępuj zgodnie z szablonem studium przypadku. Studium przypadku należy przesłać jako link w formularzu końcowej oceny.

Twoje case study zostanie opublikowane na stronie Google Season of Docs, więc pamiętaj o tym, gdy podajesz informacje o swoim projekcie.

Organizacje muszą wziąć udział w co najmniej 3 ankietach kontrolnych, aby pomóc nam śledzić sukces projektów Google Season of Docs na przestrzeni czasu.

Formularze

Formularz Link Termin
Aplikacja organizacyjna

Nie przyjmujemy już zgłoszeń od organizacji. Aby otrzymywać powiadomienia, dołącz do listy adresowej season-of-docs-announce.

 24 marca 2023 r., 18:00 UTC
Dane do płatności organizacji

Zakończono etap wprowadzania informacji o płatnościach organizacji. Jeśli chcesz wprowadzić zmiany w informacjach o płatnościach organizacji, skontaktuj się z administratorami Season of Docs.

 3 maja 2023 r., 18:00 UTC
Dokument potwierdzający zatrudnienie copywritera

Etap zatrudniania copywritera zakończony.

 10 maja 2023 r., 18:00 UTC
Oceny miesięczne

Zakończyła się miesięczna faza oceny.

 wyświetlić oś czasu,
Ocena projektu końcowego i studium przypadku

Formularz oceny programu

 21 listopada 2023 r., 18:00 UTC
Ankiety kontrolne

Formularz dostępny w fazie ankiet kontrolnych (1 maja 2025 r.).

 Wyświetl oś czasu