Aktualna faza:
opublikowano studia przypadków. Zobacz oś czasu.
Ta strona zawiera wskazówki dla organizacji open source dotyczące oceny i wyboru odpowiedniego copywritera technicznego do stworzenia projektu w ramach Google Season of Docs.
Wprowadzenie
Organizacje typu open source muszą zatrudnić osobę zajmującą się pisaniem technicznym, która będzie pracować nad proponowanym projektem. Organizacje muszą zatrudnić własne osoby do pisania treści technicznych. Pisarze techniczni, którzy chcą współpracować z organizacjami uczestniczącymi w Google Season of Docs, mogą znaleźć się w repozytorium Google Season of Docs na GitHubie oraz na kanale #season-of-docs w Slacku Write the Docs.
Rozpoczynanie procesu
Zalecamy, aby zacząć szukać copywritera technicznego, gdy tylko zaczniesz rozważać udział w Google Season of Docs.
Ocena copywritera
Zalecamy, aby poprosić o przykłady wcześniej opracowanej dokumentacji od autorów technicznych, których rozważasz, aby móc ocenić ich umiejętności i doświadczenie w zakresie pisania tekstów technicznych.
Umiejętności i doświadczenie w pisaniu tekstów technicznych
Sprawdź wcześniejsze doświadczenie technicznego autora. Idealnie, jeśli ma on doświadczenie w pisaniu dokumentacji technicznej dla branży oprogramowania. Jednym z celów Google Season of Docs jest umożliwienie autorom technicznym zaangażowania się w usługi przeznaczone dla programistów. Dlatego nie jest konieczne, aby miał on doświadczenie z interfejsami API, pakietami SDK ani innymi platformami dla deweloperów, nawet jeśli Twój projekt jest skierowany do tej grupy odbiorców.
Skup się na umiejętnościach językowych i umiejętnościach komunikacyjnych. Z tego punktu widzenia oceń wcześniejsze prace technicznego autora. Najważniejsze: czy rozumiesz, co napisała ta osoba? Jeśli chcesz przeprowadzić dogłębną analizę języka użytego przez autora treści technicznych, sprawdź, czy interpunkcja i formułowania są spójne, a język jest poprawny i zrozumiały. Czy sformułowanie jest proste czy skomplikowane? Czy zdania są krótkie, czy też są długie i trudne do zrozumienia?
Zwróć uwagę na projekt i układ dokumentu. Sprawdź ogólny układ przykładowych dokumentów. Czy projekt jest logiczny? Czy łatwo Ci się poruszać po dokumencie lub zestawie dokumentacji? Czy występują duplikaty treści lub widoczne luki?
Zatrudnianie pisarza technicznego
Organizacje muszą zatrudnić copywritera i wypełnić formularz „Proof of Technical Writer Hiring” (potwierdzający zatrudnienie copywritera), do którego link znajduje się poniżej, do 22 maja 2024 r., do godziny 18:00 czasu uniwersalnego.
Etap zatrudniania copywritera zakończony.
Przed zatrudnieniem należy omówić z nim wynagrodzenie i harmonogram płatności. Zalecamy, aby organizacje ustalały z copywriterami harmonogram płatności na podstawie etapów projektu, w tym płatności na etapie rozpoczęcia projektu. Pamiętaj o datach płatności, które będą miały miejsce tylko 2 razy w ramach programu, oraz o kwotach podczas tworzenia harmonogramu płatności.
Uwaga: organizacje, które nie zatrudniły specjalisty ds. dokumentacji technicznej i nie przesłały formularza potwierdzenia zatrudnienia do 22 maja 2024 r. do godz. 18:00 czasu uniwersalnego, nie otrzymają środków w pierwszym terminie wypłaty.