Mevcut aşama:
2021 Belge Sezonu programı 14 Aralık 2021'de sona erdi. Zaman çizelgesini inceleyin.
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 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 CLA'lar, DCOs'lar veya diğer sözleşmeleri imzalamayla ilgili tüm koşullarına uyduğundan emin olun.
- Mümkünse, topluluk veya projeyle ilgili sorulara hızlıca yanıt verebilecek, saat dilimleriniz çakışan birkaç kişiyle tanıştırın.
- Mümkünse onlara projeyle ilgili hediyeler gönderin.
Teknik yazarın projenize katkıda bulunmak için kullanacağı araçları ve süreçleri kullanmasına yardımcı olun
- Süreçleriniz iyi belgelenmemişse teknik yazara ilk katkısı, sorunu veya çekme isteğini adım adım açıkladığı bir zaman belirleyin. Hangi şablonları veya etiketleri kullanmaları gerekir? Katkılarını kimin incelemesi gerekir ve incelemeleri 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 bilmeleri gerekenler nelerdir?
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 emin ve yetkili bir tavır sergileyebilir.
- Projeyi kullanan kişilerin ihtiyaçlarını açıklayın. Mümkün olduğunca spesifik olun. "Geliştiriciler" yerine "web sitesi oluşturan geliştiriciler" ve "endüstriyel robot programlayan geliştiriciler" gibi ifadeler kullanın.
- Teknik yazarı, konunun uzmanı olan gerekli kişilerle iletişim kurmasını sağlayın. Yani, projenizin dokümantasyonunda ele alınacak 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.