Przewodnik administratora organizacji

Aktualna faza:
opublikowano studia przypadków. 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 open source lub organizacja 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 pracy copywritera technicznego oraz czy będą oni dostępni do udzielania odpowiedzi na pytania i świadczenia innego wsparcia podczas projektu (6–8 miesięcy, w tym okres składania wniosków)?
  • Czy członek społeczności jest gotowy pełnić rolę administratora organizacji i koordynować tworzenie aplikacji, odpowiadać na pytania administratorów programu oraz przesyłać miesięczne oceny, końcową ocenę i studium przypadku? Administrator organizacji powinien też być gotowy do wypełniania ankiet kontrolnych po zakończeniu programu Google Season of Docs.

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

Proces rejestracji organizacji

Proces rejestracji organizacji składa się z 2 etapów: eksploracji i rejestracji.

Etap eksploracji

Chociaż aplikacje na Google Season of Docs można przesyłać od 22 lutego 2024 roku, 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 na 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 prasy 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 potrzebowałby autor treści technicznych, aby współpracować z Twoją społecznością i organizacją. Jakich umiejętności może nauczyć się Twój zespół, aby pomóc copywriterowi technicznemu w rozwoju (np. za pomocą GitHuba lub narzędzia do automatyzacji procesu tworzenia dokumentacji)? (Zobacz przewodnik po współpracy z copywriterami technicznymi).
  • Poproś o pomoc wolontariuszy, którzy odpowiedzą na pytania zainteresowanych copywriterów technicznych.
  • Zacznij sprawdzać przesłane oświadczenia zainteresowania od 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ć pomysł bardziej ryzykowny, który będzie miał większy wpływ na projekt, niż pomysł na projekt dokumentacji, który prawdopodobnie zostanie ukończony, ale nie przyniesie znaczących korzyści.
    • 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 2 kwietnia 2024 r., do godziny 18:00 czasu UTC. Zaakceptowane oferty zostaną ogłoszone 10 kwietnia 2024 r.

Tworzenie projektu i raportowanie

Administratorzy organizacji powinni znać swoje obowiązki w każdej fazie programu.

Rozpoczęcie projektu

  • Jeśli Twoja organizacja wybrała już osobę lub osoby, które będą zajmować się pisaniem technicznym w Twoim projekcie, zorganizuj spotkanie wprowadzające z tą osobą. Współpracuj z autorem treści technicznych, aby stworzyć harmonogram pracy i regularnych spotkań.
  • 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 11 czerwca 2024 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 wykonawcami tekstów technicznych 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 13 grudnia 2024 r. lub później prześlą swoje ostateczne oceny i badania przypadków. Wszystkie projekty, które przeszły weryfikację, będą otrzymywać ostateczne płatności od 13 grudnia 2024 r.
  • Więcej informacji o tworzeniu konta Open Collective znajdziesz w przewodniku po płatnościach.

Raportowanie stanu projektu

  • Administratorzy organizacji powinni wypełnić 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 jeśli go nie widzisz, 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ć końcową ocenę projektu oraz analizę przypadku przed 10 grudnia 2024 r., do godziny 18:00 czasu UTC.

Ostateczna ocena

Formularze końcowej oceny i studium przypadku staną się dostępne dla administratorów organizacji nie później niż 1 stycznia 2025 r. o godz. 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 cotygodniowego dziennika aktualizacji projektu pomoże Ci stworzyć case study. W przypadku każdego tygodnia odnotuj postępy projektu (w tym linki do pull requestów, problemów lub 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 dowiedzieć się więcej, przeczytaj artykuł Tworzenie studium przypadku i upewnij się, że podczas tworzenia studium przypadku korzystasz z szablonu. Studium przypadku należy przesłać w formie linku w formularzu studium przypadku.

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

Ankiety kontrolne

Zakwalifikowane organizacje muszą wziąć udział w co najmniej 3 ankikietach kontrolnych, aby umożliwić śledzenie sukcesu projektów Google Season of Docs na przestrzeni czasu. Ankiety uzupełniające są kluczowe dla zrozumienia wpływu Google Season of Docs.

Formularze

Formularz Link Termin
Aplikacja organizacji

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

 2 kwietnia 2024 r., 18:00 UTC
Dane do płatności organizacji

Zakończono fazę dotyczącą danych do płatności organizacji. Jeśli chcesz wprowadzić zmiany w informacjach o płatnościach organizacji, skontaktuj się z administratorami Season of Docs.

 22 maja 2024 r., godz. 18:00 UTC
Dokument potwierdzający zatrudnienie copywritera

Etap zatrudniania copywritera zakończony.

 22 maja 2024 r., godz. 18:00 UTC
Oceny miesięczne

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

 Wyświetl oś czasu
Przesyłanie studium przypadku

Etap badania został zamknięty.

 10 grudnia 2024 r., 18:00 UTC
Ostateczna ocena programu

Etap oceny projektu został zakończony.

 10 grudnia 2024 r., 18:00 UTC
Ankiety kontrolne

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

 Wyświetl oś czasu