Obecna faza:
finalizacja projektu. Zobacz oś czasu.
Oto kilka wskazówek, które pomogą organizacjom open source efektywnie współpracować z pisarzami technicznymi.
Przedstaw pisarza technicznego światu open source i swojej społeczności
- Przeprowadź dla autora technicznego „obejście” Twojej społeczności. Gdzie mogą zadawać pytania? Na jakich stałych spotkaniach powinny uczestniczyć lub do jakich list mailingowych powinny dołączyć? Jakich kont potrzebują (Github, Discord, Slack)? Upewnij się, że rozumieją zasady projektu i wiedzą, jak zgłaszać problemy. Upewnij się, że Twój copywriter techniczny rozumie licencję projektu i spełnia wymagania innych pracodawców dotyczące podpisywania umów o nieujawnianiu informacji, umów o przeniesienie praw autorskich 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 pracą nad projektem
- Jeśli procesy nie są dobrze udokumentowane, umów się z autorem technicznym na omówienie jego pierwszego wkładu, problemu lub prośby o włączenie. Których szablonów lub tagów powinni używać? Kto powinien sprawdzić ich wkład i jak i kiedy powinni to zrobić? Jeśli ich praca obejmuje próbki kodu, jak można je 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 mógł dobrze zrozumieć założenia koncepcyjne produktu. Dzięki temu autor tekstów technicznych może czuć się pewniej i wydawać się bardziej kompetentnym w ramach projektu.
- Opisz potrzeby osób, które korzystają z projektu. Podaj jak najwięcej szczegółów. Nie pisz tylko „programiści”, ale „programiści tworzący strony internetowe” lub „programiści programujący roboty przemysłowe”.
- Połącz autora technicznego z odpowiednimi ekspertami w danym temacie. Oznacza to, że deweloperzy lub inni współtwórcy projektu, którzy są odpowiedzialni za aspekty projektu, które będą objęte dokumentacją.
- Zadbaj o to, aby autor treści 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 pisarzami technicznymi ani autorami dokumentacji. Korzystaj z okazji, aby uczyć się i dzielić wiedzą. Poproś o opinię na temat procesów i narzędzi. Twój copywriter techniczny prawdopodobnie będzie miał kilka sugestii dotyczących ulepszeń.