Przejdź do głównej zawartości

Projekty open source dla technical writerów

· 5 min aby przeczytać
Agnieszka Gaworska
Agnieszka Gaworska

Dziś temat, który może zainteresować początkujących technical writerów. Zapraszamy!

Jeśli dopiero zaczynasz swoją karierę jako technical writer, prawdopodobnie zastanawiasz się od czego rozpocząć zdobywanie doświadczenia, jak zacząć budowanie swojego portfolio, czym zainteresować potencjalnego pracodawcę, i która z ofert będzie dla Ciebie tą najlepszą. Tym, co może pomóc, jest udział w projektach open source.

Co to jest projekt open source?​

Jest to projekt udostępniony w ramach jednej z otwartych licencji, którego kod źródłowy jest otwarty i powszechnie dostępny. Z tego kodu każdy może korzystać, dowolnie go modyfikować, badać, rozpowszechniać itp. W zależności od typu licencji, bywa możliwe stworzenie komercyjnego produktu na jego bazie. Nad największymi projektami open source często pracują setki (a nawet tysiące) ochotników z całego świata.

Jednym z głównych problemów tego typu projektów jest to, że ich dokumentacja bywa traktowana po macoszemu - często jej po prostu nie ma albo zwyczajnie wymaga aktualizacji lub ulepszenia. A jeśli osoby zainteresowane nie znajdą użytecznej dokumentacji, często rezygnują z korzystania z produktu, ponieważ nie rozumieją, jak należy go używać.

I tu pojawia się szansa dla technical writerów, którzy chcąc pomóc w ulepszeniu dokumentacji projektów open source mogą jednocześnie zdobyć spore doświadczenie i kontakty zawodowe.

Co zyskasz uczestnicząc w projekcie open-source?​

Projekty tego typu zrzeszają wokół siebie ludzi o różnym poziomie wiedzy i doświadczenia. Spora ich część bierze w nich udział w ramach wolontariatu lub hobbystycznie. Tak więc, będąc częścią takiego projektu często nie otrzymasz zapłaty. Możesz jednak czerpać inne korzyści:

  • zdobędziesz doświadczenie i poprawisz swoje umiejętności pisania - tego potrzebujesz na początku swojej kariery. Niektóre otwarte projekty spokojnie mogą konkurować z dużymi, komercyjnymi przedsięwzięciami, więc zaangażowanie się w nie dobrze przygotowuje do późniejszej pracy.
  • Stworzysz własne portfolio - aktywność w jednym lub kilku projektach open source to świetny sposób na uzupełnienie rubryki “doświadczenie” w Twoim CV w sytuacji, gdy dopiero zaczynasz swą przygodę z dokumentacją techniczną. Również na późniejszym etapie kariery dobrze jest wspierać otwarte oprogramowanie - wiele firm patrzy na to przychylnie.
  • Rozszerzysz swoją sieć kontaktów i podniesiesz umiejętności - z pewnością poznasz profesjonalistów, którzy mogą udzielić Ci wskazówek, jak pisać wysokiej jakości dokumentację. Co więcej, w bardziej aktywnych projektach każda Twoja zmiana będzie skrupulatnie sprawdzona merytorycznie i językowo przez międzynarodową społeczność, a wszelkie błędy zostaną zauważone. Choć czasem może to działać jak kubeł zimnej wody wylany na głowę, nic tak nie podnosi umiejętności jak konstruktywna krytyka. Może się też okazać, że osoby zaangażowane w projekt i równocześnie pracujące w jakiejś firmie pomogą Ci znaleźć satysfakcjonującą pracę.
  • Otrzymasz rekomendacje - jeśli ubiegasz się o pracę, z pewnością pomoże Ci mocny list polecający od opiekuna projektu.
  • Nauczysz się współpracować z innymi - to bardzo przydatna umiejętność dla początkującego (i nie tylko) technical writera.

Jak wybrać projekt open source i jak zacząć w nim współtworzyć?​

Obecnie jest tak wiele projektów open source, że samo poznanie i zrozumienie nawet niewielkiej ich części może zająć mnóstwo czasu.. Bez względu na poziom umiejętności, powinieneś/powinnaś znaleźć dla siebie odpowiedni projekt.

Poniżej kilka przykładów dużych projektów, skoncentrowanych na dokumentacji:

Oczywiście projektów jest znacznie więcej. Od Ciebie zależy, który z nich wybierzesz. Dobrze, by dany projekt pokrywał się z Twoimi zainteresowaniami. Ułatwi to pracę i podniesie motywację. Spróbuj dołączyć do projektu, z którego sam/a korzystasz. Sprawdź co masz zainstalowane na komputerze, gdyż jest spora szansa, że regularnie używasz czegoś, co powstało jako projekt otwarty. Łatwiej będzie Ci pisać o oprogramowaniu, którego jesteś aktywnym użytkownikiem.

Po wybraniu projektu najczęściej wystarczy znaleźć problem do rozwiązania i powiadomić kierowników, że chciałbyś/chciałabyś rozpocząć współpracę. Zazwyczaj strona domowa projektu (lub plik README w głównym repozytorium) zawiera sekcję dla zainteresowanych udziałem, opisującą krok po kroku co dalej. Niektóre projekty mają wykaz istniejących problemów, inne nie. Możesz przejrzeć dokumentację i dowiedzieć się, co można poprawić. Nie zapomnij zapoznać się z wytycznymi dotyczącymi procesu recenzji zanim spróbujesz wykonać swój pierwszy merge.

Gdy już wiesz co napisać, możesz w procesie twórczym skorzystać ze specjalnych narzędzi dedykowanych twórcom dokumentacji dla projektów open source. Możesz użyć na przykład narzędzia rst2pdf do tworzenia dokumentów w formacie PDF. Postępuj zgodnie ze wskazówkami (na przykład dotyczącymi stylu), a gdy masz wątpliwości, skonsultuj się ze społecznością. Aktywność w projekcie ma duże znaczenie. Pamiętaj, aby odpowiadać na komentarze i staraj się korzystać z rad innych uczestników.

Open-source z roku na rok zyskuje coraz większą popularność. To dobra okazja, aby wnieść swój wkład w projekt na dużą skalę. W wielu projektach udzielają się wysokiej klasy eksperci, na co dzień pracujący w najbardziej znanych firmach z branży technologicznej. WIelu z nich nie ogranicza się tylko do jednego zespołu, więc czasem może się zdarzyć, że zasugerują Ci, gdzie jeszcze Twoje umiejętności mogą się przydać. Jeśli jesteś początkującym pisarzem technicznym to tego rodzaju współpraca będzie dobrym pomysłem na rozwinięcie skrzydeł w branży.

Ciekawe, czy ktoś z Was korzystał z tej opcji na start? Czekamy na Wasze opinie w komentarzach.