Obecny etap:
Program Sezon Dokumentów 2019 zakończył się 6 marca 2020 r. Zobacz oś czasu.
Oto kilka wskazówek dla organizacji typu open source, które pomogą Ci nawiązać współpracę z autorem treści technicznych, który opiekuje się Twoim mentorem w ramach sezonu Dokumentów:
- Zaprezentuj twórcę technicznego świat open source i swoją społeczność.
- Pomóż redaktorowi ds. technicznych wykorzystać narzędzia i procesy związane z Twoim projektem.
- Opisz swój produkt szczegółowo, aby artysta techniczny mógł go zrozumieć. Dzięki temu autor projektu może poczuć się pewniej i bardziej wiarygodnie.
- Opisz potrzeby swoich odbiorców, czyli potrzeby deweloperów korzystających z Twojego produktu lub innych grup użytkowników, którzy korzystają z Twojego produktu.
- Omów ważne przypadki użycia z autorem treści technicznych, by pomóc mu zaprojektować wymaganą dokumentację.
- Omów kod, gdy programista chce go zrozumieć przed napisaniem dokumentów.
- Przez kontaktowanie autora tekstu z odpowiednimi ekspertami z danej dziedziny. Oznacza to, że deweloperzy lub inni współtwórcy projektu odpowiadają za te aspekty usługi, 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.
- W razie potrzeby współpracuj z technikiem ds. technicznych, by w razie potrzeby dodawać do dokumentów przydatne przykłady kodu.
O czym warto pamiętać
Doradcy klienta ds. licencji open source w sezonie Dokumentów nie muszą być autorami materiałów technicznych. Mentor nie musi mieć umiejętności dokumentacji. Twórcy z dziedziny technologii technicznej wnoszą te umiejętności do projektu i tworzą relację z mentorem.
Zamiast tego dzielą się wiedzą na temat swojej społeczności open source, produktu oraz procesów i narzędzi, z których korzysta projekt open source.
Ważnym elementem relacji z mentorem powinno być to, aby osoba odpowiedzialna za kwestie techniczne mogła mieć satysfakcjonujące i udane doświadczenie w tegorocznym sezonie Dokumentów. Udane rozwiązanie zwiększa szansę na to, że po zakończeniu tegorocznego Sezonu dokumentów twórca będzie kontynuował w projekcie open source, a inni autorzy materiałów technicznych będą entuzjastycznie nastawieni do pracy w modelu open source.