Teknik yazı projelerini seçme

Mevcut aşama:
Dökümanlar Sezonu 2019 programı 6 Mart 2020'de sona erdi. Zaman çizelgesini inceleyin.

Bu sayfada, açık kaynak kuruluşlarına yönelik teknik yazım proje tekliflerinin nasıl değerlendirileceği ve Dokümanlar Mevsimi'nde rehberlik etmek istedikleri projelerin nasıl seçileceği ile ilgili yönergeler bulunmaktadır.

Giriş

Teknik yazarlar, seçtikleri açık kaynak kuruluşla bir proje üzerinde çalışmak için Belgeler Sezonu tekliflerini gönderir. Google program yöneticileri, teklifleri değerlendirme ve proje seçimi için açık kaynak kuruluşlarına iletir. İlgili adımlarla ilgili ayrıntılar için kuruluş yöneticisi kılavuzuna göz atın.

Teknik yazar tekliflerini değerlendirme

Teknik yazı yazma becerisi ve deneyimi

  • Teknik yazarın önceki deneyimini inceleyin. Teknik yazarın teklifinde en son teknik yazarlık deneyimiyle ilgili bilgiler yer alır. İdeal olarak, başvuranın yazılım sektörü için teknik belge yazma konusunda belirli bir deneyime sahip olması gerekir. Dokümanlar Sezonu'nun hedeflerinden biri, teknik yazarlara geliştirici odaklı ürünlerle ilgilenme fırsatı vermektir. Bu nedenle, projeniz bir geliştirici kitlesine odaklansa bile yazarın API, SDK veya diğer geliştirici platformları konusunda deneyim sahibi olması çok zorunlu değildir.

  • Dil ve iletişim becerilerine odaklanın. Teknik yazarın teklifini bu açıdan değerlendirin. En önemlisi: Kişinin ne yazdığını anlayabiliyor musunuz? Mentor olarak rolünüz açık kaynaktaki süreçler, araçlar ve kodlar konusunda teknik yazara yardımcı olmak olacaktır. Böylece oluşturulan belgelerin metnini de incelemeniz gerekmez. Teklifin dilini ayrıntılı bir şekilde incelemek istiyorsanız noktalama ve ifadeler, doğru yazım ve açık bir dil kullanımında tutarlı olun. İfade basit mi 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. Teknik yazar, teklifi kapsamında geliştirdikleri belgelerden örnekler sunma fırsatına sahip olur. Belge örneklerinin genel düzenini kontrol edin. Mantıklı bir tasarım mı yapıldı? Dokümanda veya belge grubunda kolayca bulabiliyor musunuz? İçerik yineleniyor mu yoksa bariz boşluklar mı var?

Teklif

  • Teklifin gereksinimlerinize uygun olup olmadığını kontrol edin. Teklif, bu yılın Dokümanlar Sezonu için gönderdiğiniz proje fikirleriyle bağlantılı mı? Teknik yazar yeni bir fikir önerdiyse teklifin açık kaynak projenizin ihtiyaçlarına uygun olduğundan ve teknik yazarın önerilen projenin hedeflerine ulaşmasına yardımcı olacak doğru kişilere sahip olduğunuzdan emin olun.

  • Heves ve bütünlük sağlamaya çalışın. Teklif, teknik yazarın projeyle ilgili heyecan duyduğunu gösteriyor mu? Keşif aşamasında kurumunuza danışarak veya proje hedeflerine nasıl ulaşılacağı konusunda kendi görüşlerini ekleyerek teklif için düşüncelerini ve çalışmalarını sağlayıp sağlamadıklarını düşünün.

SSS

Kaç projenin gönderileceğine nasıl karar veriyoruz?

Bir veya iki projeye odaklanın. Kurumunuz bundan daha fazlasını danışmanlık kapasitesine sahipse daha fazlasını gönderebilirsiniz. Her teknik yazar projesi için yalnızca o projeye mentorluk yapmayı taahhüt eden en az bir (tercihen iki) mentora ihtiyacınız vardır.

Dokümanlar Sezonu alan ayırmanın işleyiş şekli hakkındaki bilgileri okuyun.

Kabul edilecek teknik yazı teklifini nasıl seçebiliriz?

Aldığınız teknik yazar teklifleri arasından en iyisini seçtiğinizden emin olun. Yani gereksinimlerinize en uygun ve yukarıda listelenen değerlendirme kurallarına en uygun teklifleri seçin.

Seçili teklifleri göndermek için gereken formlar nerede?

Kuruluş yöneticisi kılavuzuna göz atın.