Obecny etap:
program Dokumenty na sezon 2021 zakończył się 14 grudnia 2021 r. Zobacz oś czasu.
Oto kilka wskazówek, które pomogą organizacjom open source w skutecznej współpracy z pisarzami technicznymi.
Przedstaw pisarza technicznego światu open source i swojej społeczności
- Zaprezentuj autorowi technicznemu swoją społeczność. Gdzie mogą 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 to możliwe, wyślij im 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ć? Jeśli ich praca zawiera przykłady kodu, jak można ją przetestować? 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 korzystających 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”.
- Skontaktowanie twórcy treści technicznych z odpowiednimi ekspertami w danej dziedzinie. To znaczy, że programiści lub inni współtwórcy projektu odpowiadają za aspekty projektu, które są opisane w dokumentacji.
- Zadbaj o to, aby autor tekstów technicznych miał czas i zasoby potrzebne od ekspertów w danej dziedzinie i innych członków społeczności.
Zadawajcie pytania.
- Twoja społeczność lub projekt mogą nie współpracować wcześniej z autorami dokumentacji technicznej. 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ń.