Obecny etap:
Ogłoszenie wyników Oś czasu.
Poniżej znajdziesz wskazówki, które ułatwią organizacjom open source skuteczną współpracę z twórcami treści technicznych.
Zaproś twórcę technicznego do świata open source i w swojej społeczności
- Zapewnij autorowi technicznemu „prezentację” po swojej społeczności. Gdzie może zadawać pytania? W jakich regularnych spotkaniach powinien uczestniczyć lub do których list adresowych powinien dołączyć? Jakich kont potrzebuje klient (Github, Discord, Slack)? Upewnij się, że zna kodeks postępowania związany z projektem i potrafi zgłaszać ewentualne problemy. Upewnij się, że pisarz techniczny rozumie licencję Twojego projektu i spełnia wymagania innych pracodawców dotyczące podpisywania umów CLA, DCO i innych umów.
- Jeśli to możliwe, przedstaw ich kilka osób z pokrywających się stref czasowych, które będą w stanie szybko odpowiadać na pytania dotyczące społeczności lub projektu.
- Jeśli możesz, prześlij im gadżety związane z projektem.
Pomóż redaktorowi technicznemu w korzystaniu z narzędzi i procesów zaangażowanych w Twój projekt.
- Jeśli Twoje procesy nie są dobrze udokumentowane, zorganizuj czas, aby opowiedzieć autorowi tekstu technicznego o pierwszej publikacji, problemie lub prośbie o wyciąganie wniosków. Jakich szablonów lub tagów powinien użyć? Kto musi sprawdzać publikowane przez nich opinie oraz jak i kiedy powinien kontaktować się z nimi? Jeśli ich praca zawiera próbki kodu, jak można je przetestować? Co musi wiedzieć o Twoim procesie CI/CD lub nowych funkcjach?
Pomóż autorowi technicznemu zrozumieć Twój projekt i jego użytkowników
- Opisz swój projekt szczegółowo, aby redaktor techniczny mógł lepiej zrozumieć produkt. Dzięki temu autor może poczuć się pewniej i bardziej wiarygodnie przy pisaniu projektu.
- Opisz potrzeby osób korzystających z projektu. Podaj jak najwięcej szczegółów – nie tylko „programiści”, ale także „programiści tworzący strony internetowe” i „programiści programowania robotów przemysłowych”.
- Przez kontaktowanie autora tekstu z odpowiednimi ekspertami z danej dziedziny. Oznacza to, że deweloperzy lub inni współtwórcy projektu odpowiadają za te aspekty projektu, które zostaną omówione w dokumentacji.
- Upewnij się, że autor tekstu technicznych otrzyma potrzebne zasoby i czas od ekspertów w danej dziedzinie oraz innych członków społeczności.
Zadawajcie pytania!
- Być może Twoja społeczność lub projekt nie współpracował wcześniej z twórcami materiałów technicznych lub współtwórcami dokumentacji. Skorzystaj z okazji i dziel się wiedzą. Poproś o opinię na temat procesów i narzędzi – specjalista ds. technicznych prawdopodobnie podsunie Ci sugestie, które pozwolą Ci ulepszyć tę usługę.