Teknik yazar kılavuzu

Mevcut aşama:
2021 Dokümanlar Sezonu programı 14 Aralık 2021'de sona erdi. Zaman çizelgesini inceleyin.

Bu kılavuz, Dokümanlar'ın 2021 Sezonu programına kabul edilen kuruluşlarla çalışmak isteyen teknik yazarlar için hazırlanmıştır.

2021 Sezonu Dokümanlar programına katılmalı mısınız?

Dokümanlar 2021 Sezonu programına kabul edilen bir kuruluşla çalışmak isteyip istemediğinizi anlamanıza yardımcı olması için bu soruları kullanın.

  • Teknik yazma becerileriniz ve deneyiminiz var mı? Dokümanlar sezonu, temel teknik yazma becerilerini öğretmek için tasarlanmamıştır. Motivasyonunuz yüksek mi ve düzenli misiniz?
  • Programın altı aylık süresi boyunca (Nisan-Kasım 2021) katılmak için vaktiniz var mı? Projelerin büyüklükleri değişiklik göstermekle birlikte, program süresince haftada 5-30 saat yürütülebilir.
  • Açık kaynakta çalışma deneyimi kazanmak ister misiniz? Projenin süreçlerini ve topluluk normlarını öğrenmeye zaman ayırmak istiyor musunuz?
  • Proje tekliflerini hassaslaştırmak, zaman çizelgeleri oluşturmak, metrikleri değerlendirmek ve derlemek ve tüm kurumun teknik yazı yazmanın değerini anlamasına yardımcı olmak için kurumun yöneticisiyle birlikte çalışmak istiyor musunuz?

Open Collective hesabı oluşturabilmek de dahil olmak üzere programa uygunluk koşullarını da karşılamanız gerekir. İkamet ettiğiniz yerde yapılan çalışmalar için yasal olarak fon alabilmeniz gerektiğini lütfen unutmayın. Dokümanlar Sezonu programı yöneticileri, vergi danışmanlığı sağlayamaz veya çalışmalarınızın uygunluğuyla ilgili soruları yanıtlayamaz.

Dokümanlar Sezonu'na katılan yetenekli bir teknik yazar olarak açık kaynakta çalışma konusunda deneyim kazanırken, daha iyi dokümanlarla projenizin temel bir ihtiyacı çözmesine yardımcı olursunuz.

Dokümanlar'ın 2021 Sezonu programına teknik yazar olarak katılma

Keşif aşaması

Kuruluş başvuruları 26 Mart 2021 saat 18:00'de (UTC) sona erecektir. Teknik yazarların olası projeleri bir an önce incelemeye başlamasını öneririz. Ancak kuruluşlar, 17 Mayıs 2021 saat 18:00'den (UTC) önce istedikleri zaman birlikte çalışacak teknik yazarlar seçebilir.

  • İlginizi çeken projeleri bulun
    • Dokümanlar Sezonu programı sayfalarındaki talimatları kullanarak doğrudan açık kaynak kuruluşlara ulaşın veya Dokümanlar Sezonu GitHub deposuna göz atarak Dokümanlar Sezonu'na katılmak istediğini belirten kuruluşları bulun. Ayrıca ilgi duyan kuruluşları Write the Docs Slack'teki #season-of-docs kanalında bulabilirsiniz.
    • Proje seçme yöntemlerinden bazıları şunlardır:
      • Javascript veya C gibi bildiğiniz veya ilgilendiğiniz bir dilde proje seçin.
      • Makine öğrenimi, açık bilim veya robot bilimi gibi sizi ilgilendiren bir teknoloji veya alanda proje seçin.
      • Topluluğun samimiyetine dayanarak bir proje seçin! Tartışma forumlarına katılın, katkıda bulunanların sosyal medya hesaplarına göz atın (orada projelerinden bahsediyorlarsa) ve varsa oryantasyon belgelerine bakın.
      • Çalışmak istediğiniz ve proje listesinde olmayan bir proje varsa o projeyle iletişime geçin ve ondan programa başvurmasını isteyin.
  • Projelerin teklif sayfalarını inceleme
    • 3-5 olası projeniz olduğunda, her projenin teklif sayfasını kontrol edin
    • Projenin geri bildirim ve tartışma için belirttiği kanalları kullanarak sorular sormalı, geri bildirim vermeli ve önerilerde bulunmalısınız
  • Doğrudan kuruluşa bir menfaat beyanı gönderin. Menfaat bildiriminizde kurumun proje teklifinde belirlenen hedeflere nasıl ulaşacağınızı göstereceksiniz.
    • Dokümanlar Sezonu ilgi alanı beyanı şablonunu kullanın. Ne kadar kısa olursa o kadar iyidir.
    • İlgilendiğinizi belirten beyanı göndermek için kuruluşun fikirler sayfasındaki talimatları kullanın. Kuruluş herhangi bir özel gereksinim belirtmişse ekstrenizde bu koşulları karşıladığınızı gösterin.
    • İlgilendiğinizi belirten beyanı göndererek, kuruluşun davranış kurallarına ve Dokümanlar Sezonunun davranış kurallarına bağlı kalmayı kabul etmiş olursunuz.

Başvuru aşaması

  • Kabul edilen kuruluşların Dokümanlar sezonuna göre duyurulmasını bekleyin:
    • Kabul edilen kuruluşlar, sizinle çalışmak veya ilgilendiğinizi daha ayrıntılı bir şekilde konuşmak istediğinde doğrudan sizinle iletişime geçecektir.
    • Kuruluşlar, yalnızca kuruluşun son başvuru tarihine kadar menfaat beyanını göndermiş olan teknik yazarlarla çalışmakla sınırlı değildir. Kabul ettikten sonra başka menfaat beyanları talep edebilirler. Kuruluşların 17 Mayıs 2021 saat 18:00'e (UTC) kadar teknik yazar seçmesi gerekir.
    • Kuruluşların, başarısız menfaat beyanları konusunda geri bildirimde bulunmaları gerekmez.

Proje geliştirme aşaması

  • Teslimatları ve teslim tarihlerini içeren bir zaman çizelgesi oluşturmak için kurumla birlikte çalışmak.

Son değerlendirme ve örnek olay aşaması

  • Son değerlendirme ve örnek olay için gerekli bilgileri sağlamak üzere kurumla birlikte çalışın.