Wprowadzenie

Sezon Dokumentów – witamy!

Ikona sezonu Dokumentów

Wspieranie współpracy open source z twórcami treści technicznych

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

Sezon of Docs ma na celu udostępnienie zespołowi twórców technicznych i projektów open source narzędzia do wspólnej pracy nad wspólnym celem, jakim jest ulepszenie dokumentacji projektu open source. Twórcy treści technicznych, którzy dopiero zaczynają korzystać z oprogramowania typu open source, mogą zyskać doświadczenie w uczestnictwie w projektach open source. Program ten może być nowym sposobem współpracy dla twórców treści technicznych, którzy już pracują na licencji open source. Sezon dokumentów to także okazja do projektów typu open source.

W trakcie programu autorzy materiałów technicznych spędzają kilka miesięcy, ściśle współpracując ze społecznością open source. Wprowadzają swoją fachową wiedzę w zakresie pisania materiałów w dokumentacji projektu, a jednocześnie poznają projekt open source i nowe technologie.

Projekty open source współpracują z autorami technicznymi, aby ulepszyć dokumentację i procesy projektu. Wspólnie mogą oni opracować nowy zbiór dokumentacji lub przeprojektować istniejące dokumenty albo ulepszyć i udokumentować procedury przekazywania darowizn w społeczności open source oraz proces wdrażania.

Wspólnie zwiększamy publiczną świadomość w zakresie dokumentów typu open source i pisania technicznego oraz dbamy o to, aby nasza współpraca przynosiła korzyści globalnej społeczności open source.

Jak to działa?

Oto ogólny przepływ pracy w programie Seasonal of Docs:

  • W tegorocznym sezonie Dokumentów organizacje open source starają się zostać mentorami. Razem ze zgłoszeniem może przesłać listę pomysłów na dokumentację projektu.

  • Autorzy tekstów technicznych przeglądając listę organizacji uczestniczących w programie i wybierają projekty, które ich interesują. Pisarz techniczny może skontaktować się z odpowiednimi organizacjami, aby omówić swoje pomysły. Pisarz techniczny pisze następnie propozycję projektu i przesyła ją do programu Season of Docs.

  • Organizacje potwierdzają projekty dotyczące pisania prac technicznych, które chcą przekazać.

  • Przyjęci twórcy zajmujący się tematyką techniczną spędzają kilka miesięcy, współpracując z mentorami z organizacji open source podczas realizacji swoich projektów.

  • Na koniec programu administratorzy programu Google informują o pomyślnych projektach.

Oś czasu zawiera szczegółowe informacje o czynnościach, które należy wykonać, i najważniejsze daty.

Uczestnicy i role

Poniżej znajdują się główne grupy użytkowników, którzy biorą udział w programie Sezon Dokumentów, oraz rolę, jaką każda z nich odgrywa w programie:

  • Administratorzy organizacji są członkami uczestniczących organizacji open source, które pełnią w swojej organizacji rolę głównych kontaktów w sezonie dokumentów. Administratorzy organizacji przesyłają zgłoszenia do udziału w usłudze Sezon Dokumentów, zarządzają mentorami w swoich organizacjach, dbają o realizację projektów technicznych, zajmują się dokumentami i zarządzają dystrybucją stypendium dla mentorów. Zapoznaj się z przewodnikiem i obowiązkami administratora

  • Mentorzy open source to organizacje uczestniczące w programie open source, które zostały przyjęte jako mentorzy na tegoroczny sezon korzystania z Dokumentów. Mentorowie ściśle współpracują z autorami treści technicznych, by zapewnić sukces projektu. Zapoznaj się z przewodnikiem i obowiązkami mentora.

  • Autorzy tekstów technicznych to pisarze z całego świata, którzy mogą wziąć udział w tegorocznym sezonie Dokumentów. Kandydaci powinni wykazać się wcześniejszym doświadczeniem w pisaniu prac, przesyłając opisy stanowisk i przykłady pracy. Zapoznaj się z przewodnikiem i obowiązkami dla autorów tekstu o tematyce technicznej.

  • Administratorzy programu Google to menedżerowie programów w Google, którzy zarządzają programem Sezon Dokumentów.

Dalsze kroki