Najczęstsze pytania

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

Ogólne

Czy sezon Dokumentów Google to program rekrutacji?

Nie. Jeśli chcesz pracować dla Google, odwiedź stronę ofert pracy Google.

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

Zobacz pełną listę pomysłów na projekty. Możesz też skontaktować się z zespołem pomocy ds. technicznych (spróbuj

kanału sezonów dokumentów

Napisz w pliku Slack w Dokumentach lub w mediach społecznościowych, aby poprosić o pomoc lub propozycje).

Jakie typy projektów mogą zaproponować organizacje?

Oto kilka pomysłów:

  • Zbuduj witrynę z dokumentacją na platformie, na którą zdecyduje się autor techniczny i organizacja open source, a następnie opublikuj wstępny zestaw podstawowych dokumentów w witrynie. Przykłady platform:

  • refaktoryzować istniejącą dokumentację projektu open source, aby polepszyć wrażenia użytkowników lub uzyskać bardziej przystępną architekturę informacji;

  • Napisz ogólne omówienie produktu lub funkcji albo wprowadzenie do niego. Zespół często opracowuje dokumentację techniczną od podstaw. W efekcie otrzymuje się wiele szczegółów, ale trudno jest zrozumieć usługę jako całość. Rozwiązanie problemu może rozwiązać specjalista techniczny.

  • Utwórz samouczek dotyczący ogólnego przypadku użycia.

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

  • Utwórz przewodnik dla współtwórców, który zawiera podstawowe informacje o tym, jak zacząć pracę nad projektem open source, a także wszelkie reguły dotyczące umów licencyjnych, procesów związanych z wnioskami „push” i weryfikacji, tworzenie projektu itd.

Czy film może być projektem Sezonu Dokumentów Google?

Tak. Zadbaj o sprecyzowanie wymagań dotyczących filmów i pamiętaj, że produkcja wysokiej jakości filmów wymaga dużo czasu i zasobów.

Czy audyt dokumentacji jest rozsądnym projektem dla Sezonu Dokumentów Google?

Audyt dokumentacji to świetny projekt na sezon dokumentów Google. Zwracaj uwagę na ilość już dokumentacji. Jeśli jest jej dużo, być może trzeba będzie ograniczyć jej zakres (np. sprawdzić tylko treść samouczka). Jeśli masz mało dokumentacji lub nie masz jej wcale, możesz w ramach projektu dołączyć brakującą dokumentację o najwyższym priorytecie.

Czy są dostępne szablony dokumentacji dla organizacji i twórców technicznych?

Sezon Dokumentów Google zawiera repozytorium GitHub z szablonem i listą kontrolną do przeprowadzania audytów dokumentacji. Inne szablony będą dodawane w miarę ich tworzenia.

W ramach projektu Good Dokumenty Project pracujemy nad utworzeniem jakichkolwiek gotowych szablonów dokumentacji dla oprogramowania open source.

Czy organizacje są zobowiązane do korzystania z dokumentów przygotowanych przez twórców technicznych?

Nie. Czasami projekty nie wyświetlają się zgodnie z oczekiwaniami lub zmieniają się wymagania. Nie wymagamy od organizacji korzystania z dokumentacji ani innych wytworzonych materiałów, ale oczekujemy, że ostateczna ocena i studium przypadku będą obejmować omówienie powodów, dla których dokument nie został wykorzystany, oraz wyjaśnienie, w jaki sposób projekt podjął decyzję o niewykorzystywaniu dokumentacji lub innych materiałów.

Gdzie występuje Sezon Dokumentów Google?

Sezon Dokumentów Google odbywa się całkowicie online. Nie trzeba podróżować w ramach programu.

Jak otrzymywać aktualne informacje o sezonie Dokumentów Google?

Najnowsze informacje i ogłoszenia związane z sezonem Dokumentów Google znajdziesz na liście adresowej na stronie season-of-docs-announce. Dołącz do grupy, aby otrzymywać e-maile z aktualnościami.

Czy mogę dodać oś czasu sezonu Dokumentów Google do mojego kalendarza?

Wejdź na http://goo.gle/2NeZVew, aby zasubskrybować kalendarz Sezon Dokumentów Google.

Co mogę zrobić, aby rozpowszechnić sezon Dokumentów Google?

Możesz tam zamieszczać tweety o programie, pisać posty na blogu, publikować filmy oraz organizować spotkania lub sesje informacyjne w swojej okolicy. Udostępniamy przykładowe treści i zasoby, które możesz wykorzystać w swojej społeczności (na przykład w organizacji, grupie autorów i innych osobach kontaktowych).

Jak zorganizować lub zorganizować sesję informacyjną lub spotkanie dotyczące Sezonu Dokumentów Google?

Spotkanie można zaplanować w dowolnym czasie i miejscu. Zapoznaj się z regułami programu i skorzystaj z przykładowych treści.

Czy masz jakieś statystyki dotyczące programów na lata 2019 i 2020?

Tak, wyniki naszego programu Sezon Dokumentów Google 2019 można przejrzeć na blogu Googlel Open Source (2019, 2020).

Czy otrzymam koszulkę z serią Dokumentów Google?

Nie. Ze względu na ograniczenia w zakresie dostawy na całym świecie nie możemy już oferować koszulek użytkownikom, którzy ukończą projekt Sezonu Dokumentów Google w Google.

A jeśli mam więcej pytań?

Zapoznaj się z przewodnikiem dla administratorów organizacji i przewodnikiem technicznym dla programistów.

Jeśli po zapoznaniu się z całą dokumentacją nadal nie znajdujesz odpowiedzi, rozważ omówienie swoich pytań ze społecznością użytkowników Sezonów Google na liście dyskusji. Zapoznaj się z informacjami o kanałach dyskusji i o tym, jak się z nami skontaktować.

Jak mogę zostać mentorem/mentorką sezonu Dokumentów Google?

Sezon Dokumentów Google nie ma formalnej roli mentora. Organizacje powinny określić, w jaki sposób będą oni wprowadzani i wspierani oraz w jaki sposób ich wkład w dokumentację będzie sprawdzany i zatwierdzany w zgłoszeniu organizacji. Jeśli w ramach sezonu Dokumentów Google chcesz zostać mentorem/mentorką dla pisarzy technicznych, skontaktuj się z administratorami swojej organizacji.

Czy sezon Dokumentów Google to coś jak Google Summer of Code?

Nie. Sezon Dokumentów Google jest przeznaczony dla osób z zaburzeniami technicznymi pisania. Nie jest to program mentorski, jak Google Summer of Code.

Dla pisarzy technicznych

Kiedy pisarze techniczni mogą zgłosić się do udziału w sezonie Dokumentów Google?

Sezon Dokumentów Google nie jest dostępny dla formalnych zgłoszeń pisarzy technicznych. Aby wziąć udział w programie Sezon Dokumentów Google jako twórca techniczny, skontaktuj się bezpośrednio z organizacjami open source, postępując zgodnie z instrukcjami na ich stronie programu. Aby wyrazić swoje zainteresowanie, możesz też dodać się do katalogu twórców i specjalistów ds. technicznych w sezonie Dokumentów Google. Więcej informacji znajdziesz w przewodniku technicznym dla programistów.

Jakie narzędzia i platformy do dokumentacji muszę znać, aby móc uczestniczyć w sezonie Dokumentów Google?

Dostępne narzędzia i platformy do dokumentacji zależą od organizacji, z którą chcesz współpracować. Częścią programu Sezonu Dokumentów Google jest projekt typu open source, którego celem jest ułatwienie pisarzom technicznym zdobycie dodatkowych informacji o narzędziach i platformach używanych w dokumentowaniu usług open source. Dlatego zwykle nie jest wymagane uzyskanie szczegółowej wiedzy o konkretnych platformach dokumentacyjnych przed rozpoczęciem tworzenia projektu w ramach sezonu Dokumentów Google.

Większość organizacji typu open source w swojej dokumentacji używa języka Markdown lub innego języka znaczników. Dowiedz się, jakiego języka używa wybrana organizacja, i zapoznaj się ze składnią. Warto zacząć od formatu Markdown, ponieważ pliki README na GitHubie korzystają z formatu Markdown. Przeczytaj przewodnik po GitHubie dotyczący znaczników.

Dowiedz się, czy wybrana organizacja przechowuje już dokumentację w witrynie, a jeśli tak, to na jakiej platformie. Platformą może być statyczny generator witryn, taki jak Jekyll, Sphinx czy Hugo, albo organizacja może hostować swoje dokumenty w sekcji Read the Docs lub GitHub Pages. Gdy dowiesz się, z jakiej platformy korzysta organizacja, sprawdź i poeksperymentuj z odpowiednim językiem i strukturą. Pomaga to szybko rozpocząć pracę nad projektem open source i być dobrym miejscem, w którym można udzielić rzetelnych porad na temat wybranego projektu open source.

Jakie języki programowania muszę znać, aby uczestniczyć w projektach związanych z sezonem Dokumentów Google?

W zależności od charakteru projektu z dokumentacją konieczne może być znajomość języka programowania. Warto o tym pamiętać przy wyborze i proponowaniu projektu z dokumentacją. Konsultacje z organizacją open source

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

Tak, ale w swojej propozycji organizacja powinna pamiętać o wcześniejszych lub bieżących relacjach autora tekstu z projektem.

Jakie wymagania należy spełnić, aby wziąć udział w programie?

Czy potrzebuję wcześniejszego doświadczenia lub szkolenia jako pisarz techniczny?

Zaleca się wcześniejsze doświadczenie w pisaniu tekstów technicznych lub doświadczenie w pisaniu prac. Nie jest ono jednak niezbędne. Przesyłając oświadczenie o zainteresowaniu daną organizacją, możesz opisać swoje doświadczenie lub informacje o przebytych szkoleniach technicznych. Musisz być w stanie przedstawić dowody potwierdzające Twoje zainteresowanie dokumentacją techniczną lub dokumentacją open source, w tym przykłady napisanej dokumentacji. Organizacja open source będzie szukać autorów rozwiązań technicznych dysponujących doświadczeniem wymaganym przez organizację, aby zapewnić pomyślne zakończenie projektów dotyczących sezonu Dokumentów Google.

Czy otrzymam zapłatę za udział w sezonie Dokumentów Google?

Tak. Google przekaże zaakceptowanym organizacjom granty w celu zatrudnienia pisarzy technicznych.

Jak wygląda odpowiednie oświadczenie o zainteresowaniu pisarza technicznego?

Najlepsze twierdzenia, które interesują Cię najbardziej, pochodzą od autorów technicznych, którzy poświęcają czas na interakcję z wybraną organizacją open source i przedyskutowanie ich z wybraną organizacją open source przed przesłaniem swoich oświadczeń. Zapoznaj się z przewodnikiem tworzenia strony, która Cię interesuje.

Ile czasu zajmuje uczestnictwo w sezonie Dokumentów Google?

Rozmiary projektów są różne, ale maksymalny czas trwania programu wynosi 5–30 godzin tygodniowo. Jednak ilość czasu, jaką musisz poświęcić na projekt, zależy od charakteru projektu uzgodnionego z Twoją organizacją. Przed zobowiązaniem należy ocenić projekt i omówić szacowany czas z organizacją zajmującą się oprogramowaniem open source.

Czy mogę przesłać zgłoszenie organizacji dotyczące utworzenia dokumentacji projektu open source jako osoba fizyczna? Chcę tworzyć serię postów na blogu, filmów lub innych materiałów na temat korzystania z projektu lub narzędzia open source, ale nie jestem jego uczestnikiem ani współtwórcą.

Nie. Oferta jest dostępna tylko w przypadku, gdy jesteś w stanie otrzymać środki w imieniu projektu open source. Jeśli chcesz wziąć udział w projekcie, skontaktuj się z nim i opracuj propozycję zgłoszenia.

Jestem uczniem. Czy mogę wziąć udział w sezonie korzystania z Dokumentów Google? Czy Sezon Dokumentów Google nauczy mnie pisania tekstów technicznych?

Uczniowie mogą pracować z zaakceptowanymi organizacjami, ale Sezon Dokumentów Google nie służy do nauki umiejętności technicznych w zakresie pisania. Twórcy biorący udział w programie muszą mieć odpowiednie umiejętności techniczne lub odpowiednie doświadczenie. Uczniowie, którzy chcą wziąć udział w tym badaniu, powinni zwrócić uwagę na swoje kompetencje w zakresie pisania i edytowania tekstu.

Czy mogę wziąć udział zarówno jako pisarz techniczny w sezonie Dokumentów Google, jak i w Google Summer of Code?

Nowi współtwórcy i studenci zaakceptowani do udziału w Google Summer of Code, nie powinni zgłaszać się do tego programu.

Sezon Dokumentów Google nie jest przeznaczony dla początkujących. Jest przeznaczony dla osób, które mają już dobre umiejętności techniczne i mają doświadczenie w pisaniu. Autorzy wiadomości o technikach technicznych w sezonie Dokumentów Google nie mają dostępu do pomocy mentora. Muszą być samodzielne i zmotywowane do opracowania planu rozwiązania projektu w organizacji przy minimalnym wsparciu administratorów organizacji i innych członków społeczności.

W jaki sposób mogę skontaktować się z administratorami programu Google Season of Dokumentów, jeśli mam dodatkowe pytania lub wątpliwości?

Aby skontaktować się z administratorami programu Google Sezon Dokumentów Google, wyślij do nich e-maila na adres year-of-docs@google.com.

Czy firmy zajmujące się pisaniem dokumentów technicznych lub firmy świadczące usługi doradcze mogą wziąć udział w sezonie Dokumentów Google?

Tak. Organizacja może zatrudnić firmę, która wykona pracę określoną w jej ofercie.

Jak wskazać w CV sezon Dokumentów Google?

Wypisz to tak jak w przypadku każdej innej pracy freelancera: „Pracuję jako autor techniczny w projekcie [nazwa projektu] w ramach programu „Sezon of Dokumenty Google”.

Czy przekazujesz certyfikaty ukończenia kursów sezonowych Dokumentów Google?

Sezon Dokumentów Google nie ma możliwości wysyłania certyfikatów ani potwierdzeń udziału w projekcie autorom tekstów technicznych.

Dla administratorów organizacji open source

Jakie wymagania musi spełniać organizacja open source?

Aby wziąć udział w programie, musisz należeć do grupy prowadzącej aktywny projekt bezpłatny lub typu open source, np. BRL-CAD. Projekt nie może być podmiotem o prawie osobowości prawnej. Aby wziąć udział w programie, organizacja musi już wyprodukować i opublikować oprogramowanie na licencji Open Source Initiative oraz mieć co najmniej 2 uczestników, którzy będą pełnić rolę administratorów przez cały czas trwania programu Sezon Dokumentów Google.

Zapoznaj się również z wymaganiami opisanymi w zasadach programu oraz w programach sankcji i informacjach o kraju Departamentu Skarbu Stanów Zjednoczonych.

Czy słowo „organizacja” jest równoważne z projektem open source?

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

Czy organizacja może przesłać więcej niż 1 zgłoszenie pakietu?

Nie. Każda organizacja może przesłać tylko jedno zgłoszenie. Jeśli Twoja organizacja ma organizacje podrzędne (np. fundacja obsługująca wiele indywidualnych projektów open source), każdy projekt powinien przesłać własny wniosek, nawet jeśli fundusze będą obsługiwane przez organizację nadrzędną.

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

Jedna organizacja powinna przesłać zgłoszenie i ponosić odpowiedzialność za koordynowanie pracy oraz wsparcie ze strony innych uczestniczących projektów. Na przykład w przypadku małych projektów open source, które są wtyczkami do większych projektów i chcecie wspólnie pracować nad wspólnym przewodnikiem dotyczącym tworzenia wtyczek, powinna wybrać jedną organizację, która poprowadzi ten projekt.

W jaki sposób moja organizacja otrzyma środki?

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

Czy organizacje otrzymują jakieś pieniądze za udział w sezonie Dokumentów Google?

W ramach budżetów projektów organizacje mogą uwzględniać fundusze na administrację, opiekę mentorską lub weryfikację zadań.

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

Google nie pokrywa opłat za przetwarzanie płatności, ponieważ różnią się one w zależności od formy płatności. Google jednak pokrywa opłatę za platformę Open Collective, a jeśli zdecydujesz się na używanie Open Collective jako dostawcy fiskalnego, to opłata również zostanie pokryta. Więcej informacji znajdziesz w przewodniku po otrzymaniu grantów.

Jaką wysokość budżetu powinna przeznaczyć moja organizacja na pracę pisarza technicznego?

Zalecamy zapoznanie się z ankietą o wynagrodzeniach w Dokumentach i ustalenie stawek godzinowych. Możesz też dołączyć do programu Write The Dokumenty Slack i poprosić na kanale #Season-of-docs zainteresowanych autorów technicznych o ofertę.

Czy moja organizacja może skorzystać z grantu dotyczącego sezonu Dokumentów Google, aby zapłacić bieżącej osobie?

Tak. Propozycje projektów muszą jednak dotyczyć nowych zadań (w tym prac konserwacyjnych, zmian lub uaktualnień istniejącej dokumentacji). Nie można ubiegać się o grant, w którym płaci się za już ukończone prace.

Czy moja organizacja może współpracować z twórcami treści technicznych?

Możesz też poprosić uczniów o pracę nad projektem. Jeśli zdecydujesz się pracować z uczniami, zdecydowanie zalecamy ograniczenie uczestnictwa w zajęciach do tych uczniów, którzy:

  • Ma ukończone 18 lat.
  • jesteś zapisany na kurs lub program pisania technicznego albo komunikacji technicznej;
  • Mieć dostęp do wsparcia technicznego w zakresie pisania w ramach programu lub kursu

Czy moja organizacja może współpracować z więcej niż 1 autorem tekstów technicznych?

Twoja organizacja może wybrać i wynająć więcej niż 1 autora tekstów technicznych, ale wszyscy artyści zajmujący się tą sprawą muszą pracować nad proponowanym przez Ciebie projektem. Współpraca z wieloma autorami tekstu technicznego zwiększy złożoność projektu i wymaga więcej czasu na ochotnika i administrację.

Czy moja organizacja może zatrudnić firmę zajmującą się pisaniem tekstów do obsługi technicznej?

Tak, Twoja organizacja może zatrudnić firmę zajmującą się pisaniem tekstów do obsługi technicznej. Upewnij się, że zatrudniona firma ma możliwość otrzymywania płatności przez OpenCollective.

Nasz specjalista ds. technicznych zrezygnował przed zakończeniem programu. Czy nasza organizacja nadal jest uprawniona do otrzymania pozostałych środków?

Zdecydowanie zalecamy, aby w ramach projektów znaleźć nowego inżyniera ds. technicznych, który ukończy Twój projekt przed końcem programu. Jednak wypłata pozostałych środków nie zależy od ukończenia projektu, ale po zakończeniu studium przypadku i końcowej oceny.

Jeśli nie udało się ukończyć projektu, studium przypadku powinno pomóc Ci zrozumieć, dlaczego tak się stało. Może się np. okazać, że narzędzia do dokumentacji są bardzo skomplikowane i przeszkodzą w zatrudnieniu pisarza technicznego, a projekt obejmuje testowanie i aktualizowanie samouczków oraz wymaga rozległego doświadczenia w kodowaniu. Co zalecisz innym projektom na podstawie swojego doświadczenia? Umieść te informacje w studium przypadku.

Czy zgłoszenie organizacji może zostać rozpatrzone przed upływem terminu przesyłania zgłoszeń?

Niestety z Sezonu Dokumentów Google nie można przesłać opinii na temat zgłoszenia organizacji.

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

Pracując nad pomysłami na projekty, staraj się znaleźć najmniejsze projekty, które będą wartościowe dla organizacji (ale można je rozszerzyć, jeśli pozwoli na to czas). Im mniej, tym lepiej. Przy tworzeniu propozycji projektu zalecamy skupienie się na mniejszych i bardziej szczegółowych projektach zamiast większych projektów, które są mniej szczegółowe. Jeśli Twój projekt wymaga dużej wiedzy specjalistycznej, spróbuj uwzględnić projekty, nad którymi mogła pracować osoba bez takiego doświadczenia.

Czy mogę uczestniczyć w sezonie Dokumentów Google jako administrator organizacji i jako mentor w programie Google Summer of Code?

Tak. Sezon Dokumentów Google i Google Summer of Code to osobne programy. Jeśli dysponujesz odpowiednią przepustowością do uczestnictwa w obu programach, nie ma problemu.

Nasza organizacja uczestniczyła w poprzednich programach dotyczących Dokumentów Google w poprzednim sezonie. Czy nasza organizacja może ponownie przesłać zgłoszenie?

Tak. Organizacje, które uczestniczyły w poprzednim sezonie Dokumentów Google, mogą zgłosić się ponownie.

Zarchiwizowane dane

Jak usunąć informacje z archiwum Sezonu Dokumentów Google?

Skontaktuj się z nami, jeśli chcesz usunąć swoje dane.