Obecny etap:
Ogłoszenie wyników Oś czasu.
W ramach programu Sezon Dokumentów organizacje współpracują bezpośrednio z twórcami treści technicznych, aby tworzyć, ulepszać i aktualizować dokumentację. Organizacje bezpośrednio wybierają autorów tekstów technicznych. Autorzy techniczni zainteresowani współpracą z organizacjami powinni przesłać odpowiednie oświadczenie, korzystając z kanału podanego na stronie z propozycją organizacji.
W takim zgłoszeniu należy podać swoje dane kontaktowe, informacje dotyczące technicznych aspektów pisania prac, a także opis współpracy z tą organizacją. Trzeba w nim też podkreślić, że spełniasz szczególne wymagania, które musi spełniać organizacja w przypadku autorów tekstów technicznych. Dokładnie zapoznaj się ze stroną z pomysłami na projekty danej organizacji, aby upewnić się, że zostały w niej uwzględnione 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, aby Twoje imię i nazwisko pojawiło się w publicznych ostatecznych raportach studium przypadku, zaznacz to w ofercie pakietowej i podaj nazwę użytkownika.
Informacje służbowe
- Link do publicznie dostępnego portfolio przykładowych tekstów lub pojedynczych linków do przykładów Twoich prac.
- Przegląd swoich ostatnich doświadczeń z zakresu pisania technicznego: wymień swoje ostatnie stanowiska w pisaniu tekstów technicznych lub doświadczenie zawodowe. Jeśli korzystasz z dokumentacji open source, również ją umieść. 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 pewne wymagania związane z projektem, zawrzyj w jednym lub dwóch zdaniach opisujących, w jaki sposób je spełniasz, np. „W 2018, 2019 i 2020 roku przeprowadziłem 3 wprowadzone przeze mnie poprawki w dokumentach w firmie XYZ Industries”.
- (Opcjonalnie) Wszelkie inne informacje, które chcesz dodać. Może to być na przykład zainteresowanie dokumentacją techniczną, powodem, dla którego chcesz wziąć udział w programie Sezon Dokumentów, lub inne ważne doświadczenie.
Instrukcja dotycząca projektu
- Nazwa projektu. Jeśli na stronie projektu organizacji znajduje się kilka możliwych projektów, sprawdź, czy wybrany tytuł odpowiada temu, nad którym chcesz pracować. Jeśli przesyłasz zgłoszenie zainteresowania do organizacji, która nie określiła jeszcze możliwych projektów, tytuł powinien zawierać podsumowanie proponowanej pracy. Na przykład „Tworzenie dokumentacji interfejsu API ProjectX” 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 z propozycją projektu.
- Dołącz podsumowanie wszystkich dyskusji, które prowadzisz z członkami organizacji na temat projektu.
- Zwróć uwagę na język i styl swojej oferty. Organizacje open source mogą wykorzystać te informacje przy ocenie oferty.
- Proponowany harmonogram
- Przedstaw ogólny harmonogram i fazy projektu. Możesz np. zaplanować 2 tygodnie na zebranie informacji, 4 tygodnie na ich pisanie, 2 tygodnie na sprawdzenie i wprowadzenie zmian oraz tydzień na publikację.
- Wyraźnie określ oczekiwania dotyczące uczestnictwa i opinii uczestników projektu. Możesz np. poinformować, że Twój harmonogram zależy od liczby odpowiedzi na zapytania w ciągu 3 dni.
- Proponowany budżet
- Zalecamy, aby pisarze ds. technicznych proponowali budżet na cały projekt, a nie stawkę godzinową.
- Jeśli to możliwe, podaj opcje ograniczonego lub większego zakresu. Możesz na przykład podać różne opcje budżetu na potrzeby dokumentowania instrukcji wdrażania dotyczących dwóch, 4 lub 6 platform.