Przewodnik dla pisarzy technicznych

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

Ten przewodnik jest przeznaczony dla twórców treści technicznych zainteresowanych współpracą z zaakceptowanymi organizacjami w ramach programu Seasonal of Docs.

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

Użyj tych pytań, aby zrozumieć, czy chcesz rozpocząć współpracę z zaakceptowaną organizacją w ramach programu Seasonal of Docs.

  • Czy masz umiejętności i doświadczenie techniczne w zakresie pisania? Sezon Dokumentów nie służy do nauki podstawowych umiejętności technicznych pisania. Czy masz motywację i jesteś osobą dobrze zorganizowaną?
  • Czy w ciągu 6 miesięcy trwania programu możesz wziąć udział w tym programie? 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 poznanie procesów związanych z projektem i norm społeczności?
  • Czy chcesz współpracować z administratorem organizacji, aby dopracowywać propozycje projektów, opracowywać harmonogramy, oceniać i kompilować wskaźniki, a także pomóc organizacji jako całości zrozumieć wartość pisania technicznego?

Musisz też spełniać wymagania programu, m.in. mieć możliwość utworzenia konta Open Collective. Pamiętaj, że musisz mieć prawo do otrzymywania środków za pracę wykonywaną w swoim miejscu zamieszkania. Administratorzy programu Sezon Dokumenty nie mogą udzielać porad podatkowych ani odpowiadać na pytania dotyczące kwalifikacji do pracy.

Jako utalentowany autor tekstów technicznych, który bierze udział w tym sezonie, otrzymasz wynagrodzenie za możliwość zdobywania doświadczenia w pracy w modelu open source i wspierania projektu w realizacji kluczowych potrzeb za pomocą lepszych dokumentów.

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

Faza eksploracji

Zgłoszenia organizacji są zamykane 25 marca 2022 roku o godz. 18:00 czasu UTC. Zalecamy, aby pisarze zajmujący się kwestiami technicznymi zaczęli analizować możliwe projekty jak najwcześniej. Organizacje mogą jednak wybrać autorów tekstu do współpracy w dowolnym momencie przed 16 maja 2022 r., godz. 18:00 czasu UTC.

  • Znajdź projekty, które Cię interesują
    • Skontaktuj się bezpośrednio z organizacjami open source, korzystając z instrukcji na stronie programu Sezon Dokumentów, lub sprawdź repozytorium Sezonu dokumentów na GitHubie, aby znaleźć organizacje, które wyraziły zainteresowanie udziałem w sezonie Dokumentów. Zainteresowane organizacje możesz znaleźć na kanale #dress-of-docs na kanale Write the Docs Slack.
    • Kilka sposobów na wybór projektu:
      • Wybierz projekt w języku, który znasz lub interesuje Cię, np. JavaScript lub C.
      • Wybierz projekt związany z technologią lub domeną, która Cię interesuje, np. związanych z systemami uczącymi się, otwartą nauką lub robotyką.
      • Wybierz projekt, kierując się przyjazną atmosferą społeczności. Spędzaj czas na forach dyskusyjnych, sprawdzaj konta współtwórców w mediach społecznościowych (jeśli rozmawiają tam o swoim projekcie) i zapoznaj się z ich dokumentacją.
      • Jeśli chcesz pracować nad projektem, którego nie ma na liście, skontaktuj się z nim i poproś o rozpatrzenie zgłoszenia.
  • Przejrzyj strony propozycji w projekcie
    • Gdy będziesz mieć od 3 do 5 projektów, zajrzyj na stronę z propozycjami każdego z nich.
    • Zadawaj pytania, przekazuj opinie i sugestie, korzystając z kanałów wymienionych w projekcie, aby przesyłać swoje opinie i dyskusje.
  • Prześlij odpowiednie oświadczenie bezpośrednio do organizacji. W swoim oświadczeniu chcesz wskazać, jak udałoby Ci się osiągnąć cele wymienione w ofercie projektu organizacji.
    • Skorzystaj z szablonu zgłoszenia zainteresowania dotyczącego sezonu Dokumentów. Im krócej, tym lepiej.
    • Aby przesłać oświadczenie o zainteresowaniu, skorzystaj z instrukcji na stronie z pomysłami danej organizacji. Jeśli organizacja określiła specjalne wymagania, musisz udowodnić, że spełniasz te wymagania na wyciągu.
    • Przesyłając swoje oświadczenie, zgadzasz się przestrzegać kodeksu postępowania organizacji oraz kodeksu postępowania związanego z sezonem korzystania z Dokumentów.

Etap aplikacji

  • Poczekaj na ogłoszenie listy organizacji zaakceptowanych w sezonie dokumentów:
    • Organizacje, które zostały przyjęte, skontaktują się bezpośrednio z Tobą, jeśli będą chciały z Tobą współpracować lub dokładniej omówić Twoje zgłoszenie.
    • Organizacje nie ograniczają się do współpracy z twórcami treści technicznych, którzy złożą odpowiednie oświadczenie w terminie zgłoszeń organizacji. Może on wymagać dalszego oświadczeń o interesie po zaakceptowaniu warunków. Organizacje muszą wybrać autora tekstu do 16 maja 2022 r. do godziny 18:00 czasu UTC.
    • Organizacje nie muszą przekazywać opinii o nieudanymi deklaracjami zainteresowania.

Etap rozwoju projektu

  • Wspólnie z organizacją stwórz harmonogram, w tym zadania i terminy.

Etap oceny końcowej i studium przypadku

  • Współpracuj z organizacją, aby dostarczyć informacje potrzebne do oceny końcowej i studium przypadku.