Obecny etap:
Program Sezon Dokumentów 2020 zakończył się 15 marca 2021 r. Zobacz oś czasu.
Ta strona zawiera wskazówki dla organizacji open source dotyczące oceny technicznych propozycji projektów dotyczących pisania i wybierania projektów, którymi chcą się zajmować w ramach programu Season of Docs.
Wstęp
Autorzy wiadomości o tematyce technicznej przesyłają propozycje dotyczące Sezonu Dokumentów do pracy nad projektem we współpracy z wybraną organizacją open source. Administratorzy programu Google przekazują oferty organizacjom open source do oceny i wyboru projektów. Szczegółowe informacje o czynnościach, które musisz wykonać, znajdziesz w przewodniku dla administratora organizacji.
Ocenianie propozycji twórców technicznych
Umiejętności i doświadczenie techniczne
Zapoznaj się z doświadczeniem autora tekstu technicznego. Propozycja autora tekstu technicznego zawiera informacje o najnowszym umiejętnościach technicznych w pisaniu. Najlepiej byłoby, gdyby kandydat miał doświadczenie w pisaniu dokumentacji technicznej dla branży oprogramowania. Jednym z celów Sezonu Dokumentów jest umożliwienie autorom tekstów technicznych zaangażowanie się w usługi przeznaczone dla programistów. Dlatego nie jest konieczne, aby autor miał doświadczenie z interfejsami API, pakietami SDK czy innymi platformami dla programistów, nawet jeśli projekt skupia się na odbiorcach.
Skup się na umiejętnościach językowych i komunikacyjnych. Z tego punktu widzenia należy ocenić propozycję autora technicznego. Najważniejsze: czy potrafisz zrozumieć, co napisała ta osoba? Jako mentor będziesz pomagać autorowi technicznemu w zakresie procesów, narzędzi i kodu open source. Nie musisz też analizować treści powstałej dokumentacji. Jeśli chcesz dokładnie sprawdzić język oferty, zwróć uwagę na spójność w treściach, interpunkcji i sformułowaniach, oraz o poprawną pisownię i jasny język. Czy sformułowanie jest proste, czy skomplikowane? Czy zdania są krótkie czy wciąż trwają, aż staną się trudne do zrozumienia?
Zwróć uwagę na projekt i układ dokumentów. Autor projektu może przedstawić przykłady opracowanej przez siebie dokumentacji. Sprawdź ogólny układ przykładowych dokumentów. Czy projekt jest logiczny? Czy łatwo jest poruszać się po dokumencie lub zbiorze dokumentacji? Czy występują powielone treści, czy jakieś luki?
Oferta pakietowa
Sprawdź, czy oferta pakietowa spełnia Twoje wymagania. Czy propozycja jest zgodna z pomysłami na projekt, który przesłałeś na tegoroczny sezon dokumentów? Jeśli autor techniczny zaproponował nową koncepcję, sprawdź, czy odpowiada ona potrzebom Twojego projektu open source i czy masz odpowiednie osoby, które pomogą autorowi technicznemu w osiągnięciu celów projektu.
Postaw na entuzjazm i dokładność. Czy oferta świadczy o tym, że autor tekstu jest zadowolony z projektu? Zastanów się, czy uczestnicy wzięli udział w ofercie i skonsultowali się z Twoją organizacją na etapie eksploracji, czy też podzielili się własnymi przemyśleniami na temat realizacji celów projektu.
Najczęstsze pytania
Jak określamy liczbę projektów do przesłania?
Skup się na jednym lub dwóch projektach. Jeśli Twoja organizacja ma więcej możliwości mentoringu, możesz przesłać więcej zgłoszeń. W przypadku każdego projektu dla twórców technicznych potrzebujesz co najmniej 1 mentora (najlepiej dwóch), który wspiera tylko ten projekt.
Przeczytaj informacje na temat przydzielania przedziałów w sezonie Dokumentów.
Jak wybieramy, która propozycja tekstu technicznego zostanie zaakceptowana?
Pamiętaj, aby wybrać najlepsze oferty dotyczące scenariuszy technicznych. Wybierz oferty, które najlepiej odpowiadają Twoim wymaganiom i są zgodne z powyższymi wytycznymi dotyczącymi oceny.