Mevcut aşama:
Örnek olaylar yayınlandı. Zaman çizelgesine bakın.
Açık kaynak kuruluşlarının teknik yazarlarla etkili bir şekilde çalışmasına yardımcı olacak bazı yönergeleri aşağıda bulabilirsiniz.
Teknik yazarı açık kaynak dünyasına ve topluluğunuza tanıtın
- Teknik yazara topluluğunuzda "rehberli tur" yaptırın. Kullanıcılar nerede soru sorabilir? Hangi düzenli toplantılara katılmalı veya hangi posta listelerine üye olmalı? 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 İTŞ, İTŞ'ler veya diğer sözleşmeleri imzalamayla ilgili tüm koşullarına uyduğundan emin olun.
- Mümkünse, zaman dilimleri çakışan ve topluluk ya da projeyle ilgili sorulara hızlıca yanıt verebilecek birkaç kullanıcıyla tanıştırın.
- Mümkünse onlara projeyle ilgili hediyeler gönderin.
Teknik yazarın projenize katkıda bulunmayla ilgili araçları ve süreçleri kullanmasına yardımcı olun
- Süreçleriniz hakkında yeterli doküman yoksa teknik yazara ilk katkısı, sorunu veya çekme isteği konusunda yol göstermek için bir zaman belirleyin. Hangi şablonları veya etiketleri kullanmaları gerekir? Katkılarını kimlerin incelemesi gerekir ve incelemeleri nasıl ve ne zaman takip etmelidirler? Çalışmaları kod örnekleri içeriyorsa nasıl test edilebilir? CI/CD süreciniz veya sürümleriniz hakkında bilmeleri gerekenler neler?
Teknik yazarın projenizi ve kullanıcılarını anlamasına yardımcı olun
- Teknik yazarın ürün hakkında sağlam bir kavramsal anlayışa sahip olması için projenizi ayrıntılı olarak açıklayın. Bu sayede teknik yazar, projeyle ilgili yazılarında daha güvenli ve yetkili bir tavır sergileyebilir.
- Projeyi kullanan kişilerin ihtiyaçlarını açıklayın. Mümkün olduğunca spesifik olun. Örneğin, "geliştiriciler" yerine "web sitesi oluşturan geliştiriciler" ve "endüstriyel robot programlayan geliştiriciler" gibi ifadeler kullanın.
- Teknik yazarı gerekli konu uzmanlarıyla iletişime geçirin. Yani, projenizin dokümanların kapsayacağı yönlerinden sorumlu geliştiriciler veya diğer proje katılımcıları.
- Teknik yazarın, konu uzmanlarından ve diğer topluluk üyelerinden ihtiyaç duyduğu zaman ve kaynakları almasını sağlayın.
Soru sorun.
- Topluluğunuz veya projeniz daha önce teknik yazarlarla ya da doküman 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ız, iyileştirmeyle ilgili bazı öneriler sunabilir.