Mevcut aşama:
Belge geliştirme Zaman çizelgesini inceleyin.
Açık kaynak kuruluşların, teknik yazarlarla verimli bir şekilde çalışmasına yardımcı olacak bazı yönergeleri burada bulabilirsiniz.
Teknik yazarı, açık kaynak dünyasına ve topluluğunuza tanıtın
- Teknik yazara topluluğunuzla ilgili 'rehberli bir tur' sunun. Nerede soru sorabilirler? Hangi düzenli toplantılara katılmalı veya hangi posta listelerine katılmalı? Hangi hesaplara (GitHub, Discord, Slack) ihtiyaçları 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, DCO veya diğer sözleşmeleri imzalamayla ilgili gerekliliklerine uyduğundan emin olun.
- Mümkünse onları çakışan saat dilimlerinde bulunan ve topluluk ya da projeyle ilgili sorulara hızlıca yanıt verebilen birkaç kişiyle tanıştırın.
- Mümkünse onlara proje promosyon ürünlerini gönderin.
Teknik yazarın projenize katkıda bulunmak için kullanılan araç ve süreçleri kullanmasına yardımcı olun
- Süreçleriniz iyi belgelenmemişse teknik yazara ilk katkı, sorun veya pull isteği hakkında yol göstermesi için bir zaman ayarlayın. Bu durumda hangi şablonları veya etiketleri kullanmaları gerekir? Katkılarını kimlerin incelemesi gerekir ve yorumları nasıl ve ne zaman takip etmeleri gerekir? Çalışmaları kod örnekleri içeriyorsa nasıl test edilebilir? CI/CD işleminiz veya sürümleriniz hakkında ne 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 yöntem, teknik yazarın projeyle ilgili yazarken daha özgüvenli ve yetkin olmasına yardımcı olabilir.
- Projeyi kullanan kişilerin ihtiyaçlarını tanımlamak. Yalnızca "geliştiriciler" değil, "web siteleri oluşturan geliştiriciler" ve "endüstriyel robotları programlayan geliştiriciler" için de mümkün olduğunca spesifik olun.
- Teknik yazarı, konunun uzmanı olan kişilerle iletişime geçmek. Yani, projenizin belgelerinde ele alınacağı yönlerden sorumlu olan geliştiriciler veya projeye katkıda bulunan diğer kişiler.
- Teknik yazarın ihtiyaç duyduğu zaman ve kaynakları, konunun uzmanlarından ve diğer topluluk üyelerinden almasını sağlayın.
Soru sorun.
- Topluluğunuz ya da projeniz daha önce teknik yazarlar veya belgelere katkıda bulunan kişilerle çalışmamış olabilir. Bildiklerinizi paylaşırken bir yandan da öğrenme fırsatından yararlanın! Süreçleriniz ve araçlarınız hakkında geri bildirim isteyin. Teknik yazarınızın muhtemelen bazı iyileştirme önerilerinde bulunacaktır.