Najczęstsze pytania

Obecna faza:
finalizacja projektu. Zobacz oś czasu.

Ogólne

Czy Google Season of Docs to program rekrutacyjny?

Nie. Jeśli chcesz pracować w Google, odwiedź witrynę z ofertami pracy w Google.

Nasza organizacja chce wziąć udział w Google Season of Docs, 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 w 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 witrynę z dokumentacją na platformie wybranej przez technicznego copywritera i organizację open source. Opublikuj w 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ść. Ten problem 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. Pamiętaj o tym, ile dokumentacji 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 nie masz jej w cale, możesz uwzględnić w projekcie utworzenie brakującej dokumentacji o najwyższym priorytecie.

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. Inne szablony będą dodawane po utworzeniu.

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żywaniu 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ć e-maile z aktualizacjami.

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

Aby zasubskrybować kalendarz Google Season of Docs, przejdź na stronę http://goo.gle/2NeZVew.

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śród społeczności (organizacji, grupy pisarzy i innych kontaktów).

Jak zorganizować lub poprowadzić spotkanie informacyjne lub spotkanie na temat 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 programów z lat 2019 i 2020?

Tak. Wyniki Google Season of Docs z 2019 r. można sprawdzić na blogu Google Open Source (2019, 2020).

Czy otrzymam koszulkę z okazji Google Season of Docs?

Nie. Ze względu na ograniczenia dotyczące wysyłki międzynarodowej nie możemy już dostarczać 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 autora treści technicznych.

Jeśli po przeczytaniu całej dokumentacji nadal nie masz odpowiedzi, rozważ omówienie swoich pytań z osobami z grupy Google Season of Docs na liście dyskusyjnej. Zapoznaj się z informacjami o kanałach dyskusyjnych oraz o tym, jak skontaktować się z nami.

Jak zostać mentorem w ramach Google Season of Docs?

W Google Season of Docs nie ma formalnej roli mentora. Organizacje powinny określić, jak będzie wyglądać proces wdrażania i wspierania autorów 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 tekstów technicznych w ramach Google Season of Docs, skontaktuj się z administratorami organizacji, aby zaoferować swoją pomoc.

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

Nie. Google Season of Docs jest przeznaczony dla osób, które mają pewne doświadczenie w pisaniu tekstów technicznych. Nie jest to program mentoringowy, taki jak Google Summer of Code.

Dla autorów tekstów technicznych

Kiedy autorzy tekstów technicznych mogą się zgłaszać do udziału w Google Season of Docs?

Google Season of Docs nie ma formalnej aplikacji dla pisarzy technicznych. Aby wziąć udział w Google Season of Docs jako copywriter, skontaktuj się bezpośrednio z organizacjami open source, korzystając z instrukcji na stronie programu Google Season of Docs. Możesz też wyrazić zainteresowanie, dodając się do Katalogu Google Season of Docs Technical Writer. Więcej informacji znajdziesz w przewodniku dla copywriterów 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.

Dowiedz się, czy wybrana organizacja hostuje już swoją dokumentację na stronie internetowej i na jakiej platformie. Platforma może być generatorem witryn statycznych, takim jak Jekyll, Sphinx lub Hugo, albo organizacja może hostować dokumenty w Read the Docs lub GitHub Pages. Gdy już ustalisz, jakiej platformy używa organizacja, zapoznaj się z odpowiednim językiem i platformą oraz przetestuj je. Dzięki temu możesz szybko rozpocząć pracę z projektem open source i udzielić dobrych porad dotyczących wybranego projektu open source.

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 zaznajomienie 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 w zakresie pisania dokumentacji technicznej?

Doświadczenie lub szkolenie z zakresu pisania 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 pisania tekstów technicznych. Musisz przedstawić dowody zainteresowania dokumentacją techniczną lub dokumentacją typu open source, w tym przykłady 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 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 jego realizacji 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. Jeśli chcesz wziąć udział w projekcie, skontaktuj się z jego zespołem i wspólnie opracuj propozycję aplikacji.

Czy jako uczeń mogę wziąć udział w Google Season of Docs? Czy w Google Season of Docs nauczę się pisania technicznego?

Uczniowie mogą współpracować z zaakceptowanymi organizacjami, ale Google Season of Docs nie ma na celu nauczania umiejętności pisania technicznego. Uczestniczący w programie copywriterzy specjalizujący się w tekstach technicznych powinni mieć umiejętności zawodowe w tej dziedzinie lub równoważne doświadczenie. Uczniowie, którzy chcą wziąć udział w programie, powinni w swojej zgłoszeniu podkreślić swoje umiejętności w zakresie pisania i edytowania.

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

Nie zalecamy, aby nowi autorzy lub studenci przyjęci do programu Google Summer of Code zgłaszali się do udziału w Google Season of Docs w roli pisarza technicznego.

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 pisaniu tekstów technicznych. W ramach Google Season of Docs uczestnicy nie otrzymują mentoringu, ale muszą samodzielnie organizować pracę i być zmotywowani do opracowania planu realizacji projektu organizacji z minimalnym wsparciem 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 Google Season of Docs?

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

Jak w CV odnieść się do Google Season of Docs?

Wymień to tak, jak każdą inną pracę na zlecenie: „Pracowałem/am jako copywriter techniczny w ramach programu Google Season of Docs w [nazwa projektu]”.

Czy wystawiasz certyfikaty ukończenia za udział w Google Season of Docs?

Organizatorzy Google Season of Docs nie mogą 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 freeware lub open source, np. BRL-CAD. Projekt nie musi być prawnie zarejestrowaną organizacją. 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 opisanymi w zasadach programu oraz w informacjach o programach sankcyjnych i 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 1 formularz zgłoszeniowy na organizację. Jeśli Twoja organizacja ma organizacje podrzędne (np. jest fundacją z wieloma indywidualnymi 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?

Jedna organizacja powinna przesłać zgłoszenie i być odpowiedzialna za koordynację pracy oraz wsparcie ze strony innych projektów biorących udział w programie. (np. grupa małych projektów open source, które są wtyczkami do większego projektu, a ich autorzy chcą wspólnie opracować przewodnik dotyczący tworzenia wtyczek. W tym celu 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 OpenCollective.

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.

Czy Google pokrywa opłaty za przetwarzanie płatności?

Opłaty za przetwarzanie płatności nie są pokrywane przez Google, ponieważ są one różne w zależności od formy płatności. Google pokrywa jednak opłatę za platformę Open Collective, a jeśli zdecydujesz się użyć Open Collective jako hosta fiskalnego, ta opłata również zostanie pokryta. Więcej informacji znajdziesz w przewodniku na temat otrzymywania dotacji.

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

Zalecamy zapoznanie się z ankietą dotyczącą wynagrodzenia dla twórców treści w Dokumentach Google i obliczeniem stawek godzinowych. Możesz też dołączyć do Write The Docs Slack i poprosić o oferty na kanale #season-of-docs.

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 dofinansowanie na pokrycie kosztów zadań, które zostały już wykonane.

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

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

  • mieć ukończone 18 lat.
  • są zarejestrowane w programie lub kursie z zakresu tekstów technicznych lub komunikacji technicznej;
  • mieć możliwość korzystania z mentora 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. Współpraca z wieloma osobami zajmującymi się pisaniem tekstów technicznych spowoduje, że 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. Upewnij się, że 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 nasza organizacja nadal kwalifikuje się do otrzymania pozostałych środków?

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

Jeśli nie udało się ukończyć projektu, w przypadku powinny zostać wyjaśnione powody niepowodzenia. Może się na przykład okazać, że narzędzia do tworzenia dokumentacji są bardzo skomplikowane i stanowią barierę dla osoby piszącej dokumentację techniczną, lub że projekt wymagał przetestowania i aktualizowania samouczków oraz dużego doświadczenia w programowaniu. Co polecasz innym projektom na podstawie swojego doświadczenia? Uwzględnij te informacje w studium przypadku.

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

Organizacja nie może przesłać opinii na temat aplikacji Google Season of Docs.

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 dołączyć projekty, nad którymi może pracować osoba bez takiego doświadczenia.

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 nasza organizacja może ponownie się zgłosić?

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 informacje.