Najczęstsze pytania

Obecny etap:
Ogłoszenie wyników 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.

Czym obecny program różni się od sezonu Dokumentów 2019 i 2020?

Obecny sezon Dokumentów Google wprowadza znaczne zmiany w stosunku do poprzednich lat, takie jak:

  • Autorzy tekstów technicznych nie zgłaszają już za pośrednictwem Google dołączenia do organizacji.
  • Organizacje w ramach zgłoszenia przesyłają propozycje projektów, w tym budżet i proponowane wskaźniki.
  • Organizacje przyjęte do programu otrzymują granty, które wykorzystują do wynagrodzenia dla autorów tekstów technicznych
  • Organizacje przesyłają oceny końcowe i studia przypadków

Dlaczego wprowadzono te zmiany w sezonie Dokumentów?

W Google naszą misją jest porządkowanie informacji z całego świata oraz udostępnianie ich do ogólnego użytku. Chcemy, by w dłuższej perspektywie udało nam się wywrzeć większy wpływ na cały sezon Dokumentów w taki sposób, aby koncentrować się na zdobywaniu wiedzy o efektywnych metodach obsługi dokumentacji w modelu open source.

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

Zobacz pełną listę pomysłów na projekty. Możesz też skontaktować się z zespołem pomocy technicznej ds. pisania tekstów (wypróbuj kanał #dress-of-docs na Write the Docs Slack lub kanałach 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ą będą czuć się twórcy zajmujący się technicznymi sprawami i organizacja open source, a następnie opublikuj wstępny 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. 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 uzasadnionym projektem dla sezonu dokumentów?

Audyt dokumentacji to świetny projekt na sezon dokumentów. Zwracaj uwagę na ilość dokumentacji, którą już masz. Jeśli jest jej dużo, być może trzeba będzie ograniczyć jej zakres (na przykład przez sprawdzenie treści samouczka). Jeśli nie masz wystarczającej dokumentacji lub nie masz jej wcale, możesz w ramach projektu utworzyć brakującą dokumentację o najwyższym priorytecie.

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

Sezon Dokumenty zawiera repozytorium GitHub z szablonem i listą kontrolną do przeprowadzania audytów dokumentacji. Mamy nadzieję, że będziemy dodawać kolejne szablony w miarę ich tworzenia.

W ramach projektu Good Docs Project będziemy pracować nad utworzeniem minimalnego zakresu szablonów dokumentacji dla oprogramowania open source.

Czy organizacje są zobowiązane do korzystania z dokumentów przygotowanych przez redaktoró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 wyprodukowanych materiałów, ale oczekujemy, że ostateczna ocena i studium przypadku będą obejmowały omówienie powodów, dla których dokument nie został wykorzystany, oraz o tym, w jaki sposób projekt podjął decyzję o niekorzystaniu z dokumentacji lub innych materiałów.

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.

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

Tak, możesz go dodać, korzystając z tego linku.

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 chcesz udostępnić jakieś statystyki na temat sezonu Dokumentów 2019 i 2020?

Tak. Wyniki programu Sezon Dokumentów 2019 można zobaczyć tutaj, a wyniki programu na 2020 rok – tutaj.

Czy dostanę koszulkę Sezonu Dokumenty?

Nie. Ze względu na ograniczenia związane z wysyłką na całym świecie nie będziemy mogli oferować koszulek osobom, które ukończą projekt Sezon Dokumentów.

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 udało Ci się znaleźć odpowiedzi, przedstaw swoje pytania na liście dyskusji w ramach społeczności Season of Docs. Zapoznaj się z informacjami o kanałach dyskusji i o tym, jak się z nami skontaktować.

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

Sezon Dokumentów nie jest objęty formalną rolą mentora. Organizacje powinny określać, w jaki sposób będą oni wprowadzani i wspierani oraz w jaki sposób ich wkład w dokumentację będzie weryfikowany i zatwierdzany w zgłoszeniu organizacji. Jeśli chcesz w ramach Sezonu Dokumentów zapewnić mentorstwo autorom tekstów technicznych, zachęcamy do współpracy z administratorami organizacji.

Czy sezon dokumentów jest taki jak Google Summer of Code?

Nie. Sezon Dokumentów jest przeznaczony dla osób z doświadczeniem w tworzeniu dokumentów. Nie jest to program mentorski, taki jak Google Summer of Code.

Dla pisarzy technicznych

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

Sezon Dokumentów nie ma formalnego zgłoszenia technicznego autora. Aby wziąć udział w tym programie jako autor jakichś treści technicznych, 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 autorów technicznych serii Dokumentów. Więcej informacji znajdziesz w przewodniku technicznym dla pisarzy.

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ć. Celem programu Season of Docs jest projektowanie open source, dzięki któremu twórcy treści technicznych mogą dowiedzieć się więcej o narzędziach i platformach służących do dokumentowania produktów open source. Z tego względu przed rozpoczęciem tworzenia projektu w sezonie Dokumentów nie wymagamy zazwyczaj szczegółowej wiedzy o konkretnych platformach z dokumentacją.

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ę już, z jakiej platformy korzysta organizacja, możesz przetestować odpowiedni język i strukturę oraz poeksperymentować 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 uczestniczyć w projektach Sezon of Docs?

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 autorzy materiałów technicznych, którzy już pracują nad projektem open source, mogą nad nim pracować w ramach sezonu dokumentów?

Tak, ale w swojej propozycji organizacja powinna pamiętać o wcześniejszej lub obecnej relacji autora projektu z projektem.

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

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 oświadczenie dla organizacji, możesz opisać swoje doświadczenie lub szkolenie w formie pisemnej. Musisz być w stanie przedstawić dowody potwierdzające, że interesuje Cię dokumentacja techniczna lub open source, w tym przykłady napisanych przez Ciebie dokumentów. Organizacja typu open source będzie szukać redaktorów technicznych z odpowiednim poziomem wiedzy, aby zapewnić pomyślne zakończenie sezonu projektów w Dokumentach.

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

Tak. Google przekaże zaakceptowanym organizacjom granty na potrzeby zatrudniania twórców technicznych.

Jak wygląda odpowiednie oświadczenie o zainteresowaniu autora tekstu technicznego?

Najlepsze zgłoszenia zainteresowania pochodzą od autorów tekstów technicznych, którzy poświęcają czas na interakcję z wybraną organizacją open source i przedyskutowanie ich z wybraną organizacją zajmującą się oprogramowaniem open source, zanim prześlą swoje oświadczenia. Zapoznaj się z przewodnikiem, aby utworzyć interesujące Cię zgłoszenie.

Ile czasu zajmuje uczestnictwo w Serze Dokumentów?

Rozmiary projektów są różne, ale maksymalny czas trwania programu wynosi 5–30 godzin tygodniowo. Ilość czasu, który musisz poświęcić, zależy jednak od charakteru projektu uzgodnionego z Twoją organizacją. Przed podjęciem współpracy oceń projekt i omów szacowany czas z organizacją open source.

Czy mogę przesłać zgłoszenie organizacji dotyczące tworzenia dokumentacji projektu open source jako osoba fizyczna? Chcę stworzyć 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 powinna zostać przesłana tylko wtedy, gdy możesz otrzymać środki w imieniu projektu open source. Zachęcamy do skontaktowania się z zespołem, aby wspólnie przygotować ofertę.

Jestem uczniem. Czy mogę wziąć udział w programie Sezon Dokumentów? Czy sezony dokumentów nauczą mnie tworzyć techniczne treści?

Uczniowie mogą pracować z przyjętymi organizacjami, ale w programie Seasonal of Docs nie chodzi o rozwijanie umiejętności technicznych w zakresie pisania. Oczekujemy, że autorzy biorący udział w programie będą mieli profesjonalne umiejętności techniczne lub odpowiednie doświadczenie. Uczniowie, którzy chcą wziąć udział w programie, powinni zaznaczyć swoje doświadczenie w pisaniu i edytowaniu tekstu, kontaktując się z zainteresowanymi organizacjami i projektami.

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ż obecnie nie jest to sprzeczne z zasadami, zdecydowanie zalecamy, aby uczniowie zaakceptowani na kurs Google Summer of Code nie zgłaszali się do udziału w tym warsztatach jako autora materiałów technicznych dostępnych w momencie sezonu dokumentów. Uczniowie powinni skupić się na pracach nad Google Summer of Code, zamiast na przesyłanie zgłoszenia w sezonie dokumentów.

Co więcej, program Seasonal of Docs nie jest przeznaczony dla początkujących, ponieważ jest przeznaczony dla osób, które mają już solidne umiejętności techniczne i doświadczenie w pisaniu. Autorzy autorów tekstu z programu Sezon of Docs nie są mentorami. Trzeba ich samodzielnie zorganizować i zmotywować do opracowania planu rozwiązania projektu 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 Sezon Dokumentów Google, możesz wysłać im 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 tym sezonie?

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

Jak dodać nazwę Sezonu Dokumentów do CV?

Wypisz ją tak samo jak każdą inną pracę, np. „Pracował jako autor techniczny dla projektu [nazwa projektu] w ramach programu Season of Docs”.

Czy przekazujesz świadectwo ukończenia kursu Sezon Dokumentów?

Nie mamy możliwości wysyłania zaświadczeń o udziale w projekcie ani potwierdzeń udziału w projekcie osobom z branży technicznej.

Dla administratorów organizacji open source

Jakie są wymagania dotyczące organizacji open source?

Aby kwalifikować się do udziału w programie, Twoja organizacja musi należeć do grupy prowadzącej aktywny projekt bezpłatnej lub open source oprogramowania, np. BRL-CAD. Projekt nie musi być podmiotem o prawie osobowości prawnej. Aby wziąć udział w programie, organizacja musi już przygotować i opublikować 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 całego programu Seasonal of Docs.

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, prześlij osobne zgłoszenia i oferty dla każdej z nich.

Czy organizacja może przesłać więcej niż jeden wniosek pakietowy?

Nie. Każda organizacja może przesłać tylko jedno zgłoszenie. Jeśli Twoja organizacja ma inne organizacje podrzędne (np. to fundacja z wieloma indywidualnymi projektami 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 dokumentacyjnym?

Zgłoszenie pakietowe powinno przesłać jedna z organizacji, która będzie odpowiedzialna 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ększego projektu, i chcecie opracować wspólny przewodnik na temat tworzenia wtyczek, powinien wybrać jedną organizację, która poprowadzi projekt.

Jak moja organizacja otrzyma środki?

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

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

W ramach budżetu projektu organizacje mogą przyznawać fundusze na administrację, opiekę mentora lub sprawdzanie prac.

Czy Google pokrywa opłaty za obsługę 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. Jednak Google pokrywa opłatę za platformę Open Collective, a jeśli zdecydujesz się korzystać z Open Collective jako dostawcy usług podatkowych, również ona zostanie pokryta. Więcej informacji znajdziesz w przewodniku po otrzymaniu grantów.

Jaką wysokość budżetu powinna przeznaczyć moja organizacja na specjalistę ds. technicznych?

Zalecamy zapoznanie się z ankietą na temat wynagrodzenia w Dokumentach i opracowanie stawek godzinowych. Możesz też dołączyć do programu Write The Docs Slack i poprosić o ofertę na kanale #SEASON-of-docs.

Czy moja organizacja może skorzystać z grantu dotyczącego sezonu Dokumentów, aby wynająć osobę, która obecnie jest współtwórcą?

Tak. Propozycje projektów muszą jednak dotyczyć nowych zadań (w tym prac konserwacyjnych, poprawek lub uaktualnień istniejącej dokumentacji). Nie można ubiegać się o grant, aby wypłacić środki za materiał, który został już ukończony.

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

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

  • mają ukończone 18 lat,
  • Uczestniczysz w programie lub kursie technicznych w zakresie komunikacji lub 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 wynagrodzić więcej niż 1 autora tekstów technicznych, ale nad proponowanym przez Ciebie projektem muszą pracować wszyscy artyści techniczni współpracujący z Twoją organizacją. Współpraca z wieloma autorami tekstów technicznych zwiększy złożoność projektu i wymaga więcej czasu ochotniczego i administracyjnego.

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

Tak, Twoja organizacja może zatrudnić firmę zajmującą się pisaniem tekstów do pomocy technicznej. Upewnij się, że zatrudniona przez Ciebie firma może otrzymywać płatności przez Open Collective.

Nasz specjalista ds. technicznych zrezygnował z programu. Czy nadal możemy otrzymać pozostałe środki?

Zdecydowanie zachęcamy do znalezienia nowego autora projektu technicznego, który dokończy Twój projekt przed zakończeniem programu. Jednak wypłata pozostałych środków nie zależy od ukończenia projektu, ale od zakończenia studium przypadku i ostatecznej oceny.

Jeśli nie udało się ukończyć projektu, oczekujemy, że pomoże Ci ono w studium przypadku. Może się na przykład okazać, że narzędzia do dokumentacji są bardzo skomplikowane i stanowią przeszkodę przy wdrażaniu autora technicznego, a projekt obejmuje testowanie i aktualizowanie samouczków oraz wymaga dużego doświadczenia w kodowaniu. Co polecił(a)byś innym projektom na podstawie Twoich doświadczeń? Umieść te informacje w studium przypadku.

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.

Jak organizacje powinny określać zakres propozycji projektu?

Opracowując pomysły na projekty, staraj się znajdować najmniejsze projekty, które będą stanowić wartość dla organizacji (ale mogą być obszerne, jeśli pozwala na to czas). Im mniej, tym lepiej. Zalecamy, by podczas tworzenia propozycji projektu trzymać się mniejszych, bardziej szczegółowych projektów, które obejmują większe i mniej szczegółowe projekty. 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 mogę uczestniczyć jako administrator organizacji w sezonie Dokumentów i jako mentor w programie 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.

Nasza organizacja uczestniczyła w poprzednim sezonie programów Dokumentów. Czy możemy jeszcze raz przesłać zgłoszenie?

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

Zarchiwizowane dane

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

Skontaktuj się z nami, aby poprosić o usunięcie Twoich danych.