Obecny etap:
Program Sezon Dokumentów 2019 zakończył się 6 marca 2020 r. Zobacz oś czasu.
Ta strona zawiera przewodnik dla pisarzy technicznych, którzy biorą udział w Sezonie Dokumentów.
Wstęp
Sezon Dokumentów – witamy! Ten przewodnik zawiera informacje o Twoim uczestnictwie w programie Season of Docs i zawiera informacje o działaniach, które należy wykonać na każdej z jego faz.
Kryteria kwalifikacji do korzystania z sezonu Dokumentów
Aby wziąć udział w tym programie jako autor treści technicznych, musisz:
- mieć ukończone 18 lat w chwili rejestracji;
- Umiejętność wykazania się doświadczeniem technicznym w pisaniu prac, przesyłając opis stanowiska i przykłady prac.
- Kwalifikuje się do pracy w kraju zamieszkania w trakcie trwania programu.
- Mieszkaniec kraju, który nie jest obecnie objęty embargiem przez Stany Zjednoczone. Więcej informacji znajdziesz w artykule o programach sankcji i informacjach o krajach wydanych przez Skarb Stanów Zjednoczonych.
Przeczytaj pełne warunki techniczne dla autorów.
Twoi mentorzy open source
Doradcy w tym sezonie nie muszą być redaktorami technicznymi i mogą mieć niewielkie doświadczenie w komunikacji technicznej. Osoby te należą do organizacji open source, którzy znają wartość dobrej dokumentacji oraz mają doświadczenie w obsłudze procesów i narzędzi open source.
Relacja między Tobą a mentorami to współpraca. Wnosisz doświadczenie i umiejętności z zakresu dokumentacji w organizacji open source. Twoi mentorzy przekazują swoją wiedzę na temat oprogramowania open source i kodu. Wspólnie możecie opracowywać dokumentację techniczną i ulepszać procesy związane z projektem open source.
Etapy ogłoszenia programu i zgłoszenia organizacji
Data ogłoszenia sezonu Dokumentów to 11 marca 2019 r. Zainteresowane organizacje open source mogą zgłosić się do udziału w sezonie Dokumentów między 2 kwietnia 2019 r. a 23 kwietnia 2019 r. Administratorzy programu Google publikują listę organizacji odnoszących sukcesy 30 kwietnia 2019 r.
W okresie między ogłoszeniem programu a publikacją uczestniczących w nim organizacji open source należy śledzić informacje na ten temat. Możesz wrócić na tę stronę, a także obserwować posty na blogu i inne wiadomości w sieci. Niektóre organizacje open source mogą dzielić się swoimi pomysłami nawet na etapie składania zgłoszeń.
Zachęcamy też do podzielenia się z Tobą informacjami o tym programie i o tym, dlaczego interesuje Cię ten program. Zapoznaj się z materiałami promocyjnymi, w których można znaleźć grafikę i pomysły.
Etap eksploracji scenarzystów technicznych
Eksploracja scenariuszy technicznych trwa od 30 kwietnia do 28 maja 2019 r. W tym czasie możesz zapoznać się z listą organizacji uczestniczących w programie i ich pomysłami na projekty.
Gdy znajdziesz co najmniej 1 projekt, który Cię interesuje, skontaktuj się bezpośrednio z odpowiednią organizacją open source, aby omówić pomysły na projekt.
Twoje zadania jako redaktora technicznego na tym etapie | |
---|---|
Zapoznaj się z listą organizacji open source uczestniczących w programie i ich pomysłami na projekty. |
Przejrzyj listę, by znaleźć organizację open source, z którą chcesz współpracować. Zapoznaj się z projektami tekstów technicznych zaproponowanych przez organizacje, i zdecyduj, które z nich najbardziej Ci odpowiadają. Możesz zgłosić się do więcej niż jednej organizacji. Na tym etapie tworzenia sezonów dokumentów dobrze jest sprawdzić więcej niż 1 opcję. Ostateczny proces selekcji obejmuje tylko 1 projekt na autora tekstu technicznego. |
Omów pomysły na projekty z organizacjami open source. |
Pomysły na projekty możesz omawiać z dowolną organizacją uczestniczącą w programie. Aby się skontaktować, użyj adresu e-mail organizacji znajdującego się na liście organizacji uczestniczących w programie. Dzięki wstępnym dyskusjam możesz przygotować dobrą propozycję projektu, którą możesz przesłać do administratorów programu Google na etapie zgłoszeń do zespołu technicznego. Pomysły na projekt mogą pochodzić z listy pomysłów zaproponowanej przez organizację. Możesz też zaproponować własne pomysły. |
Etap przesyłania zgłoszenia technicznego
Etap zgłaszania się do pomocy technicznej trwa od 29 maja do 28 czerwca 2019 r. W tym czasie możesz zgłosić się do wzięcia udziału w tym sezonie. Administratorzy programu Google przekazują odpowiednie szczegóły z Twojej aplikacji do wybranej organizacji open source. Administratorzy organizacji open source i mentorzy wybierają projekty, które chcą przekazać.
Twoje zadania jako autora zgłoszenia technicznego na tym etapie | |
---|---|
Prześlij zgłoszenie, aby wziąć udział w sezonie dokumentów. |
Prześlij zgłoszenie do programu Sezon Dokumentów przed 28 czerwca 2019 r. Nie przyjmujemy już zgłoszeń do edycji zgłoszeń technicznych dotyczących sezonu 2019 Dokumentów Google. |
Etap budowania więzi ze społecznością
Etap budowania więzi ze społecznością trwa od 7 sierpnia do 1 września 2019 roku. W tym czasie mentorzy open source pomogą Ci zapoznać się z projektem i społecznością open source.
Twoje zadania jako redaktora technicznego na tym etapie | |
---|---|
Skonfiguruj kanały komunikacji. |
Skontaktuj się z mentorami z organizacji open source, z którą chcesz współpracować. Zadbaj o to, by mieć niezawodny sposób bezpośredniego komunikowania się z mentorem i administratorami organizacji – ci ci są członkami organizacji open source, którzy pełnią w swojej organizacji rolę głównego kontaktu ds. sezonu w Dokumentach. Przewodnik dla mentorów po współpracy z twórcami treści technicznych |
Zaangażuj się w projekt open source i społeczność. |
Zapytaj mentora o narzędzia i procesy, z których korzysta organizacja open source. Przedstaw się na listach adresowych, na czacie, na Slacku i w innych udostępnianych kanałach komunikacyjnych społeczności open source. |
Poznaj usługę jako całość. |
Poproś mentora o wyjaśnienie (zwłaszcza koncepcyjnego), który chcesz udokumentować. Omów szczegółowo odbiorców dokumentacji. |
Ustal cele i oczekiwania. |
Wspólnie z mentorem uzgodnijcie cele technicznego projektu pisania i określcie oczekiwania po obu stronach. Ustalenie tych celów i oczekiwań już teraz to dobry sposób na zapewnienie powodzenia projektu. |
Faza tworzenia dokumentu
Faza tworzenia dokumentów trwa od 2 września 2019 r. do 22 listopada 2019 roku. (Data zakończenia jest inna w przypadku długo trwających projektów). W tym czasie możesz pracować nad projektem pod ścisłym konsultacjami z mentorami.
Twoje zadania jako redaktora technicznego na tym etapie | |
---|---|
Zrób to z pomocą mentora. |
Ściśle współpracuj z mentorem, aby ukończyć projekt. Postępuj zgodnie z procedurami społeczności open source, aby poprosić o sprawdzenie wynikowej dokumentacji i przesłać aktualizacje do repozytorium open source. Na przykład w przypadku projektów open source hostowanych na GitHubie możesz dodawać lub aktualizować pliki, tworząc żądanie pull do sprawdzenia i przesłania. |
Poinformuj administratora organizacji o wszelkich wątpliwościach. |
Jeśli masz wątpliwości związane z komunikacją z mentorami lub napotkasz inne problemy, które mogą wpłynąć na pomyślne ukończenie projektu, powiadom o tym administratora organizacji open source. |
Wypełnij dowolne ankiety od administratorów programu Google. |
Administratorzy programu Google mogą wysłać w trakcie projektu ankietę, aby ocenić postępy. Wypełnij ankietę i prześlij odpowiedzi do administratorów programu Google zgodnie z instrukcjami w dokumencie z ankietą. |
Etap finalizacji i oceny projektu
Etap finalizacji projektu trwa od 25 do 29 listopada 2019 r., a etap oceny trwa od 25 listopada do 6 grudnia 2019 r. (daty są inne w przypadku długotrwałych projektów). W okresie finalizacji projektu przesyłasz raport z jego projektu, tzw. ostateczne produkty robocze. Na etapie oceny przesyłasz ocenę mentorów i swoje doświadczenia jako uczestnik sezonu Dokumentów.
Twoje zadania jako redaktora technicznego na tym etapie | |
---|---|
Napisz raport z projektu. |
Napisz raport z projektu (nazywany czasem usługą roboczą). Raport z projektu zawiera opis pracy wykonanej w tym czasie i wszelkie istotne linki. Tworzenie raportu dotyczącego projektu Etap finalizacji projektu Sezon Dokumenty 2019 już się zakończył. |
Poproś mentora o przejrzenie raportu z projektu. |
Twój mentor może mieć cenne wskazówki, jak opisać swoje osiągnięcia. Na tym etapie przydatne jest też poznanie ogólnego stanu projektu, jeszcze zanim mentor oceni projekt jako ukończony lub nie. |
Sfinalizuj raport dotyczący projektu. |
Finalizować raport z projektu do 28 lutego 2020 r., do godziny 18:00 czasu UTC. Formularz można edytować, ale musisz przesłać ostateczną wersję przed określoną datą. Etap finalizacji projektu Sezon Dokumenty 2019 już się zakończył. |
Napisz i prześlij ocenę swojego mentora oraz swoją opinię na temat Sezonu dokumentów. |
Przejdź i prześlij swoją ocenę do 28 lutego 2020 r. do godz. 18:00 czasu UTC. Oceny autorów tekstów technicznych Etap finalizacji projektu Sezon Dokumenty 2019 już się zakończył. |
Długotrwałe projekty
W przypadku standardowych projektów pisania technicznego w sezonie Dokumentów etap tworzenia dokumentów trwa od 2 września 2019 r. do 22 listopada 2019 r. Niektórzy dziennikarze zajmujący się kwestiami technicznymi mogą ubiegać się o długotrwały projekt po konsultacji z organizacją open source. W przypadku długotrwałego projektu etap tworzenia dokumentów trwa od 2 września 2019 r. do 21 lutego 2020 roku.
Okres finalizacji i oceny długo trwających projektów to 24–28 lutego 2020 r.
Twoje zadania i obowiązki są takie same jak opisane na tej stronie w przypadku standardowych projektów pisania technicznego, z tym że daty zakończenia i oceny projektu przypadają później.
Powiązane artykuły
- Zobacz oś czasu sezonu Dokumentów.
- Dowiedz się więcej o swojej relacji z wybraną organizacją open source z informacjami o obowiązkach administratora organizacji i mentora oraz ze wskazówkami dotyczącymi współpracy z twórcami treści technicznych.