Obecny etap:
Program Sezon Dokumentów 2021 zakończył się 14 grudnia 2021 r. Sprawdź oś czasu.
W programie Sezon Dokumentów 2021 organizacje bezpośrednio współpracują z twórcami technicznymi w celu tworzenia, ulepszania i aktualizowania dokumentacji. Organizacje bezpośrednio wybierają specjalistów ds. technicznych. Autorzy techniczni zainteresowani współpracą z organizacjami powinni przesłać oświadczenie o zainteresowaniu, korzystając z kanału podanego na stronie oferty organizacji.
Oświadczenie powinno zawierać Twoje dane kontaktowe, informacje o technicznych doświadczeniach w pisaniu prac oraz zarys pracy wykonywanej w Twojej organizacji. W jego opisie powinny też znaleźć się informacje o tym, że spełniasz specyficzne wymagania organizacji dla autorów tekstu o tematyce technicznej. 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 pojawiło się w publicznych końcowych raportach studium przypadku, pamiętaj o uwzględnieniu w swojej ofercie nazwy 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 pewne wymagania dla projektu, napisz jedno lub dwa zdania opisujące sposób ich spełniania, np. „Miałem(-am) udział w ponad 6 poprawkach jako autor dokumentów technicznych i w latach 2018, 2019 i 2020 udało mi się wprowadzić dla mojego zespołu 3 poprawki związane z dokumentami w firmie XYZ Industries”.
- (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, 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 przez organizację na stronie propozycji projektu.
- 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 na przykład podać różne opcje budżetowe na dokumentowanie instrukcji wdrażania dla 2, 4 lub 6 platform.