Obecna faza:
ogłoszono wyniki. Zobacz oś czasu.
Oto kilka wskazówek, które pomogą organizacjom open source skutecznie współpracować z twórcami treści technicznych.
Przedstaw pisarza technicznego światu open source i swojej społeczności
- Zaprezentuj autorowi technicznemu swoją społeczność. Gdzie można zadawać pytania? Na jakich stałych spotkaniach powinni uczestniczyć lub do jakich list mailingowych powinni dołączyć? Jakich kont potrzebują (Github, Discord, Slack)? Upewnij się, że rozumieją zasady projektu i wiedzą, jak zgłaszać wszelkie problemy. Upewnij się, że osoba odpowiedzialna za pisanie techniczne rozumie licencję projektu i spełnia wymagania innych pracodawców dotyczące podpisywania umów CLA, CDA lub innych umów.
- Jeśli to możliwe, zapoznaj je z kilkoma osobami z pokrywających się stref czasowych, które mogą szybko odpowiadać na pytania dotyczące społeczności lub projektu.
- Jeśli możesz, wyślij mu gadżety związane z projektem.
Pomaganie autorowi technicznemu w korzystaniu z narzędzi i procesów związanych z wnoszeniem poprawek do projektu
- Jeśli procesy nie są dobrze udokumentowane, umów się z autorem technicznym na przeprowadzenie go przez pierwszy wkład, problem lub prośbę o wciągnięcie. Których szablonów lub tagów powinni używać? Kto powinien sprawdzić ich wkład i jak i kiedy powinien to zrobić? Jak można przetestować to rozwiązanie, jeśli jego praca zawiera przykłady kodu? Co muszą wiedzieć o procesie CI/CD lub wersjach?
Pomóc autorowi dokumentacji technicznej w zrozumieniu projektu i jego użytkowników
- Opisz projekt szczegółowo, aby autor tekstów technicznych miał jasne pojęcie o koncepcji produktu. Dzięki temu autor tekstów technicznych może czuć się pewniej i wydawać się bardziej kompetentny w swojej pracy nad projektem.
- Opisz potrzeby osób, które będą korzystać z projektu. Podaj jak najwięcej szczegółów – nie tylko „programistów”, ale też „programistów tworzących strony internetowe” i „programistów tworzących roboty przemysłowe”.
- Połącz autora technicznego z odpowiednimi ekspertami w danym temacie. Oznacza to deweloperów lub innych współtwórców projektu odpowiedzialnych za aspekty projektu, które będą objęte dokumentacją.
- Upewnij się, że autor treści o tematyce technicznej ma czas i zasoby potrzebne do uzyskania od ekspertów w danej dziedzinie i innych członków społeczności.
Zadawajcie pytania.
- Twoja społeczność lub projekt prawdopodobnie nie współpracowały wcześniej z autorami treści technicznych ani współtwórcami dokumentacji. Korzystaj z okazji, aby uczyć się, dzieląc się wiedzą. Poproś o opinię na temat procesów i narzędzi. Twój autor tekstów technicznych prawdopodobnie będzie miał kilka sugestii dotyczących ulepszeń.