Najczęstsze pytania

Bieżący etap:
Program Sezon na dokumenty 2021 zakończył się 14 grudnia 2021 r. Zobacz oś czasu.

Ogólne

Czy Google Season of Docs to program rekrutacyjny?

Nie. Jeśli chcesz pracować w Google, odwiedź witrynę Google Jobs.

Jakie zmiany wprowadziliśmy w 2021 r. w ramach Google Season of Docs?

W Google Season of Docs 2021 wprowadzono istotne zmiany w porównaniu z poprzednimi latami, w tym:

  • Specjaliści ds. pisania technicznego nie muszą już przesyłać zgłoszeń do Google w celu dopasowania do organizacji
  • Organizacje przesyłają propozycje projektów w ramach zgłoszenia, w tym budżet i proponowane dane
  • Zakwalifikowane organizacje otrzymują dotacje, które wykorzystują do opłacania autorów tekstów technicznych.
  • Organizacje przesyłają ostateczne oceny i studia przypadków

Dlaczego Google wprowadziło te zmiany w ramach Google Season of Docs?

Naszą misją jest porządkowanie informacji z całego świata oraz udostępnianie ich do ogólnego użytku. Zmieniając profil Google Season of Docs, aby skupić się na nauce skutecznych metod dokumentowania w przypadku oprogramowania open source, mamy nadzieję, że uda nam się osiągnąć większy długoterminowy wpływ.

Nasza organizacja chce wziąć udział w sezonie Dokumentów w 2021 r., ale nie wiemy, od czego zacząć.

Sprawdź naszą pełną listę pomysłów na projekty. Możesz też skontaktować się z komunitą zajmującą się pisaniem tekstów technicznych (spróbuj na kanale #season-of-docs na Slacku Write the Docs lub na swoich kanałach w mediach społecznościowych, aby poprosić o pomoc lub propozycje).

Jakie projekty mogą proponować organizacje?

Oto kilka pomysłów:

  • Utwórz stronę dokumentacji na platformie wybranej przez copywritera technicznego i organizację open source, a następnie opublikuj na niej początkowy zestaw podstawowych dokumentów. Przykłady platform:

  • przerobić istniejącą dokumentację projektu open source, aby zapewnić lepsze wrażenia użytkownika lub bardziej przystępną architekturę informacji;

  • Napisz ogólny opis lub wprowadzenie do produktu lub funkcji. Zespół często tworzy dokumentację techniczną od dołu do góry, co powoduje, że jest ona bardzo szczegółowa, ale trudno z niej zrozumieć produkt jako całość. Tego typu problemy może rozwiązać osoba zajmująca się pisaniem technicznym.

  • Utwórz samouczek dotyczący zastosowania o dużej skali.

  • Utwórz zestaw szczegółowych przewodników dotyczących konkretnych zadań.

  • Utwórz przewodnik dla współtwórców, który zawiera podstawowe informacje o tym, jak zacząć współpracę przy projekcie open source, a także wszelkie zasady dotyczące umów licencyjnych, procesów zgłaszania i sprawdzania pull requestów, tworzenia projektu itp.

Czy film może być projektem w ramach Google Season of Docs?

Tak. Upewnij się, że wymagania dotyczące filmu są dobrze określone, i pamiętaj, że produkcja filmu o wysokiej jakości wymaga znacznych nakładów czasu i zasobów.

Czy audyt dokumentacji to odpowiedni projekt na potrzeby Google Season of Docs?

Weryfikacja dokumentacji to świetny projekt na Google Season of Docs. Zwróć uwagę na ilość dokumentacji, którą już masz. Jeśli jest jej dużo, być może trzeba będzie ograniczyć zakres (np. tylko do weryfikacji treści samouczka). Jeśli masz niewiele dokumentacji lub w ogóle jej nie masz, możesz utworzyć brakujące dokumenty o najwyższym priorytecie w ramach projektu.

Czy istnieją szablony dokumentacji przeznaczone dla organizacji i pisarzy technicznych?

Google Season of Docs ma repozytorium GitHub z szablonem i listą kontrolną do przeprowadzania audytów dokumentacji. Mamy nadzieję, że będziemy mogli dodawać inne szablony w miarę ich tworzenia.

Projekt Good Docs pracuje nad tworzeniem minimalnych, możliwych do wdrożenia szablonów dokumentacji dla projektów open source.

Czy organizacje muszą korzystać z dokumentów przygotowanych przez autorów technicznych?

Nie. Czasami projekty nie wychodzą zgodnie z oczekiwaniami lub wymagania się zmieniają. Nie wymagamy, aby organizacje korzystały z dokumentacji ani innych wytworzonych materiałów, ale oczekujemy, że w ostatecznej ocenie i studium przypadku zostanie omówione, dlaczego nie korzystano z dokumentacji i jak podjęto decyzję o nieużywania dokumentacji ani innych materiałów.

Gdzie odbywa się Google Season of Docs?

Google Season of Docs odbywa się całkowicie online. W ramach programu nie musisz podróżować.

Jak być na bieżąco z informacjami o Google Season of Docs?

Najnowsze informacje i ogłoszenia dotyczące Google Season of Docs znajdziesz na liście mailingowej season-of-docs-announce. Dołącz do grupy, aby otrzymywać powiadomienia e-mail.

Czy mogę dodać do mojego kalendarza oś czasu Google Season of Docs?

Tak, możesz dodać go za pomocą tego linku.

Co mogę zrobić, aby promować Google Season of Docs?

Możesz tweetować o programie, pisać posty na blogu, publikować filmy lub organizować spotkania i spotkania informacyjne w swojej okolicy. Mamy przykładowe treści i zasoby, które możesz rozpowszechniać w swojej społeczności (organizacji, grupie pisarzy i innym kontaktom).

Jak zorganizować lub poprowadzić spotkanie informacyjne lub spotkanie na żywo w ramach Google Season of Docs?

Możesz umówić się na spotkanie w dogodnym dla siebie czasie i miejscu. Zapoznaj się z zasadami programu i użyj przykładowych treści.

Czy możesz udostępnić jakieś statystyki dotyczące sezonów Dokumentów z lat 2019 i 2020?

Tak. Wyniki Google Season of Docs z 2019 roku można sprawdzić tutaj, a z 2020 roku – tutaj.

Czy otrzymam koszulkę z okazji Google Season of Docs?

Nie, ze względu na ograniczenia dotyczące wysyłki międzynarodowej nie będziemy już mogli przesyłać koszulek uczestnikom, którzy ukończyli projekt w ramach Google Season of Docs.

A jeśli mam więcej pytań?

Zapoznaj się z przewodnikiem dla administratora organizacji i przewodnikiem dla copywritera technicznego.

Jeśli po przeczytaniu całej dokumentacji nadal nie znasz odpowiedzi, zadaj pytanie na liście dyskusyjnej społeczności Google Season of Docs. Zapoznaj się z informacjami o kanałach dyskusyjnych i sposobami kontaktowania się z nami.

Jak zostać mentorem w ramach Google Season of Docs?

W edycji 2021 r. Google Season of Docs nie ma oficjalnej roli mentora. Organizacje powinny określić, jak będzie wyglądać proces wdrożenia i wsparcia autorów treści technicznych oraz jak ich wkład w dokumentację będzie sprawdzany i zatwierdzany w ramach zgłoszenia organizacji. Jeśli chcesz zostać mentorem dla autorów dokumentacji technicznej w ramach Google Season of Docs, zachęcamy do współpracy z administratorami organizacji.

Czy Google Season of Docs to coś jak Google Summer of Code?

Nie. Google Season of Docs jest przeznaczony dla osób z nieco większym doświadczeniem w pisaniu tekstów technicznych. Nie jest to program mentoringowy, taki jak Google Summer of Code.

Dla autorów tekstów technicznych

Kiedy autorzy techniczni mogą się zgłosić do udziału w Google Season of Docs?

W 2021 r. w ramach Google Season of Docs nie było oficjalnego programu dla techników piszących. Aby wziąć udział w programie Google Season of Docs 2021 w poziomie pisarza technicznego, skontaktuj się bezpośrednio z organizacjami open source, korzystając z instrukcji na ich stronie programu. Możesz też wyrazić zainteresowanie, dodając się do katalogu autorów technicznych w ramach programu Season of Docs. Więcej informacji znajdziesz w przewodniku dla autorów treści technicznych.

Jakie narzędzia i ramy dokumentacji powinienem znać, aby wziąć udział w Google Season of Docs?

Narzędzia i platformy do tworzenia dokumentacji, których użyjesz, zależą od organizacji, z którą chcesz współpracować. Celem Google Season of Docs jest m.in. pomoc autorom technicznym w zdobywaniu wiedzy o narzędziach i ramach używanych do dokumentowania produktów open source. Dlatego przed rozpoczęciem projektu w ramach Google Season of Docs nie musisz mieć szczegółowej wiedzy na temat konkretnych platform do tworzenia dokumentacji.

Jednak większość organizacji open source używa w dokumentacji jakiejś wersji Markdown lub innego języka znaczników. Najpierw sprawdź, z jakiego języka korzysta wybrana organizacja, i poznaj jego składnię. Dobrym początkiem jest Markdown, ponieważ pliki README na GitHubie używają wersji Markdown. Zapoznaj się z przewodnikiem GitHuba po Markdown.

Sprawdź, czy wybrana organizacja hostuje już dokumentację na stronie internetowej i na jakiej platformie. Platforma może być generatorem stron statycznych, takim jak Jekyll, Sphinx lub Hugo, albo organizacja może hostować dokumenty na Read the Docs lub GitHub Pages. Gdy już ustalisz, z jakiej platformy korzysta organizacja, zapoznaj się z odpowiednim językiem i platformą i przeprowadź eksperymenty. Dzięki temu możesz szybko rozpocząć pracę z projektem open source i udzielić dobrych porad dotyczące projektu open source, który wybierzesz.

Jakich języków programowania powinienem znać, aby wziąć udział w projektach Google Season of Docs?

W zależności od charakteru projektu dokumentacji może być konieczne zapoznanie się z językiem programowania. Pamiętaj o tym, gdy wybierasz i proponujesz projekt dokumentacji, i skonsultuj się z organizacją zajmującą się oprogramowaniem open source w sprawie wymaganego poziomu znajomości.

Czy autorzy techniczni, którzy już pracują nad projektem typu open source, mogą kontynuować pracę nad nim w ramach Google Season of Docs?

Tak, ale organizacja powinna w swojej propozycji uwzględnić informacje o poprzedniej lub bieżącej współpracy copywritera technicznego z danym projektem.

Jakie są wymagania dotyczące udziału?

Czy muszę mieć doświadczenie lub odbyć szkolenie z zakresu pisania dokumentacji technicznej?

Wcześniejsze doświadczenie lub szkolenie z pisma technicznego jest pożądane, ale nie jest konieczne. Przesyłając oświadczenie o zainteresowaniu organizacji, możesz opisać swoje doświadczenie lub szkolenia z zakresu pisania tekstów technicznych. Musisz mieć możliwość przedstawienia dowodów zainteresowania dokumentacją techniczną lub dokumentacją open source, w tym przykładów dokumentacji napisanej przez Ciebie. Organizacja open source będzie szukać autorów technicznych o poziomie doświadczenia, którego potrzebuje, aby zapewnić skuteczne ukończenie projektów w ramach Google Season of Docs.

Czy otrzymam wynagrodzenie za udział w Google Season of Docs?

Tak. Google przyzna organizacjom, które przejdą proces kwalifikacji, dotacje na zatrudnienie copywriterów.

Jak wygląda dobre oświadczenie osoby piszącej treści techniczne?

Najlepsze oświadczenia pochodzą od autorów technicznych, którzy poświęcają czas na kontakt z wybraną organizacją open source i omawianie z nią swoich pomysłów przed przesłaniem oświadczenia. Zapoznaj się z przewodnikiem tworzenia oświadczenia o zainteresowaniu.

Ile czasu zajmuje udział w Google Season of Docs?

Wielkość projektów jest różna, ale w ramach programu wymaga poświęcenia 5–30 godzin tygodniowo. Czas spędzony na rozmowie zależy jednak od charakteru projektu, który został uzgodniony z organizacją. Zanim to zrobisz, powinieneś ocenić projekt i skonsultować szacowany czas z organizacją zajmującą się oprogramowaniem open source.

Czy jako osoba prywatna mogę przesłać prośbę o utworzenie dokumentacji projektu open source? Chcę utworzyć serię postów na blogu, filmów lub innych materiałów na temat korzystania z projektu lub narzędzia open source, ale nie jestem częścią tego projektu ani nie jestem jego współtwórcą.

Nie. Propozycję należy przesłać tylko wtedy, gdy można otrzymać środki w imieniu projektu open source. Zachęcamy do skontaktowania się z projektodawcą i współpracy przy tworzeniu propozycji aplikacji.

Jestem uczniem. Czy mogę wziąć udział w Google Season of Docs 2021? Czy w ramach Google Season of Docs nauczę się pisania technicznego?

Uczniowie mogą współpracować z zaakceptowanymi organizacjami, ale sezon Google Docs nie ma na celu nauczania umiejętności pisania technicznego. Oczekujemy, że biorący udział w programie copywriterzy techniczni będą mieli umiejętności zawodowe w zakresie pisania tekstów technicznych lub równoważne doświadczenie. Uczniowie, którzy chcą wziąć udział w programie, powinni podkreślić swoje umiejętności w zakresie pisania i edytowania, kontaktując się z organizacjami i projektami, które są zainteresowane ich udziałem.

Czy mogę brać udział w Google Season of Docs jako copywriter i w Google Summer of Code jako student?

Chociaż obecnie nie jest to niezgodne z zasadami, zdecydowanie zalecamy, aby studenci przyjęci do programu Google Summer of Code nie zgłaszali się do programu Google Season of Docs na stanowisko technicznego copywritera. Uczniowie powinni skupić się na pracy nad projektem Google Summer of Code, a nie zgłaszać się do Google Season of Docs.

Ponadto Google Season of Docs nie jest przeznaczony dla początkujących, ale dla osób, które mają już solidne umiejętności i doświadczenie w zakresie pisania tekstów technicznych. W ramach Sezonu na dokumenty nie jest udzielane wsparcie mentora. Zamiast tego uczestnicy muszą samodzielnie organizować pracę i być zmotywowani do opracowania planu realizacji projektu organizacji z minimalnym wsparciem ze strony administratorów organizacji i innych członków społeczności.

Jak jako autor tekstów technicznych mogę skontaktować się z administratorami programu Google Season of Docs, jeśli mam dodatkowe pytania lub wątpliwości?

Aby skontaktować się z administratorami programu Google Season of Docs, wyślij e-maila na adres season-of-docs@google.com.

Czy firma zajmująca się pisaniem tekstów technicznych lub firma konsultingowa może wziąć udział w programie Sezon na dokumenty?

Tak. Organizacja może zatrudnić firmę, która wykona zadania określone w jej propozycji.

Jak nawiązać w CV do sezonu Dokumentów?

Wymień je tak, jak każdą inną pracę na zlecenie, np. „Pracowałem/am jako copywriter techniczny w ramach projektu [nazwa projektu] w ramach programu Sezon Dokumentów”.

Czy wydajesz certyfikaty ukończenia za udział w sezonie Docs?

Nie możemy wysyłać certyfikatów ani potwierdzeń udziału w projekcie do autorów technicznych.

Informacje dla administratorów organizacji open source

Jakie są wymagania dotyczące organizacji open source?

Aby kwalifikować się do udziału jako organizacja, musisz być grupą prowadzącą aktywny projekt oprogramowania typu free/open source, taki jak BRL-CAD. Projekt nie musi być prawnie zarejestrowanym podmiotem. Aby móc wziąć udział w programie, organizacja musi już wyprodukować i opublikować oprogramowanie na podstawie zatwierdzonej licencji Open Source Initiative oraz mieć co najmniej 2 współtwórców, którzy będą pełnić rolę administratorów organizacji przez cały okres trwania programu Google Season of Docs.

Zapoznaj się też z wymaganiami kwalifikacji opisanymi w zasadach programu oraz programach sankcji i informacjach o krajach opublikowanych przez Departament Skarbu Stanów Zjednoczonych.

Czy „organizacja” jest równoznaczna z projektem typu open source?

Organizacja może mieć co najmniej 1 projekt typu open source. Niektóre organizacje, takie jak fundacje, mogą mieć wiele organizacji podrzędnych, z których każda ma co najmniej jeden projekt open source. Jeśli Twoja organizacja ma niezależne organizacje podrzędne, prześlij osobne zgłoszenia i propozycje dla każdej z nich.

Czy organizacja może przesłać więcej niż 1 propozycję?

Nie. Prześlij tylko jedną prośbę dla każdej organizacji. Jeśli Twoja organizacja ma organizacje podrzędne (np. jest fundacją z wieloma poszczególnymi projektami open source), każdy projekt powinien przesłać własny wniosek, nawet jeśli środki z grantu byłyby zarządzane przez organizację nadrzędną.

Czy grupa projektów open source może wspólnie przesłać propozycję dotyczącą pracy nad jednym projektem dokumentacji?

Propozycję powinna przesłać jedna organizacja, która będzie odpowiedzialna za koordynację pracy i współpracę z innymi projektami biorącymi udział w programie. (np. grupa małych projektów open source, które są wtyczkami do większego projektu, a ich autorzy chcą pracować nad wspólnym przewodnikiem dotyczącym tworzenia wtyczek. W takim przypadku należy wybrać jedną organizację, która będzie koordynować projekt).

W jaki sposób moja organizacja otrzyma środki?

Aby otrzymywać środki, Twoja organizacja musi mieć konto Open Collective.

Czy organizacje otrzymują jakieś pieniądze za udział w Google Season of Docs?

Organizacje mogą uwzględniać środki na administrację, mentorowanie lub sprawdzanie prac w ramach budżetu projektu.

Jak moja organizacja powinna zaplanować koszty zatrudnienia osoby zajmującej się pisaniem technicznym?

Zapoznaj się z ankietą dotyczącą wynagrodzeń w Write the Docs i oblicz stawki godzinowe. Możesz też dołączyć do Slacka Write The Docs i poprosić na kanale #season-of-docs o przesłanie ofert przez zainteresowanych copywriterów technicznych.

Czy moja organizacja może wykorzystać grant Google Season of Docs do opłacenia obecnego współtwórcy?

Tak. Propozycje projektów muszą jednak dotyczyć nowych prac (w tym prac konserwacyjnych, poprawek lub uaktualnień istniejącej dokumentacji). Nie możesz ubiegać się o grant, aby pokryć koszty już wykonanej pracy.

Czy moja organizacja może współpracować z studentami zajmującymi się pisaniem technicznym?

Możesz poprosić o pomoc studentów specjalizujących się w pisaniu technicznym. Jeśli zdecydujesz się pracować ze studentami, zalecamy, aby wzięli w tym udział tylko uczniowie, którzy:

  • mieć ukończone 18 lat.
  • są studentami programu lub kursu dotyczącego pisania technicznego lub komunikacji technicznej;
  • mieć możliwość korzystania z mentorowania w zakresie pisania technicznego w ramach programu lub kursu;

Czy moja organizacja może współpracować z większą liczbą autorów tekstów technicznych?

Twoja organizacja może wybrać i zapłacić więcej niż jednemu autorowi treści technicznych, ale wszyscy autorzy pracujący z nią muszą zajmować się projektem, który został przez Ciebie zaproponowany. Praca z wieloma osobami zajmującymi się pisaniem technicznym spowoduje, że Twój projekt będzie bardziej skomplikowany, a także będzie wymagać więcej czasu wolontariuszy i administracji.

Czy moja organizacja może zatrudnić firmę zajmującą się pisaniem technicznym do pracy nad naszym projektem?

Tak, Twoja organizacja może zatrudnić firmę zajmującą się pisaniem tekstów technicznych, aby pracowała nad Twoim projektem. Pamiętaj, aby sprawdzić, czy firma, którą zatrudniasz, może otrzymywać płatności za pośrednictwem Open Collective.

Nasz autor tekstów technicznych zrezygnował przed zakończeniem programu. Czy nadal kwalifikujemy się do otrzymania pozostałych środków?

Zdecydowanie zalecamy znalezienie nowego technicznego autora, który ukończy projekt przed zakończeniem programu. Jednak wypłata pozostałych środków nie zależy od zakończenia projektu, tylko od zakończenia analizy przypadku i ostatecznej oceny.

Jeśli nie udało Ci się ukończyć projektu, oczekujemy, że w przypadku analizy przypadku wyjaśnisz, dlaczego tak się stało. Może się na przykład okazać, że narzędzia do dokumentacji są bardzo skomplikowane i stanowią barierę dla autora technicznego lub że projekt wymagał testowania i aktualizowania samouczków oraz dużego doświadczenia w programowaniu. Co według Ciebie warto polecić innym projektom? Uwzględnij te informacje w studium przypadku.

Czy wniosek organizacji może zostać sprawdzony przed terminem przesyłania?

Nie możemy jednak udzielić Ci informacji na temat aplikacji organizacji.

Jak organizacje powinny określać zakres swoich propozycji projektów?

Podczas opracowywania pomysłów na projekty staraj się znaleźć te najmniejsze, które przyniosą organizacji korzyści (ale mogą być rozszerzone, jeśli czas na to pozwoli). Im mniejsze, tym lepiej. Podczas tworzenia propozycji projektu zalecamy skupienie się na mniejszych, bardziej szczegółowych projektach niż na większych projektach o mniej szczegółowych założeniach. Jeśli Twój projekt wymaga dużej wiedzy w danej dziedzinie, spróbuj uwzględnić projekty, nad którymi można pracować bez takiej wiedzy.

Czy mogę wziąć udział w Google Season of Docs jako administrator organizacji i w Google Summer of Code jako mentor?

Tak. Google Season of Docs i Google Summer of Code to osobne programy. Jeśli masz odpowiednią przepustowość, możesz brać udział w obu programach.

Nasza organizacja brała udział w poprzednich edycjach programu Google Season of Docs. Czy możemy ponownie przesłać zgłoszenie?

Tak. Organizacje, które uczestniczyły w poprzednich edycjach programu Google Season of Docs, mogą ponownie się zgłosić.

Zarchiwizowane dane

Jak usunąć swoje informacje z archiwum Google Season of Docs?

Skontaktuj się z nami, aby usunąć swoje dane.