Obecny etap:
opracowywanie dokumentacji. Sprawdź oś czasu.
Poniżej znajdziesz wskazówki, które ułatwią organizacjom open source skuteczną pracę z twórcami technicznymi.
Zaproś pisarza technicznego do świata open source i swojej społeczności
- Zapewnij pisarzowi technicznemu „prezentację” swojej społeczności. Gdzie mogą zadawać pytania? W jakich regularnych spotkaniach powinni uczestniczyć lub do których list adresowych powinni dołączać? Jakich kont potrzebuje klient (Github, Discord, Slack)? Upewnij się, że zna kodeks postępowania związany z projektem i wie, jak zgłaszać problemy. Upewnij się, że Twój pisarz techniczny rozumie licencję projektu i przestrzega wszystkich wymagań innych pracodawców w zakresie podpisywania CLA, inspektorów ochrony danych i innych umów.
- Jeśli to możliwe, przedstaw ich kilka osób z pokrywających się stref czasowych, które będą mogły 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óż autorowi technicznemu korzystać z narzędzi i procesów związanych z Twoim projektem.
- Jeśli Twoje procesy nie są dobrze udokumentowane, ustal czas, aby przedstawić użytkownikowi techników jego pierwszą interakcję, zgłoszenie lub żądanie pull. Jakich szablonów lub tagów powinna użyć? Kto musi sprawdzać publikowane treści i jak i kiedy powinien się z nimi kontaktować? Jeśli w pracy znajdują się przykłady kodu, jak można je przetestować? Co musi wiedzieć o procesie CI/CD lub wydaniach?
Pomóż autorowi technicznemu zrozumieć Twój projekt i jego użytkowników
- Opisz szczegółowo swój projekt, aby artysta techniczny mógł dokładnie zrozumieć produkt. W ten sposób twórca tekstu technicznego może poczuć się pewniej i z większą wiarygodnością.
- Opisz potrzeby osób korzystających z projektu. Podaj jak najwięcej szczegółów: nie tylko „programiści”, ale także „programiści tworzą strony internetowe” i „programiści robotów przemysłowych”.
- W razie potrzeby poproś autora tekstu o kontakt z odpowiednimi ekspertami z danej dziedziny. Oznacza to, że deweloperzy lub inni współtwórcy projektu są odpowiedzialni za poszczególne aspekty projektu, które zostaną uwzględnione w dokumentacji.
- Zadbaj o to, aby twórca miał odpowiednią ilość czasu i zasobów od ekspertów i innych członków społeczności.
Zadawajcie pytania!
- Być może Twoja społeczność lub projekt nie współpracował wcześniej z autorami dokumentacji technicznej ani współtwórcami dokumentacji. Zdobywaj wiedzę i dziel się wiedzą. Poproś o opinie na temat procesów i narzędzi – Twój autor techniczny może zasugerować pewne ulepszenia.