Teknik yazar kılavuzu

Mevcut aşama:
Sonuçlar açıklandı zaman çizelgesi.

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

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

Dokümanlar Sezonu programında 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. Motivasyonunuzu yüksek ve düzenli misiniz?
  • Programın altı ayı boyunca katılmak için vaktiniz var mı? Projelerin büyüklükleri değişiklik gösterir, ancak program süresince haftada 5-30 saat yürütülebilir.
  • Açık kaynakta çalışma deneyimi kazanmak ister misiniz? Bir projenin süreçlerini ve topluluk normlarını öğrenmeye zaman ayırmak istiyor musunuz?
  • Proje tekliflerini hassaslaştırmak, zaman çizelgelerini geliştirmek, metrikleri değerlendirip derlemek ve kurumun teknik yazımın değerini bir bütün olarak anlamasına yardımcı olmak için kurumun yöneticisiyle birlikte çalışmak istiyor musunuz?

Open Collective hesap 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, vergiyle ilgili tavsiyede bulunamaz veya işinize uygunlukla ilgili soruları yanıtlayamaz.

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

Teknik yazar olarak Dokümanlar Sezonu programına katılma

Keşif aşaması

Kuruluş başvuruları 25 Mart 2022 saat 18:00'de (UTC) sona erecektir. Teknik yazarların olası projeleri mümkün olduğunca erken incelemeye başlamalarını öneririz. Bununla birlikte kuruluşlar, 16 Mayıs 2022 saat 18:00'den (UTC) önce birlikte çalışacak teknik yazarlar seçebilir.

  • İlginizi çeken projeleri bulma
    • Dokümanlar Sezonu program sayfalarındaki talimatları kullanarak açık kaynak kuruluşlarla doğrudan iletişime geçin veya Dokümanlar Sezonu'na katılmak istediklerini belirten kuruluşları bulmak için Dokümanlar Sezonu GitHub deposu bölümüne göz atın. İlgilenen kuruluşları Write the Docs Slack'teki #season-of-docs kanalında da bulabilirsiniz.
    • Proje seçme yöntemlerinden bazıları şunlardır:
      • Javascript veya C gibi aşina olduğunuz veya ilgilendiğiniz bir dilde proje seçin.
      • Makine öğrenimi, açık bilim veya robotik gibi ilginizi çeken bir teknoloji veya alanda bir proje seçin.
      • Topluluğun samimiyetine dayanarak bir proje seçin! Tartışma forumlarında gezinin, katkıda bulunanların sosyal medya hesaplarına göz atın (projelerinden bahsediyorlarsa) ve varsa ilk katılım belgelerine bakın.
      • Birlikte çalışmak istediğiniz proje listesinde yoksa projeyle iletişime geçin ve projeye başvurmalarını isteyin.
  • Projelerin teklif sayfalarını inceleme
    • 3 ila 5 olası projeniz olduğunda, her projenin teklif sayfasına bakın
    • Projenin geri bildirim ve tartışma için belirttiği kanalları kullanarak sorular sormalı, geri bildirimde bulunmalı ve önerilerde bulunmalısınız
  • Doğrudan kuruluşa menfaat beyanı gönderin. Menfaat bildiriminizde kurumun proje teklifinde belirtilen hedeflere nasıl ulaşacağınızı göstereceksiniz.
    • Dokümanlar Dönemi fayda bildirimi şablonunu kullanın. Ne kadar kısa olursa o kadar iyi.
    • İlgi beyanınızı 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ı belirttiğinizden emin olun.
    • Menfaat beyanınızı göndererek, kuruluşun davranış kurallarına ve Dokümanlar Sezonu davranış kurallarına uymayı 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 birlikte çalışmak veya menfaat beyanınız üzerine daha ayrıntılı görüşmek isterlerse sizinle doğrudan iletişime geçer.
    • Kuruluşlar, yalnızca kuruluşun başvuru tarihine kadar ilgilendiklerini beyan eden teknik yazarlarla çalışmakla sınırlı değildir. Kabul ettikten sonra başka menfaat beyanları da isteyebilirler. Kuruluşların, 16 Mayıs 2022 saat 18:00 (UTC) tarihinden önce teknik yazar seçmesi gerekir.
    • Kuruluşların başarısız menfaat beyanları hakkında 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 incelemesi için gerekli bilgileri sağlamak üzere kurumla birlikte çalışın.