Mevcut aşama:
2021 Dokümanlar Sezonu programı 14 Aralık 2021'de sona erdi. Zaman çizelgesini inceleyin.
Bu sayfada, açık kaynak kuruluşlar için Dokümanlar Sezonu proje tekliflerini değerlendirme ve doğru teknik yazarı seçme ile ilgili ipuçları yer almaktadır.
Giriş
Açık Kaynak Kuruluşların, teklif ettikleri projeler üzerinde çalışması için bir teknik yazar tutması gerekir. Kuruluşlar, kendi teknik yazarlarını kendileri oluşturmalıdır. Sezon of Docs'a katılan kuruluşlarla çalışmak isteyen teknik yazarlar, Season of Docs GitHub deposu ve Dokümanlar Slack'teki #season-of-docs kanalında bulunabilir.
Teknik yazar değerlendirmesi
Birlikte çalışmayı düşündüğünüz teknik yazarlardan daha önce geliştirilmiş belge örnekleri istemeniz önerilir. Böylece bu yazarların teknik yazma becerilerini ve deneyimlerini değerlendirmeye odaklanabilirsiniz.
Teknik yazma becerileri ve deneyimi
Teknik yazarın önceki deneyimlerini inceleyin. İdeal olarak, teknik yazar yazılım sektörü için teknik belge yazarken biraz deneyime sahip olmalıdır. Dokümanlar Sezonu'nun hedeflerinden biri, teknik yazarlara geliştirici odaklı ürünlere dahil olma fırsatı vermektir. Bu nedenle, projeniz 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. Teknik yazarın önceki çalışmalarını bu açıdan değerlendirin. En önemlisi: Kişinin ne yazdığını anlayabiliyor musunuz? Teknik yazarın eserinin dilini ayrıntılı bir şekilde gözden geçirmek istiyorsanız, noktalama ve ifade kullanımında tutarlılık, doğru yazım ve açık bir dil kullanın. İfade basit mi yoksa karmaşık mı? Cümleler kısa mı yoksa takip edilmesi zor hale gelene kadar devam ediyor mu?
Belge tasarımına ve düzenine dikkat edin. Doküman örneklerinin genel düzenini kontrol edin. Mantıklı bir tasarım mı yapıldı? Dokümanda veya belge grubunda kolayca gezinebiliyor musunuz? İçerik tekrarlanıyor mu yoksa bariz boşluklar mı var?