Obecny etap:
Program Sezon Dokumentów 2020 zakończył się 15 marca 2021 r. Zobacz oś czasu.
Ta strona zawiera wskazówki dla twórców treści technicznych dotyczące wypełniania kluczowych części zgłoszenia do udziału w sezonie dokumentów. Pomogą Ci one zrozumieć, jakie czynniki mogą wziąć pod uwagę organizacje open source, wybierając projekty techniczne, którymi chcą się zajmować w trakcie sezonu Dokumentów.
Wstęp
Poniższe wytyczne dotyczą ogólnego sezonu Dokumentów. Każda organizacja open source może mieć określone kryteria oceny. Przed przesłaniem zgłoszenia możesz skontaktować się z dowolną organizacją uczestniczącą w programie, aby omówić jej wymagania i opracować ofertę projektu. Zapoznaj się z fazą eksploracji technicznej dla pisarzy, która jest opisana w przewodniku dla pisarzy technicznych.
Formularz zgłoszeniowy
Formularz zgłoszeniowy jest dostępny w przewodniku technicznym dla pisarzy na etapie zgłaszania autora zgłoszenia technicznego.
Po przesłaniu formularza możesz aktualizować zawarte w nim informacje do końca fazy wysyłania zgłoszenia dotyczącego autorów tekstu technicznego (9 lipca 2020 r.).
Dane osobowe
W formularzu zgłoszeniowym należy podać następujące dane osobowe:
Imię i nazwisko: podaj swoje imię i nazwisko. Sezon Dokumentów nie udostępni tej nazwy organizacjom open source i nie opublikuje tej nazwy na stronie internetowej.
Wybrana przez Ciebie wyświetlana nazwa: podaj nazwę, która ma być używana jako publiczny identyfikator podczas korzystania z sezonu Dokumentów. Zdecydowanie zalecamy, aby jako wyświetlanej nazwy nie używać prawdziwego, pełnego imienia i nazwiska. W sezonie dokumentów Twoja wyświetlana nazwa zostanie udostępniona organizacji open source, którą wskażesz w formularzu zgłoszeniowym. W sezonie dokumentów Twoja wyświetlana nazwa pojawi się na liście zaakceptowanych projektów dotyczących pisania prac technicznych.
Twój adres e-mail: podaj adres e-mail powiązany z Twoim kontem Google. (Aby wziąć udział w sezonie Dokumentów, musisz mieć konto Google. Możesz używać konta Google z adresem e-mail innym niż Gmail. Przeczytaj ten artykuł pomocy). Sezon Dokumentów używa Twojego adresu e-mail do kontaktowania się z Tobą i udostępniania Ci zasobów witryny. Sezon Dokumentów udostępni ten adres e-mail organizacji open source, którą wskazano w formularzu zgłoszeniowym. Sezon Dokumentów nie opublikuje tego adresu e-mail na stronie.
Poniżej znajdziesz podsumowanie tego, w jaki sposób sezon Dokumentów wykorzystuje informacje z Twojego formularza zgłoszeniowego.
Informacje o technicznym pisaniu tekstów
Gdy mentorzy i administratorzy organizacji zajmujący się open source przyjmują ofertę projektu, są zainteresowani Twoim doświadczeniem w pisaniu. Możesz podać szczegółowe informacje w formularzu w ten sposób:
Najnowsze umiejętności w zakresie pisania technicznego: maksymalnie 3 wpisy, w których możesz wymienić ostatnie stanowiska w pisaniu tekstów technicznych lub doświadczenie zawodowe. Jeśli korzystasz z dokumentacji open source, również ją umieść. Podsumuj swoją rolę, obowiązki na tym stanowisku i wykonaną pracę. W odpowiednich przypadkach możesz podać daty.
Link do CV: (opcjonalnie) Adres URL publicznie dostępnej wersji Twojego CV lub CV.
Link do przykładów Twoich prac: (opcjonalnie). Adres URL publicznie dostępnego portfolio próbek tekstów lub poszczególne linki do przykładów Twoich prac.
Co jeszcze chcesz dodać: (opcjonalnie) Wszelkie informacje, które chcesz dodać. Mogą to być na przykład informacje o tym, czy interesuje Cię dokumentacja techniczna, dlaczego chcesz korzystać z funkcji Sezon Dokumentów lub inne przydatne funkcje.
Propozycja projektu
Propozycja projektu jest podsumowaniem pracy dokumentacyjnej, którą chcesz wykonać podczas pracy z wybraną organizacją open source podczas Sezonu Dokumentów.
Możesz przesłać maksymalnie 3 oferty projektu. Wszystkie propozycje projektów muszą składać się z tego samego formularza.
Poświęć czas na opracowanie propozycji projektu, pamiętając o poniższych wskazówkach.
Czynności przygotowawcze:
Przejrzyj listę uczestniczących organizacji open source i wybierz co najmniej jedną organizację, która Cię interesuje. Zapoznaj się z pomysłami na projekty zaproponowane przez każdą z wybranych organizacji open source.
Jeśli interesująca Cię organizacja nie zaproponowała żadnych pomysłów, możesz przejrzeć ogólną listę pomysłów na projekty i oprzeć się na jednym z nich. Możesz też samodzielnie zaproponować swój pomysł, niezależnie od tego, czy organizacja opublikowała pomysły.
Skontaktuj się z co najmniej jedną z organizacji uczestniczących w programie, aby omówić pomysły związane z projektem. Aby się z nami skontaktować, użyj adresu e-mail organizacji z listy organizacji uczestniczących w programie. Rozmowy na wczesnym etapie pomagają przygotować dobrą propozycję projektu.
Propozycja projektu w formularzu zgłoszeniowym:
Nazwa organizacji open source: wpisz nazwę organizacji open source, z którą chcesz współpracować w trakcie trwania sezonu dokumentów. Musi to być jedna z organizacji uczestniczących w programie wyświetlanym na stronie internetowej Season of Docs.
Nazwa projektu open source: jest to nazwa projektu open source, nad którym chcesz pracować w sezonie dokumentów. Projekt musi należeć do jednej z organizacji uczestniczących w programie wyświetlanych na stronie Seasonal of Docs. W przypadku niektórych organizacji nazwa organizacji i projektu mogą być takie same.
Nazwa proponowanego projektu technicznego. Podaj krótki, opisowy tytuł, który podsumowuje główny cel proponowanej pracy.
Szczegółowy opis. W opisie projektu technicznego, który chcesz utworzyć, podaj jak najwięcej szczegółów. W polu opisu możesz wpisać wiele akapitów. Oto kilka pomysłów, które warto uwzględnić:
- Podaj szczegóły dokumentacji, którą chcesz utworzyć lub zaktualizować. Jeśli planujesz zaktualizować istniejący dokument lub witrynę, dołącz link i opisz proponowane zmiany. Jeśli proponujesz nowy dokument lub nową witrynę, opisz jego zawartość i odbiorców.
- Powiedz, dlaczego proponujesz nową dokumentację lub zmiany.
- Jeśli omawiałeś projekt z kimś z organizacji open source, załącz podsumowanie jego wyników.
- Zwróć uwagę na język i styl swojej oferty. Organizacje open source mogą użyć ich jako czynnika podczas oceny oferty.
- Nie podawaj linku do opisu projektu. Opis powinien zawierać wszystkie najważniejsze szczegóły Twojego projektu. Organizacja open source musi mieć możliwość dokonania wyboru na podstawie treści formularza zgłoszeniowego, a nie treści przechowywanych gdzie indziej. Jeśli chcesz dodać linki do innych treści, które uzupełniają opis, nie musisz tego robić. Pamiętaj jednak, że przy wyborze projektu bierzemy pod uwagę tylko treść formularza.
Inne ważne pola formularza zgłoszeniowego
Poniżej znajdziesz wytyczne dotyczące innych kluczowych informacji, które należy podać w formularzu zgłoszeniowym:
Wybór standardowej długości lub długotrwałego projektu: standardowy okres tworzenia dokumentów w sezonie Dokumentów wynosi 3 miesiące. Jeśli Twój projekt wymaga dłuższego czasu, musisz zaznaczyć to w formularzu zgłoszeniowym po konsultacji z wybraną organizacją open source. Zapoznaj się z opisem długotrwałych projektów.
Przyjęcie stypendium dla „Sezonu Dokumentów”: Twórcy i twórcy treści w ramach sezonu Dokumentów Google wypłacają określoną kwotę pieniędzy tym twórcom, którzy ukończą swoje projekty, pod warunkiem, że chcą oni zaakceptować stypendium. Zapoznaj się z informacjami o stypendiach technicznych dla autorów. Stypendium jest opcjonalne. Jeśli nie chcesz otrzymać stypendium, poinformuj o tym w formularzu zgłoszeniowym.
Jak program Seasonal of Docs wykorzystuje informacje z formularza zgłoszeniowego
Ta sekcja podsumowuje, w jaki sposób aplikacja Seasonal of Docs wykorzystuje informacje z Twojego formularza zgłoszeniowego. We wcześniejszych sekcjach tej strony opisano szczegółowo najważniejsze pola.
Tabela zawiera najważniejsze pola. Dla każdego pola tabela wskazuje, czy sezon dokumentów:
- Przekazuje informacje organizacji open source określonej w formularzu zgłoszeniowym.
- Publikuje informacje z listy zaakceptowanych projektów dotyczących pisania technicznego na stronie Season of Docs.
| Informacje w formularzu | Udostępnione organizacji open source? | Wyświetlana na stronie Season of Docs? |
|---|---|---|
| Pełna nazwa | ||
| Wyświetlana nazwa | ||
| adres e-mail, | ||
| Najnowsze doświadczenia techniczne w zakresie pisania | ||
| Link do CV | ||
| Link do przykładów pracy | ||
| Co jeszcze chcesz dodać | ||
| Nazwa organizacji lub projektu open source | ||
| Nazwa i opis projektu dotyczącego pisania technicznego | ||
| Długotrwały lub o standardowej długości projekt | ||
| Akceptacja stypendium |
Znaczenie symboli używanych w powyższej tabeli:
| Symbol | Znaczenie symbolu |
|---|---|
| Tak | |
| Nie |
Uwagi
Oto kilka dodatkowych kwestii, o których warto pamiętać:
Przesyłanie wielu propozycji projektów: możesz przesłać więcej niż jedną propozycję projektu, ale w sezonie Dokumentów możesz przesłać tylko jedną propozycję projektu na autora projektu. Możesz przesłać tylko 1 formularz zgłoszeniowy. W formularzu możesz wpisać maksymalnie trzy propozycje projektów.
Łączna liczba projektów dotyczących pisania prac technicznych w programie: sezon Dokumentów jest dozwolony tylko w określonej maksymalnej liczbie projektów pisemnych. Zobacz, jak działa przydział przedziałów.
Powiązane przewodniki
Zapoznaj się ze wskazówkami dla mentorów na temat oceny propozycji tekstów technicznych. Zrozumienie kryteriów wyboru mentorów pomoże Ci opracować ofertę, która ma większe szanse na sukces.
Informacje proceduralne o tym, kiedy i jak przesłać zgłoszenie do programu Sezon Dokumentów, znajdziesz w przewodniku technicznym dla twórców.