Przewodnik administratora organizacji

Obecny etap:
Ogłoszenie wyników Oś czasu.

Ten przewodnik jest przeznaczony dla administratorów organizacji, które chcą wziąć udział w programie Sezon Dokumentów lub w nim uczestniczyć.

Czy Twoja organizacja powinna wziąć udział w programie Sezon Dokumentów?

Użyj tych pytań, aby zrozumieć, czy Twoja organizacja lub projekt open source powinny wziąć udział w tym programie.

Czy Twoja organizacja lub projekt:

  • Uważasz, że nowa lub zaktualizowana dokumentacja pomoże Ci osiągnąć cel albo rozwiązać problem związany z Twoim projektem bądź społecznością?
  • Masz wstępną koncepcję lub hipotezę określającą, w jaki sposób możesz zmierzyć sukces swojego projektu w zakresie dokumentacji?
  • Czy członkowie społeczności chętnie pomagają w rekrutacji, ocenie i wdrażaniu pisarzy technicznych, a także którzy będą mogli odpowiadać na pytania i udzielać innej pomocy w trakcie projektu (6–8 miesięcy, w tym okres przesyłania zgłoszeń)?
  • Czy któryś z członków społeczności chce zostać administratorem organizacji, koordynować tworzenie zgłoszenia, odpowiadanie na pytania administratorów programu, przesyłanie comiesięcznych ocen, końcową ocenę i studium przypadku? Administrator organizacji powinien też być chętny do wypełnienia kolejnych ankiet po zakończeniu programu Sezon Dokumentów.

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

Procedura zgłoszeniowa organizacji

Faza eksploracji

Choć zgłoszenia do programu Sezon Dokumenty są dostępne od 23 lutego 2022 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ń problemów z dokumentacją i możliwych danych. Strona powinna być publiczna i umożliwiać publikowanie treści przez społeczność oraz dyskusję. Uwzględnij informacje dla twórców technicznych, którzy chcą uczestniczyć w projekcie. Gdzie można zadawać pytania, wyrazić zainteresowanie lub dowiedzieć się więcej o Twoim projekcie? Sugerujemy dodanie adresu e-mail służącego do kontaktowania się z organizacją open source w sprawie Sezonu Dokumentów. Zdecydowanie odradzamy jednak używanie osobistego adresu e-mail jako adresu 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 serii Dokumentów na GitHubie. Możesz też udostępnić swój link na kanale #Holiday-of-docs w sekcji Write The Docs. Strona promocji i prasy zawiera logo oraz inne treści, których możesz użyć, wspominając o sezonie Dokumentów.
  • W przypadku każdej koncepcji dokumentacji zastanów się, jakie doświadczenie i kwalifikacje musi posiadać autor tekstu, aby skutecznie współpracować ze społecznością i organizacją. Jakie umiejętności mogłyby pomóc twórcom w rozwijaniu umiejętności technicznych (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ś ochotników, którzy będą odpowiadać na pytania zainteresowanych autorów treści technicznych.
  • Zacznij przeglądać wszystkie przesłane oświadczenia autorów tekstu o tematyce technicznej, którzy są zainteresowani pracą nad Twoim projektem.

Etap aplikacji

  • Wybrać najbardziej obiecującą propozycję ze strony oferty. 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óry pomysł pomoże rozwiązać największy problem Twojego projektu? Lepiej jest wybrać bardziej ryzykowny pomysł, który może przynieść większe korzyści, niż pomysł na projekt dokumentacji, który z dużym prawdopodobieństwem zostanie ukończony, ale nie będzie miał większego wpływu na Twój projekt.
    • Czy pomysł wymaga udziału konkretnych członków społeczności? Czy znajdzie się czas, aby wziąć w nim udział?

  • Utwórz ofertę pakietową, korzystając z szablonu oferty. Upewnij się, że rozumiesz i uwzględnij:

    • problem, który chcesz rozwiązać;
    • zakres dokumentacji, który chcesz ulepszyć lub utworzyć;
    • Jak będziesz mierzyć skuteczność swojej dokumentacji

    Oferta pakietowa musi też zawierać budżet. Niekompletne oferty pakietowe nie będą brane pod uwagę.

  • Prześlij formularz zgłoszeniowy do 25 marca 2022 r. do godziny 18:00 czasu UTC. Zaakceptowane propozycje zostaną ogłoszone 14 kwietnia 2022 r.

Opracowywanie i raportowanie projektów

Rozpoczęcie projektu

  • Jeśli Twoja organizacja wybrała już autorów tekstów technicznych do Twojego projektu, zorganizuj spotkanie inauguracyjne z autorem tekstów technicznych. Wspólnie z twórcą technicznym należy opracować harmonogram prac i regularne kontrole.
  • Jeśli zainteresowanych pisarzy technicznych otrzymasz wiele oświadczeń o zainteresowaniu, opublikuj publicznie informację o ich wyborze lub w inny sposób informuj kandydatów o swojej decyzji.

Przyznaj płatności

  • Po zatrudnieniu autora tekstu technicznego (od 9 czerwca 2022 r.) dana organizacja wpłaci 40% środków z grantu na konto Open Collective każdej organizacji. Zalecamy, aby organizacje ustanowiły harmonogram płatności wspólnie z autorami materiałów technicznych na podstawie etapów projektu, w tym płatności na początku projektu.
  • Od 14 grudnia 2022 r. pozostałe 60% środków będzie trafiać na konta Open Collective organizacji, które ukończą i prześlą ostateczne oceny oraz studia przypadków. Pamiętaj, że wszystkie udane projekty, niezależnie od terminu ukończenia, otrzymają płatność końcową 14 grudnia 2022 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 sprawdź folder ze spamem).

Ostateczna ocena projektu i studium przypadku

Aby otrzymać pozostałe środki, organizacje muszą zakończyć i przesłać końcową ocenę projektu oraz studium przypadku do 30 listopada 2022 r. do godz. 18:00 czasu UTC.

Ocena końcowa

Ostateczna wersja formularza oceny zostanie udostępniona administratorom organizacji nie wcześniej niż miesiąc przed 30 listopada 2022 r. o godz. 18:00 czasu UTC.

Studium przypadku

Studium przypadku dotyczące Sezonu Dokumentów jest najważniejszym elementem uczestnictwa Twojej organizacji w tym programie. Prowadzenie cotygodniowego dziennika aktualizacji projektu pomoże Ci w opracowaniu studium przypadku. Co tydzień zapisuj postępy projektu (w tym linki do żądań, problemów lub rozmów, jeśli są potrzebne), co poszło (lub nie), czego się dowiedziałeś(-aś), czego się dowiedziałeś(-aś) i zadane pytania.

Więcej informacji znajdziesz w artykule o tworzeniu studium przypadku. Utwórz studium przypadku, korzystając z szablonu studium przypadku. Studium przypadku należy przesłać za pomocą linku w formularzu oceny końcowej.

Twoje studium przypadku zostanie opublikowane w witrynie Season of Docs, więc pamiętaj o tym, dodając informacje o swoim projekcie.

Wymagamy, aby organizacje wzięły udział w co najmniej 3 ankietach uzupełniających, co pomoże nam śledzić sukces projektów związanych z sezonem Dokumentów na przestrzeni czasu.

Formularze

Formularz Link Termin
Zgłoszenie organizacji

Zakończyliśmy przyjmowanie zgłoszeń dla organizacji. Aby być na bieżąco, dołącz do listy adresowej z season-of-docs-announce.

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

Ten formularz nie jest jeszcze dostępny.

 12 maja 2022 r., 18:00 UTC
Dokument potwierdzający zatrudnienie pisarza technicznego

Etap zatrudnienia pisarzy technicznych został ukończony.

 16 maja 2022 r., 18:00 UTC
Oceny miesięczne

Miesięczny etap oceny już się zakończył.

 Zobacz oś czasu
Ocena końcowa projektu i studium przypadku

Etap oceny projektu został zakończony.

 30 listopada 2022 r., 18:00 UTC
Ankiety dodatkowe

Formularz dostępny podczas fazy kolejnych ankiet (2 maja 2023 r.).

 Zobacz oś czasu