Tworzenie interesującego użytkownika

Obecny etap:
opracowywanie dokumentacji. Sprawdź oś czasu.

W ramach programu „Sezon Dokumentów Google” organizacje bezpośrednio współpracują z autorami dokumentacji technicznej, aby tworzyć, ulepszać i aktualizować dokumentację. Organizacje bezpośrednio wybierają twórców technicznych. Autorzy techniczni zainteresowani współpracą z organizacjami powinni przesłać oświadczenie o zainteresowaniu, korzystając z kanału wskazanego na stronie oferty organizacji.

Oświadczenie o zainteresowaniu powinno zawierać dane kontaktowe, informacje o technicznych doświadczeniach związanych z pisaniem tekstów oraz omówienie prac, jakie podejmujesz w ramach współpracy z organizacją. Powinien też podkreślać, że spełniasz określone wymagania organizacji dotyczące autorów tekstu technicznego. Uważnie przeczytaj stronę pomysłów na projekty organizacji, aby mieć pewność, że zostały podane wszystkie wymagane informacje.

Ten szablon pomoże Ci utworzyć własne oświadczenie.

Dane osobowe

  • Podaj swoje imię i nazwisko oraz adres e-mail. Jeśli nie chcesz, by Twoje imię i nazwisko były uwzględniane w publicznych raportach końcowych studium przypadku, uwzględnij to w swojej ofercie i podaj nazwę użytkownika.

Informacje służbowe

  • Link do publicznie dostępnego portfolio próbek tekstów lub pojedyncze linki do przykładów Twoich utworów.
  • Przegląd swoich ostatnich doświadczeń z zakresu pisania technicznego: opisz swoje ostatnie stanowiska związane z pisaniem technicznym lub doświadczeniem zawodowym. Jeśli korzystasz z dokumentacji open source, podaj ją również tutaj. Podsumuj swoją rolę, obowiązki na tym stanowisku i wykonaną pracę. W odpowiednich przypadkach podaj daty.
  • link do CV.
  • Jeśli organizacja określiła określone wymagania dla projektu, napisz jedno lub dwa zdania opisujące sposób ich spełniania, na przykład: „Miałem(-am) udział w ponad 6 poprawkach w dokumentach technicznych i wprowadziłem 3 poprawki w dokumentach dla mojego zespołu w XYZ Industries w 2018, 2019 i 2020 roku”.
  • (Opcjonalnie) Inne informacje, które chcesz dodać. Może to być na przykład zainteresowanie dokumentacją techniczną, uzasadnienie, dlaczego chcesz korzystać z sezonu Dokumentów Google, lub inne ważne doświadczenie.

Instrukcja dotycząca projektu

  • Nazwa projektu. Jeśli na stronie projektu organizacji jest kilka możliwych projektów, sprawdź, czy wybrany tytuł odzwierciedla projekt, nad którym chcesz pracować. Jeśli przesyłasz oświadczenie o zainteresowaniu do organizacji, która nie określiła jeszcze możliwych projektów, tytuł powinien zawierać podsumowanie proponowanych prac. Na przykład „Tworzenie dokumentacji interfejsu Interactive ProjectX API” to lepszy tytuł niż „Dokumentacja projektu ProjectX”.
  • Szczegółowy opis.
    • Opisz swoje podejście do projektu wskazanego przez organizację na stronie propozycji projektu.
    • Powiedz, jak Twoja propozycja pomoże rozwiązać problem lub osiągnąć cel określony na stronie propozycji projektu przez organizację.
    • Dołącz podsumowanie wszystkich rozmów na temat projektu, które toczyły się z członkami organizacji.
    • Zwróć uwagę na język i styl swojej oferty. Organizacja open source może użyć ich jako czynnika podczas oceny oferty.
  • Proponowany harmonogram
    • Przedstaw ogólny zarys harmonogramu i faz projektu. Możesz np. przeznaczyć dwa tygodnie na zebranie informacji, 4 tygodnie na pisanie, 2 tygodnie na sprawdzenie i zmiany i tydzień na publikację.
    • Wyraźnie określ oczekiwania dotyczące uczestnictwa i opinie od uczestników projektu. Możesz na przykład stwierdzać, że oś czasu zależy od otrzymania odpowiedzi na zapytania w ciągu 3 dni.
  • Proponowany budżet
    • Zalecamy, aby pisarze techniczni proponowali budżet na cały projekt zamiast stawki godzinowej.
    • W miarę możliwości podaj opcje dotyczące ograniczonego lub większego zakresu. Możesz np. podać różne opcje budżetowe, aby dokumentować instrukcje wdrażania dla 2, 4 lub 6 platform.