Najczęstsze pytania

Obecny etap:
Program Sezon Dokumentów 2020 zakończył się 15 marca 2021 r. Zobacz oś czasu.

Ogólne

Czy sezon dokumentów to program rekrutacji?

Nie. Jeśli chcesz współpracować z Google, wejdź na stronę ofert pracy Google.

Czy okres korzystania z Dokumentów jest uznawany za staż, pracę lub inną formę zatrudnienia?

Nie. Sezon dokumentów to działanie wykonywane przez autora tekstu technicznego jako niezależnego redaktora technicznego, za które otrzymuje stypendium. Autorzy wiadomości technicznych mogą zrezygnować z otrzymywania stypendium.

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

Sezon of Docs ma na celu wspieranie współpracy między organizacjami open source i autorami materiałów technicznych. Sądzimy, że ten program:

  • Zapewnij twórcom technicznym szansę na zdobycie doświadczenia w udziale w projektach open source i poznanie kodu open source.
  • Umożliwienie projektom open source angażowania technicznej społeczności pisania, a tym samym ulepszania dokumentów open source.
  • zwiększenie świadomości w zakresie dokumentacji open source i technicznego;

Korzyści dla organizacji open source:

  • Doświadczenie we współpracy z autorem tekstów technicznych.
  • Ulepszone dokumenty.
  • Potencjał stałej współpracy z autorami materiałów technicznych po zakończeniu sezonu Dokumentów.
  • Ulepszone procesy dokumentowania projektów.
  • Zwiększenie świadomości dotyczącej dokumentacji open source w społeczności technicznej zajmującej się pisaniem tekstów.

Korzyści dla autorów tekstów technicznych:

  • Doświadczenie w dziedzinie udziału w projekcie open source.
  • Doświadczenie w pracy z dokumentami i kodem dla programistów.
  • Uznanie za swoją pracę.
  • Napisz coś do swojego CV.
  • Potencjał stałej współpracy z projektem open source po zakończeniu sezonu Dokumentów
  • Zwiększona świadomość w społecznościach open source korzyści dla pisarzy technicznych.

Jakimi rodzajami projektów mogą zająć się autorzy tekstów technicznych?

Oto kilka pomysłów:

  • Zbudować witrynę z dokumentacją na platformie, na którą będą decydować autor techniczny i mentor open source, a następnie opublikować w niej początkowy zestaw podstawowych dokumentów. Przykłady platform:

  • Zrefaktoryzować dotychczasową dokumentację projektu open source, aby zapewnić użytkownikom lepsze wrażenia lub uzyskać łatwiejszą architekturę informacji.

  • Napisać ogólne omówienie lub wprowadzenie do produktu lub funkcji. Zespół często opracowuje dokumentację techniczną od podstaw, w efekcie której jest bardzo dużo szczegółów, ale trudno jest zrozumieć ją jako całość. Pisarz techniczny może to naprawić.

  • Utworzyć samouczek dotyczący ogólnego przypadku użycia.

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

  • Przewodnik dla współtwórcy zawiera podstawowe informacje o tym, jak rozpocząć pracę jako współtwórca projektu open source, a także wszelkie reguły dotyczące umów licencyjnych, procesów związanych z wnioskami typu „push” i weryfikacją, tworzeniem projektu itd.

Czy film jest możliwym projektem na potrzeby Sezonu Dokumentów?

Tak. Publikowanie pomysłów na projekty i wybieranie propozycji projektu przesłanego przez autora technicznego zależy od organizacji open source. Jeśli film spełnia wymagania organizacji open source, możesz przesłać go jako projekt „Smooth of Docs”, o ile jest to film z instrukcjami technicznymi. Zadbaj o sprecyzowanie wymagań dotyczących filmów i pamiętaj, że produkcja wysokiej jakości filmów wymaga czasu i zasobów.

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

Nie. Mamy nadzieję, że cała dokumentacja i kod otrzymują satysfakcjonujące środowisko. Nie wymagamy od organizacji korzystania z dokumentów ani kodu dla autorów technicznych.

Gdzie występuje sezon Dokumentów?

Sezon Dokumentów odbywa się całkowicie online. W ramach tego programu nie trzeba odwiedzać miasta.

Jak mogę być na bieżąco z tematem Sezon Dokumentów?

Odwiedź listę adresową z ogłoszeniami na stronie season-of-docs-announce, aby otrzymywać najnowsze informacje i ogłoszenia dotyczące sezonu dokumentów. Dołącz do grupy, aby otrzymywać aktualizacje e-mailem.

Co mogę zrobić, aby zachęcić widzów do korzystania z sezonu Dokumentów?

Możesz opublikować tweeta na temat programu, pisać posty na blogu, publikować filmy lub zorganizować spotkanie lub sesję informacyjną w swojej okolicy. Udostępniliśmy przykładowe treści i zasoby, które możesz udostępnić w swojej społeczności (w organizacji, grupie autorów tekstu i innych osobach kontaktowych).

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

Spotkanie można zaplanować w dogodnym dla siebie czasie i miejscu. Zapoznaj się z regułami programu i użyj przykładowych treści.

Czy mogę uczestniczyć w programie Sezon Dokumentów jako zarówno mentor, jak i twórca treści technicznych?

Nie. Chcemy mieć pewność, że każdy projekt i twórca techniczny otrzyma odpowiednią uwagę, co może negatywnie wpłynąć na wrażenia uczestników. Zdecyduj, czy bardziej Ci odpowiada udział w roli mentora, czy redaktora technicznego.

Czy masz jakieś statystyki dotyczące sezonu Dokumentów 2019?

Tak. Wyniki programu Sezon Dokumentów 2019 można wyświetlić tutaj.

Czy dostanę koszulkę Sezonu Dokumenty?

Tak! Autorzy i mentorzy techniczni na etapie pomyślnie ukończonych projektów otrzymają koszulkę z serią Dokumentów.

Kiedy dotrze moja koszulka?

Koszulkę otrzymasz na początku 2021 r. Firma Google zatrudniła dostawcę, aby wyprodukował koszulki i zajmował się logistyką wysyłania ich na cały świat. Wkrótce po ogłoszeniu wyników długotrwałego projektu administratorzy programu Google wyślą Ci e-mailem unikalny kod dostępu umożliwiający wybranie stylu/rozmiaru koszulki i podanie szczegółów dostawy. Produkcja i dostawa koszulek zajmuje zwykle kilka tygodni.

A jeśli mam więcej pytań?

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

Jeśli po zapoznaniu się z całą dokumentacją nadal nie udało Ci się znaleźć odpowiedzi, omów swoje pytania ze społecznością Season of Docs na Slacku lub na liście dyskusji. Zapoznaj się z informacjami o kanałach dyskusji i o tym, jak się z nami skontaktować.

Dla pisarzy technicznych

Kiedy pisarze ds. technicznych mogą zgłosić się do sezonu dokumentów?

Etap przesyłania zgłoszeń do scenariuszy technicznych trwa od 9 czerwca 2020 r. do 9 lipca 2020 r. Zapoznaj się z harmonogramem programu i przewodnikiem technicznym dla autorów.

Jakie narzędzia i struktury do dokumentacji warto znać, aby korzystać z tego sezonu?

Dostępne narzędzia i platformy do dokumentacji zależą od organizacji, z którą chcesz współpracować. W ramach programu Season of Docs skoncentrujemy się na projektach open source, które mają pomóc twórcom technicznym lepiej poznać narzędzia i platformy związane z dokumentowaniem produktów open source. Dlatego zwykle nie wymagamy szczegółowej wiedzy o konkretnych platformach z dokumentacją, zanim rozpoczniesz tworzenie projektu w sezonie Dokumentów.

Jednak większość organizacji typu open source w swojej dokumentacji używa języka Markdown lub innego języka znaczników. Sprawdź, 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. Platforma może być statycznym generatorem witryn, np. Jekyll, Sphinx czy Hugo, albo hostować swoje dokumenty w sekcji Read the Docs lub GitHub Pages. Gdy dowiesz się, z jakiej platformy korzysta organizacja, przeanalizuj język i strukturę, a potem poeksperymentuj z nimi. Dzięki temu możesz szybko rozpocząć pracę z projektem open source i uzyskać rzetelne porady na temat wybranego projektu open source.

Jakie języki programowania muszę znać, aby wziąć udział w tym sezonie?

W zależności od charakteru projektu dokumentacyjnego może być konieczna znajomość języka programowania. Pamiętaj o tym, wybierając i proponowając projekt z dokumentacją, oraz skonsultuj się z organizacją open source, aby sprawdzić wymagany poziom jej znajomości.

Czy mogę przesłać więcej niż jedną propozycję projektu?

Tak, ale przyjęta zostanie tylko jedna propozycja projektu na twórcę technicznego. Zapoznaj się z przewodnikiem tworzenia aplikacji.

Czy autorzy materiałów technicznych, którzy już pracują nad projektem open source, mogą nad nim pracować w ramach sezonu dokumentów?

Tak, ale w ofercie pakietowej zaznacz swoją wcześniejszą relację z projektem.

Czy grupa może przesłać propozycję współpracy nad jednym projektem?

Nie, nad danym projektem może pracować tylko jedna osoba.

Czy mogę skontaktować się bezpośrednio z organizacjami mentorskimi przed przesłaniem propozycji programu do sezonu Dokumentów?

Tak, przed przesłaniem zgłoszenia do sezonu Dokumentów możesz skontaktować się bezpośrednio z organizacją open source, z którą chcesz współpracować. Mentorki open source pomogą Ci w opracowaniu projektu.

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

  • Podczas rejestracji musisz mieć ukończone 18 lat.
  • Musisz kwalifikować się do pracy w kraju, w którym mieszkasz w trakcie programu.
  • Musisz mieszkać w kraju, który nie jest obecnie objęty embargiem przez Stany Zjednoczone. Zapoznaj się z zasadami programu oraz informacjami o programach sankcji i informacjach o krajach przygotowanymi przez Departament Skarbu Stanów Zjednoczonych.

Czy zrobicie dla mnie wyjątek?

Nie. Nie możemy zrobić wyjątku, jeśli nie spełniasz wymagań, niezależnie od tego, jak bardzo jesteś utalentowany lub zainteresowany. Zrobienie dla Ciebie wyjątku nie jest uczciwe w stosunku do innych autorów tekstu o charakterze technicznym, którzy ubiegają się o dostęp do programu Sezon Dokumentów.

Jakie formularze muszę przesłać?

Zaakceptowani uczestnicy muszą przesłać odpowiednie formularze podatkowe.

Czy potrzebuję wcześniejszego doświadczenia lub przeszkolenia jako autora tekstu technicznego?

Preferowane jest wcześniejsze umiejętności w zakresie pisania technicznego lub szkolenia, ale nie są one niezbędne. Przesyłając propozycję projektu, możesz w formie pisemnej opisać swoje doświadczenie i/lub szkolenia. Możesz przedstawić dowody potwierdzające, że interesuje Cię dokumentacja techniczna lub open source, w tym przykłady napisanych przez Ciebie dokumentów. Program Seasonal of Docs ma na celu współpracę z doświadczonymi lub przeszkolonymi autorami materiałów technicznych z mentorami open source, aby mogli uczyć się od siebie nawzajem. Organizacja typu open source będzie szukać redaktorów technicznych z doświadczeniem wymaganym przez organizację, aby zapewnić pomyślne zakończenie projektów dotyczących sezonu Dokumentów.

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

Tak. Google przyznaje stypendium twórcom, którzy ukończą program. Możesz zrezygnować z otrzymywania stypendium. Zapoznaj się ze szczegółami dotyczącymi stypendium dla twórców technicznych.

Czy otrzymam zapłatę, nawet jeśli organizacja nie wykorzysta mojej dokumentacji lub kodu?

Tak, pod warunkiem, że Twój projekt przejdzie ostateczną ocenę przez mentora zajmującego się oprogramowaniem open source. To, czy w projekcie open source wykorzystano opracowaną dokumentację lub kod, nie wpływa na wypłatę stypendium dla twórców technicznych.

Jak wygląda dobra propozycja scenariusza technicznego?

Najlepsze są propozycje twórców treści technicznych, którzy poświęcają czas na interakcję i omówienie swoich pomysłów z wybraną organizacją open source przed przesłaniem zgłoszenia do programu Sezon Dokumentów. Zapoznaj się z przewodnikiem tworzenia aplikacji.

Ile czasu zajmuje uczestnictwo w Serze Dokumentów?

Ilość czasu, który musisz poświęcić, zależy od charakteru projektu uzgodnionego z organizacją mentorską. Wymóg dotyczący liczby godzin jest celowo elastyczny, aby umożliwiać różne rodzaje projektów i styl pracy. Autorzy materiałów technicznych poświęcają średnio 20–30 godzin tygodniowo.

Przed przesłaniem propozycji projektu należy ocenić projekt i omówić szacowany czas z organizacją zajmującą się tworzeniem oprogramowania open source. Jeśli trudno jest Ci poświęcić uzgodniony czas z powodu innych zobowiązań, możesz zrealizować projekt w dłuższym czasie i nadal otrzymać stypendium i potwierdzenie za wykonanie pracy. Przesyłając zgłoszenie do sezonu dokumentów, określ opcję dla długotrwałego projektu.

Studiuję komunikację techniczną, ale nie mam jeszcze żadnego doświadczenia zawodowego. Czy nadal mogę wziąć udział w programie?

Tak. Przesyłając propozycję projektu, wymień studia w tej sekcji, by poznać ich wcześniejsze doświadczenia zawodowe.

Jestem studentem i studentem F1 w Stanach Zjednoczonych. Jak mogę uzyskać upoważnienie do uczestnictwa?

Aby dowiedzieć się więcej, skontaktuj się z uczelnią, w którym mieści się edukacja międzynarodowa. Google nie może udzielać żadnych autoryzacji CPT ani OPT.

Wszyscy uczestnicy, którzy zaakceptowali zaproszenie, otrzymają e-maila z potwierdzeniem. Nie oferujemy list niestandardowych.

W jaki sposób aplikacja Seasonal of Docs wykorzystuje informacje z mojego formularza zgłoszeniowego?

Administratorzy programu Google przekazują niektóre informacje ze zgłoszenia do administratorów wybranej organizacji open source, aby mogli ocenić propozycję projektu.

Jeśli Twój projekt zostanie przyjęty do programu, w Seonie Dokumentów opublikowane zostaną szczegóły projektu na stronie internetowej.

Zapoznaj się z opisem użycia danych w przewodniku po formularzu zgłoszeniowym dotyczącym zapisu technicznego.

Czy mogę wziąć udział zarówno w programie Google Summer of Code, jak jako autor tekstów technicznych w narzędziu Season of Docs, jak i uczestnik programu Google Summer of Code?

Chociaż nie jest to obecnie sprzeczne z zasadami, zdecydowanie zalecamy, aby uczniowie zaakceptowali zapisy na kurs Google Summer of Code nie zgłaszają się do udziału w terminach dla scenarzystów technicznych dostępnych w sezonie Dokumentów. Uczniowie powinni skupić się na pracy nad kodum Google Summer of Code, a nie na uczestniczeniu w programie Seasonal of Docs.

Dla mentorów i administratorów organizacji typu open source

Chcę dowiedzieć się więcej o uczestnictwie w programie Sezon Dokumentów. Gdzie znajdę więcej informacji?

Przeczytaj przewodnik dla mentorów i zasady programu, aby dowiedzieć się, jak zostać mentorem w Sezoncie Dokumentów.

Jakie wymagania należy spełnić, aby móc korzystać z usług mentorskich?

Aby kwalifikować się do udziału w programie jako organizacja mentorska, należy należeć do grupy prowadzącej aktywny projekt bezpłatnego lub open source oprogramowania, np. BRL-CAD. Projekt nie musi być podmiotem o prawie osobowości prawnej. Aby wziąć udział w programie, organizacje mentorskie muszą już przygotować i udostępnić oprogramowanie w ramach licencji Open Source Initiative i mieć co najmniej dwóch współpracowników, którzy będą pełnić rolę administratorów i/lub mentorów przez cały okres korzystania z programu.

Zapoznaj się też z wymaganiami opisanymi w zasadach programu oraz w programach sankcji i informacjach o krajach wydanych przez Skarb Państwa Stanów Zjednoczonych.

Czy słowo „organization” (organizacja) jest odpowiednikiem projektu 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 jeden projekt open source. Jeśli Twoja organizacja ma niezależne organizacje podrzędne, poinformuj o tym w zgłoszeniu. Na przykład język programowania „Foo” może dotyczyć dokumentacji całego języka, a także wszelkich wtyczek, bibliotek czy modułów używanych w danym języku.

Czy organizacje otrzymują pieniądze za udział w sezonie dokumentów?

Po zakończeniu programu organizacje, które uzyskają dobrą opinię, otrzymają stypendium za osobę przyjętą do programu technicznego. Nie ma znaczenia, czy projekt twórczyni technicznych się uda. Organizacje mogą wykorzystać te fundusze według własnego uznania.

W jaki sposób administratorzy programu Google rozdzielają przedziały czasu na projekty dotyczące pisania prac technicznych?

W sezonie sezonu Dokumentów 2020 można w sumie zgłosić maksymalnie 50 projektów technicznych.

Oczekujemy, że przyjmiemy maksymalnie 2 projekty na organizację, by nie doszło do zbyt wielu zaakceptowanych projektów. Jeśli jednak w ramach bezpłatnego procesu selekcji nie znajdzie się wszystkie miejsca, administratorzy programu Google mogą przydzielić niektórym organizacjom dodatkowe przedziały.

Wysyłając wybrane projekty techniczne, możesz wybrać więcej niż 2 projekty. Zaznaczone opcje powinny być uporządkowane według priorytetu, a najwyższy priorytet znajduje się na górze listy.

W komunikacji z autorami materiałów technicznych należy wyraźnie zaznaczyć, że projekt nie zostanie zaakceptowany, dopóki administratorzy programu Google nie opublikują listy zaakceptowanych projektów na stronie programu.

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

Nie możemy przesłać opinii na temat zgłoszenia organizacji.

W jaki sposób organizacje powinny rozwijać swoje pomysły?

Zakres wielu projektów będzie się zmieniał w miarę postępów. Jako mentorzy powinniście wiedzieć o wszelkich zmianach w projektach i starać się zminimalizować zakres oraz odpowiednio go ograniczyć. Opracowując pomysły na projekty, staraj się wybierać najmniejsze projekty, które będą wartościowe dla organizacji (ale mogą być obszerne, jeśli pozwala na to czas). Im mniej, tym lepiej. Podczas oceny propozycji scenarzystów technicznych zalecamy preferowanie mniejszych, bardziej szczegółowych ofert zamiast większych projektów, które są mniej szczegółowe. Jeśli Twój projekt wymaga dużej wiedzy, postaraj się uwzględnić projekty, nad którymi mogłaby pracować osoba bez takiego doświadczenia.

Czy audyt dokumentacji jest uzasadnionym projektem dla sezonu dokumentów?

Audyt dokumentacji to świetny projekt na sezon dokumentów. Zwracaj uwagę na ilość posiadanej już dokumentacji. Jeśli jest ich dużo, konieczne może być zmniejszenie zakresu (np. sprawdzenie samej treści samouczka). Jeśli nie masz wystarczającej dokumentacji lub nie masz jej wcale, możesz uwzględnić w projekcie brakujące dokumenty o najwyższym priorytecie.

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

W ramach The Good Docs Project będziemy pracować nad stworzeniem pewnej minimalnej wersji szablonów dokumentacji na potrzeby oprogramowania open source.

Czy mogę uczestniczyć w programie Sezon Dokumentów jako administrator organizacji i mentorka?

Tak. Menedżerem organizacji może być również administrator organizacji. Nie musisz wypełniać osobnego formularza dla mentora. Wypełniając formularz zgłoszeniowy dla organizacji lub alternatywny formularz dla administratora, skorzystaj z opcji w tym formularzu, aby wskazać, że jesteś też mentorem.

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

Tak. Sezon Dokumentów i Google Summer of Code to osobne programy. Jeśli macie możliwość korzystania z obu programów, nie ma problemu.

Czy mogę uczestniczyć jako administrator organizacji lub mentor/mentorka zarówno w sezonie Dokumentów, jak i w Google Code-In?

Tak. Sezon Dokumentów i Google Code-In to odrębne programy. Jeśli macie możliwość korzystania z obu programów, nie ma problemu.

Zarchiwizowane dane

Jak usunąć informacje z archiwum sezonu dokumentów?

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