Wybór pisarza technicznego

Obecna faza:
ogłoszono wyniki. Zobacz oś czasu.

Ta strona zawiera wskazówki dla organizacji open source dotyczące oceny i wyboru odpowiedniego copywritera technicznego do 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.

Rozpoczęcie 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 kandydatów, których rozważasz, aby móc skupić się na ocenie ich umiejętności i doświadczenia w zakresie pisania tekstów technicznych.

Umiejętności techniczne i doświadczenie w zakresie pisania

  • Sprawdź, jakie doświadczenie ma autor tekstów technicznych. Idealnie, gdyby autor miał już 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 produkty przeznaczone dla programistów. Dlatego nie jest konieczne, aby copywriter miał doświadczenie z interfejsami API, pakietami SDK ani innymi platformami dla deweloperów, nawet jeśli Twój projekt jest skierowany do deweloperów.

  • Skup się na umiejętnościach językowych i komunikacyjnych. Przeanalizuj wcześniejszą pracę pisarza technicznego z tego punktu widzenia. Najważniejsze: czy rozumiesz, co napisała osoba? Jeśli chcesz dokładnie przeanalizować język swojej pracy, zadbaj o spójność w interpunkcji i sformułowaniu, poprawną pisownię oraz zrozumiały język. Czy sformułowanie jest proste czy skomplikowane? Czy zdania są krótkie, czy też ciągną się do czasu, aż trudno je zrozumieć?

  • Zwróć uwagę na projekt i układ dokumentu. Sprawdź ogólny układ przykładowych dokumentów. Czy projekt jest logiczny? Czy łatwo jest się poruszać po zbiorze dokumentów lub dokumentacji? Czy występują duplikaty treści lub widoczne luki?

Zatrudnienie dziennikarza technicznego

Organizacje muszą zatrudnić pisarza technicznego i wypełnić formularz zatrudnienia pisarza technicznego, do którego link znajduje się poniżej do 10 maja 2023 r. do godz. 18:00 czasu UTC.

Etap zatrudniania copywritera zakończony.

Przed zatrudnieniem należy omówić z nim wynagrodzenieharmonogram płatności. Zalecamy organizacjom utworzenie harmonogramu płatności z twórcami treści technicznych na podstawie etapów projektu, w tym płatności na początku projektu. Pamiętaj o datach płatności, które nastąpią tylko 2 razy w trakcie trwania programu, oraz o kwotach przy tworzeniu harmonogramu płatności.

Uwaga: organizacje, które nie zatrudniły specjalisty ds. dokumentacji technicznej i nie przesłały formularza potwierdzenia zatrudnienia do 10 maja 2023 r. do godziny 18:00 czasu UTC, nie otrzymają środków w pierwszym terminie wypłaty.