Obecny etap:
opracowywanie dokumentacji. Sprawdź oś czasu.
Ten przewodnik jest przeznaczony dla administratorów organizacji, którzy chcą dołączyć do programu Sezon Dokumentów Google lub do niego dołączyć.
Czy Twoja organizacja powinna wziąć udział w programie Sezon Dokumentów Google?
Użyj tych pytań, aby zdecydować, czy Twój projekt lub organizacja open source powinna wziąć udział w sezonie korzystania z Dokumentów Google.
Czy Twoja organizacja lub projekt:
- Uważasz, że nowa lub zaktualizowana dokumentacja może pomóc osiągnąć cel albo rozwiązać problem w Twoim projekcie lub społeczności?
- Masz wstępne rozumienie lub hipotezę dotyczące sposobu pomiaru skuteczności projektu związanego z dokumentacją?
- Czy członkowie społeczności chcą pomóc w rekrutacji, ocenie i wdrożeniu pisarza technicznego, a także kto będzie odpowiadać na pytania i zapewnić inne wsparcie w trakcie projektu (6–8 miesięcy, łącznie z okresem zgłaszania się)?
- Czy członek społeczności chce pełnić rolę administratora organizacji i koordynować tworzenie zgłoszenia, odpowiadanie na pytania administratorów programu, składanie comiesięcznych ocen, końcową ocenę i studium przypadku? Administrator organizacji powinien też wyrazić zgodę na wypełnienie dodatkowych ankiet po zakończeniu programu Sezon Dokumentów Google.
Organizacja powinna też spełniać wymagania programu, m.in. mieć możliwość utworzenia konta Open Collective.
Procedura zgłoszeniowa organizacji
Faza eksploracji
Chociaż zgłoszenia do Sezonu Dokumentów Google można przesyłać od 22 lutego 2024 r., zdecydowanie zalecamy, aby przed przesłaniem zgłoszenia organizacje skorzystały z odpowiednich działań na etapie Eksploracji.
- Utwórz stronę propozycji projektu. Strona oferty pakietowej zawiera listę kluczowych potrzeb, celów lub problemów, możliwych rozwiązań w zakresie dokumentacji i możliwych danych. Ta strona powinna być publiczna i umożliwiać publikowanie treści przez społeczność oraz dyskusję. Podaj informacje dla autorów chętnych do uczestnictwa w badaniu. Gdzie można zadawać pytania, wyrazić zainteresowanie lub dowiedzieć się więcej o Twoim projekcie? Zalecamy dodanie adresu e-mail do kontaktu z organizacją open source w sprawie sezonu Dokumentów Google. Zdecydowanie odradzamy jednak używanie osobistego adresu e-mail jako adresu e-mail do kontaktowania się z organizacją open source. Przykłady znajdziesz na liście pomysłów na projekty.
- Opublikuj stronę z propozycją w kanałach społeczności i dodaj swoją organizację do listy zainteresowanych organizacji w repozytorium Sezonu Google na GitHubie. Możesz też udostępnić link na kanale #Season-of-docs w sekcji Write The Dokumenty Slack. Strona promocyjna i strona prasowa zawiera logo i inne materiały, których możesz użyć, omawiając sezon Dokumentów Google.
- W przypadku każdej propozycji dokumentacji zastanów się, jakie doświadczenie i kwalifikacje musi posiadać autor tekstu, aby skutecznie współpracować z Twoją społecznością i organizacją. Jakie umiejętności byłyby pomocne w rozwijaniu umiejętności autora (np. przy użyciu GitHuba lub łańcucha narzędzi dokumentów)? (Przeczytaj przewodnik dotyczący współpracy z twórcami treści technicznych).
- Poproś wolontariuszy o pomoc w odpowiadaniu na pytania zainteresowanych autorów technicznych.
- Zacznij przeglądać wszystkie przesłane oświadczenia autorów technicznych zainteresowanych pracą nad Twoim projektem.
Faza aplikacji
- Na stronie oferty pakietowej wybierz najbardziej obiecujący pomysł. Każda organizacja może przesłać tylko jedną ofertę. Oto kilka kwestii, które warto wziąć pod uwagę:
- Który pomysł cieszy się największym zainteresowaniem twórców technicznych?
- Która koncepcja pomoże rozwiązać największy problem Twojego projektu? Lepiej wybrać bardziej ryzykowny pomysł, który może mieć większy wpływ niż pomysł na projekt dokumentacji, który z większym prawdopodobieństwem zostanie ukończony, ale nie będzie miał istotnego wpływu na projekt.
- Czy pomysł wymaga udziału konkretnych członków Twojej społeczności? Czy mają czas, aby wziąć udział w programie?
Utwórz ofertę pakietową, korzystając z szablonu oferty. Upewnij się, że rozumiesz i uwzględniasz:
- problem, który chcesz rozwiązać.
- zakres dokumentacji, którą chcesz ulepszyć lub utworzyć;
- Jak będziesz mierzyć skuteczność dokumentacji
Oferta pakietowa musi również zawierać budżet. Niekompletne oferty pakietowe nie są uwzględniane.
Prześlij formularz zgłoszeniowy przed upływem terminu 2 kwietnia 2024 r. do godz. 18:00 czasu UTC. Zaakceptowane propozycje zostaną ogłoszone 10 kwietnia 2024 r.
opracowywanie i raportowanie projektów,
Rozpoczęcie projektu
- Jeśli Twoja organizacja wybrała już autora lub autora tekstu technicznego do Twojego projektu, umów się na spotkanie inauguracyjne z twórcą. Wraz z autorem tekstu ds. technicznych opracuj harmonogram prac i regularne kontrole.
- W przypadku wielu zgłoszeń od zainteresowanych autorów technicznych należy opublikować ogłoszenie o wyborze autorów technicznych lub w inny sposób poinformować kandydatów o swojej decyzji.
Przyznaj płatności
- Po zatrudnieniu pisarza technicznego od 11 czerwca 2024 r. organizacja wpłaci 40% środków z grantu na konto Open Collective każdej organizacji. Zalecamy, aby organizacje ustanowiły harmonogram płatności z pomocą specjalistów ds. technicznych na podstawie etapów projektu, w tym płatności na początku projektu.
- Od 13 grudnia 2024 r. pozostałe 60% środków będzie trafiać na konta Open Collective organizacji, które ukończą i prześlą ostateczne oceny i studia przypadków. Płatności końcowe za wszystkie udane projekty będą realizowane 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łe środki, organizacje muszą przed 10 grudnia 2024 r. o godzinie 18:00 czasu UTC przesłać końcową ocenę projektu oraz studium przypadku.
Ocena końcowa
Ostateczny formularz oceny zostanie udostępniony administratorom organizacji co najmniej miesiąc przed 10 grudnia 2024 r. o godz. 18:00 czasu UTC.
Studium przypadku
Studium przypadku dotyczące sezonu Dokumentów Google jest kluczowym elementem uczestnictwa organizacji w programie Sezon Dokumentów Google. Prowadzenie cotygodniowego dziennika aktualizacji projektu pomoże Ci w stworzeniu studium przypadku. W każdym tygodniu zapisuj postępy projektu (w tym linki do żądań, problemów lub rozmów, jeśli jest to przydatne), co poszło dobrze, a co nie, czego się nauczyłeś(-aś) i zadane pytania.
Więcej informacji znajdziesz w artykule o tworzeniu studium przypadku. Utwórz studium przypadku, korzystając z naszego szablonu. Studium przypadku należy przesłać za pomocą linku w formularzu ostatecznej oceny.
Twoje studium przypadku zostanie opublikowane w witrynie Sezon Dokumentów Google, więc pamiętaj o tym, dodając informacje o swoim projekcie.
Zaakceptowane organizacje muszą wypełnić co najmniej 3 ankiety uzupełniające, aby umożliwić śledzenie postępów projektów Dokumentów Google Sezonu Google na przestrzeni czasu.
Formularze
| Formularz | Link | Termin |
|---|---|---|
| Aplikacja organizacji | Zgłoszenia organizacji zostały zamknięte. Aby być na bieżąco, dołącz do listy adresowej na stronie season-of-docs-announce. |
2 kwietnia 2024 r., 18:00 UTC |
| Dane do płatności organizacji | 14 maja 2024 r. o 18:00 UTC | |
| Potwierdzenie zatrudnienia pisarza technicznego | 22 maja 2024 r., 18:00 UTC | |
| Oceny miesięczne | Formularz dostępny na etapie oceny projektu (5 czerwca 2024 r.). |
Zobacz oś czasu |
| Końcowa ocena projektu i studium przypadku | Formularz jest dostępny na etapie ostatecznej oceny projektu i studium przypadku (22 listopada – 10 grudnia 2024 r.). |
10 grudnia 2024 r. o 18:00 UTC |
| Ankiety dodatkowe | Formularz dostępny podczas fazy kolejnych ankiet (1 maja 2025 r.). |
Zobacz oś czasu |