Bieżący etap:
Program Sezon na dokumenty 2021 zakończył się 14 grudnia 2021 r. 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 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 zainteresowani współpracą 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.
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 i doświadczenie w pisaniu tekstów technicznych
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. Z tego punktu widzenia oceń wcześniejsze prace technicznego autora. Najważniejsze: czy rozumiesz, co napisała 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 tekst jest poprawnie napisany 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?