Mevcut aşama:
Sonuçlar açıklandı
zaman çizelgesi.
Aşağıda, açık kaynak kuruluşlarının teknik yazarlarla etkili bir şekilde çalışmasına yardımcı olacak bazı yönergeler verilmiştir.
Teknik yazarı, açık kaynak dünyasına ve topluluğunuza tanıtın
- Teknik yazarı, topluluğunuzla ilgili "rehberli bir tur" atın. Nerede soru sorabilirler? Hangi düzenli toplantılara katılmaları gerekir veya hangi posta listelerine katılmaları gerekir? Hangi hesaplara (GitHub, Discord, Slack) ihtiyacı var? Projenizin davranış kurallarını anladıklarından ve sorunları nasıl bildireceklerini bildiklerinden emin olun. Teknik yazarınızın projenizin lisansını anladığından ve diğer işverenlerin CLA'ları, DCO'ları veya diğer sözleşmeleri imzalamayla ilgili gerekliliklerine uyduğundan emin olun.
- Mümkünse çakışan saat dilimlerindeki kullanıcıları, topluluk veya proje hakkındaki sorulara hızlıca yanıt verebilecek birkaç kişiyle tanıtın.
- Yapabiliyorsanız onlara proje promosyon ürünlerini gönderin.
Teknik yazarın projenize katkıda bulunurken kullanılacak araç ve süreçleri kullanmasına yardımcı olun
- Süreçleriniz iyi belgelenmemişse teknik yazarı ilk katkı, sorun veya çekme isteği konusunda yönlendirmek için bir zaman belirleyin. Bu durumda hangi şablonları veya etiketleri kullanmaları gerekir? Katkılarını kimlerin incelemesi gerekir ve bu kişiler yorumları nasıl ve ne zaman takip etmelidir? Çalışmalarında kod örnekleri varsa bunlar nasıl test edilebilir? CI/CD süreciniz veya sürümleriniz hakkında neleri bilmesi gerekiyor?
Teknik yazarın projenizi ve kullanıcılarını anlamasına yardımcı olun
- Teknik yazarın ürünle ilgili tam bir kavramsal bilgi edinebilmesi için projenizi ayrıntılı olarak açıklayın. Bu sayede teknik yazarlar kendilerini daha özgüvenli hissedebilir ve projeyle ilgili yazarken daha otoriter olabilir.
- Projeyi kullanan kişilerin ihtiyaçlarını açıklayın. Olabildiğince ayrıntılı bilgi verin. Yalnızca "geliştiriciler" değil, "web siteleri oluşturan geliştiriciler" ve "endüstriyel robotlar programlaması yapan geliştiriciler" de mümkün olduğunca spesifik olun.
- Teknik yazarı, konunun uzmanı olan kişilerle iletişime geçmek. Bir başka deyişle, projenizin belgede ele alacağı konulardan sorumlu olan geliştiriciler veya projeye katkıda bulunan diğer kişilerdir.
- Teknik yazarın ihtiyaç duyduğu zamanı ve kaynakları, konunun uzmanlarından ve diğer topluluk üyelerinden aldığından emin olun.
Soru sorun!
- Topluluğunuz ya da projeniz daha önce teknik yazarlarla veya belgeye katkıda bulunanlarla çalışmamış olabilir. Bildiklerinizi paylaşırken öğrenme fırsatından yararlanın. Süreçleriniz ve araçlarınız hakkında geri bildirim isteyin. Teknik yazarın muhtemelen iyileştirme için bazı önerileri vardır.