Przewodnik dla pisarzy technicznych

Obecny etap:
opracowywanie dokumentacji. Sprawdź oś czasu.

Ten przewodnik jest przeznaczony dla autorów treści technicznych zainteresowanych współpracą z zaakceptowanymi organizacjami w programie Google Season of Dokumentów.

Czy warto wziąć udział w programie Sezon Dokumentów Google?

Użyj tych pytań, aby zdecydować, czy chcesz podjąć współpracę z zaakceptowaną organizacją w ramach programu Sezon Dokumentów Google.

  • Czy masz umiejętności techniczne i doświadczenie w zakresie pisania? Sezon Dokumentów Google nie służy do nauki podstaw technicznych umiejętności pisania. Czy Twoja motywacja jest uporządkowana i zmotywowana?
  • Czy masz czas na udział w programie w ciągu 6 miesięcy? Rozmiary projektów są różne, ale maksymalny czas trwania programu wynosi 5–30 godzin tygodniowo.
  • Czy chcesz zdobyć doświadczenie w pracy w modelu open source? Czy chcesz poświęcić czas na zapoznanie się z procesami projektu i normami społeczności?
  • Czy chcesz współpracować z administratorem organizacji, aby dopracować propozycje projektów, opracować harmonogramy, ocenić i skompilować wskaźniki oraz pomóc organizacji jako całości zrozumieć wartość pisania technicznego?

Musisz też spełnić wymagania programu, m.in. utworzyć konto Open Collective. Musisz legalnie otrzymywać fundusze za pracę wykonywaną w miejscu zamieszkania. Administratorzy Sezonu Dokumentów Google nie mogą udzielać porad podatkowych ani odpowiadać na pytania dotyczące kwalifikacji do pracy.

Jako wykwalifikowany pisarz techniczny uczestniczący w programie Sezon Dokumentów Google możesz zdobywać doświadczenie w pracy na licencji open source i pomagać w realizacji kluczowych potrzeb za pomocą lepszych dokumentów.

Udział w programie Sezon Dokumentów Google jako twórca techniczny

Faza eksploracji

Zgłoszenia organizacji zostaną zamknięte 2 kwietnia 2024 roku o 18:00 czasu UTC. Zalecamy, aby pisarze ds. technicznych zaczęli jak najszybciej zapoznawać się z możliwymi projektami. Organizacje mogą jednak w dowolnym momencie do godziny 18:00 czasu UTC wybrać twórców technicznych, z którymi będą współpracować.

  • Wyszukiwanie interesujących projektów
    • Skontaktuj się bezpośrednio z organizacjami open source, korzystając z instrukcji na ich stronie programu Sezon Dokumentów Google. Możesz też sprawdzić repozytorium Sezonu Google na GitHubie, aby znaleźć organizacje, które wyraziły zainteresowanie udziałem w tym sezonie. Zainteresowane organizacje można znaleźć również na kanale #session-of-docs w sekcji Write the Dokumenty Slack.
    • Oto kilka sposobów na wybór projektu:
      • Wybierz projekt w języku, który znasz lub lubisz, np. JavaScript lub C.
      • Wybierz projekt związany z technologią lub dziedziną, która Cię interesuje, np. z systemami uczącymi się, otwartą nauką czy robotyką.
      • Wybierz projekt, kierując się przyjaznością społeczności. Odwiedź ich fora dyskusyjne, zajrzyj na konta w mediach społecznościowych współtwórców (jeśli tam piszą o swoich projektach) i przejrzyj dokumentację wprowadzenia, jeśli jest dostępna.
      • Jeśli na liście projektów nie ma projektu, nad którym chcesz pracować, skontaktuj się z nim i poproś o rozpatrzenie zgłoszenia.
  • Przejrzyj strony ofert pakietowych projektów
    • Po utworzeniu 3–5 projektów zajrzyj na stronę z propozycjami poszczególnych projektów.
    • Zadawaj pytania, przekazuj opinie i sugestie, korzystając z kanałów wymienionych w projekcie. Możesz je oceniać i dyskutować.
  • Prześlij oświadczenie o zainteresowaniu bezpośrednio do organizacji. W oświadczeniu o zainteresowaniach dowiesz się, jak udałoby Ci się osiągnąć cele wymienione w ofercie projektu organizacji.
    • Skorzystaj z szablonu zainteresowania sezonem Dokumentów Google. Im krócej, tym lepiej.
    • Postępuj zgodnie z instrukcjami przedstawionymi na stronie organizacji, aby przesłać swoje oświadczenie. Jeśli organizacja określiła szczególne wymagania, potwierdź na wyciągu, że spełniasz te wymagania.
    • Przesyłając oświadczenie, zgadzasz się przestrzegać kodeksu postępowania organizacji oraz kodeksu postępowania związanego z sezonem korzystania z Dokumentów Google.

Faza aplikacji

  • Poczekaj na ogłoszenie przyjęć organizacji za pomocą Sezonu Dokumentów Google:
    • Akceptowane organizacje skontaktują się bezpośrednio z Tobą, jeśli będą chciały z Tobą współpracować lub omówić Twoje zgłoszenie zainteresowania.
    • Organizacje nie muszą współpracować tylko z twórcami treści technicznych, którzy przesłali oświadczenie o interesie w terminie przesyłania zgłoszeń. Po zaakceptowaniu warunków mogą oni poprosić o dalsze oświadczenia. Organizacje muszą wybrać autora tekstu do 22 maja 2024 roku do godziny 18:00 czasu UTC.
    • Organizacje nie muszą przesyłać opinii o nieudanym zgłoszeniu zainteresowania.

Etap tworzenia projektu

  • Wspólnie z organizacją stwórz harmonogram, w tym informacje o materiałach i terminach.

Etap oceny końcowej i studium przypadku

  • Nawiąż współpracę z organizacją, aby udostępnić informacje potrzebne do oceny końcowej i studium przypadku.