Mevcut aşama:
Sonuçlar açıklandı
zaman çizelgesi.
Bu sayfa, açık kaynak kuruluşlarına Dokümanlar Mevsimi proje tekliflerini değerlendirme ve doğru teknik yazarı seçme konusunda ipuçları içerir.
Giriş
Açık Kaynak Kuruluşlar, teklif ettikleri projeler üzerinde çalışmak için teknik bir yazar tutmalıdır. Kuruluşlar kendi teknik yazarlarını kendileri sağlamalıdır. Dokümanlar Sezonu'na katılan kuruluşlarla birlikte çalışmak isteyen teknik yazarlar, Dokümanlar Sezonu GitHub deposunda ve Write the Docs Slack'in #season-of-docs kanalında bulunabilir.
Süreci başlatma
Dokümanlar Dönemi'ne katılmak isteyebileceğinizi düşündüğünüz gibi teknik yazar bulma sürecine en kısa sürede başlamanız önerilir.
Teknik yazar değerlendirme
Birlikte çalışmayı düşündüğünüz teknik yazarların teknik yazarlık becerilerini ve deneyimlerini değerlendirmeye odaklanabilmek için bu yazarlardan daha önce geliştirilmiş belge örnekleri istemeniz önerilir.
Teknik yazı yazma becerisi ve deneyimi
Teknik yazarın önceki deneyimini inceleyin. İdeal olarak, teknik yazarın yazılım sektörü için teknik belge yazma konusunda belirli bir deneyime sahip olması gerekir. Belgeler Sezonunun hedeflerinden biri, teknik yazarlara geliştirici odaklı ürünlerle dahil olma fırsatı vermektir. Bu nedenle, projeniz bir geliştirici kitlesine odaklansa bile yazarın API, SDK veya diğer geliştirici platformları konusunda deneyimli olması gerekli değildir.
Dil ve iletişim becerilerine odaklanın. Bu bakış açısıyla, teknik yazarın daha önceki çalışmalarını değerlendirin. En önemlisi: Kişinin ne yazdığını anlayabiliyor musunuz? Teknik yazarın çalışmasının dilini ayrıntılı bir şekilde incelemek istiyorsanız noktalama ve ifadelerde tutarlılık, doğru yazım ve açık bir dil kullanmaya özen gösterin. İfade basit mi yoksa karmaşık mı? Cümleler kısa mı yoksa takip edilmesi zor hale gelene kadar devam ettiriliyor mu?
Doküman tasarımına ve düzenine dikkat edin. Doküman örneklerinin genel düzenini kontrol edin. Mantıklı bir tasarım mı yapıldı? Belgede ya da belge grubunda yolunuzu kolayca bulabiliyor musunuz? İçerik tekrarlanıyor mu yoksa bariz boşluklar mı var?
Teknik yazar işe alma
Kuruluşlar, 16 Mayıs 2022 saat 18:00'e (UTC) kadar teknik yazar kiralamalı ve aşağıda bağlantısı verilen Teknik Yazar İşe Alma Formu'nu doldurmalıdır.
Teknik yazar işe alım aşaması tamamlandı.
İşe alımdan önce teknik yazarla ücret ve ödeme planı hakkında görüşmeyi unutmayın. Kuruluşların, proje başlangıcında yapılacak ödeme dahil olmak üzere proje ara hedefleri doğrultusunda teknik yazarlarla bir ödeme planı oluşturmasını öneririz. Program boyunca yalnızca iki kez yapılacak ödeme tarihlerini ve ödeme planı oluşturulurken uygulanan tutarları göz önünde bulundurun.
Not: 16 Mayıs 2022, saat 18:00'e (UTC) kadar teknik yazar işe almamış ve Teknik Yazar İşe Alma Formu'nu gönderen kuruluşlar ilk ödeme tarihinde para almaz.