Mevcut aşama:
2021 Dokümanlar Sezonu programı 14 Aralık 2021'de sona erdi. Zaman çizelgesini inceleyin.
Bu kılavuz, 2021 Dokümanlar Sezonu programına başvuran veya bu programa katılan kuruluş yöneticileri için hazırlanmıştır.
Kuruluşunuz, 2021 Dokümanlar Sezonu programına katılmalı mı?
Açık kaynak projenizin veya kuruluşunuzun Dokümanlar Sezonu'na katılması gerekip gerekmediğini anlamanıza yardımcı olması için bu soruları kullanın.
Kuruluşunuz veya projeniz:
- Yeni ya da güncellenmiş belgelerin bir hedefe ulaşmaya ya da projenizde veya topluluğunuzda bir sorunu çözmeye yardımcı olacağına inanıyor musunuz?
- Belgeleme projenizin başarısını nasıl ölçeceğinize dair başlangıç anlayışınız veya hipoteziniz var mı?
- Topluluk üyeleri teknik bir yazarın işe alınmasına, değerlendirilmesine ve ilk yazarlık işlemlerinin yapılmasına yardımcı olacak ve proje boyunca (başvuru dönemi dahil 6-8 ay) soruları cevaplayabilecek ve başka destek sağlayacak kişiler olup olmadığını belirlediniz mi?
- Kurum yöneticisi olarak görev yapmak ve uygulamayı oluşturmayı, program yöneticilerinin sorularını yanıtlamayı ve aylık değerlendirmeleri, son değerlendirmeyi ve örnek olayı göndermeyi koordine etmeye istekli bir topluluk üyeniz var mı? Kuruluş yöneticisi ayrıca, 2021 Dokümanlar Sezonu tamamlandıktan sonra takip anketlerini de yanıtlamaya istekli olmalıdır.
Kuruluşunuzun, Open Collective hesabı oluşturabilmek de dahil olmak üzere program uygunluk koşullarını da karşılaması gerekir.
Kuruluş başvuru süreci
Keşif aşaması
2021 Yılının Dokümanlar başvuruları 9 Şubat 2021'de açılsa da kuruluşların, başvurularını göndermeden önce Keşif aşamasındaki adımları tamamlamaya zaman ayırmalarını önemle tavsiye ederiz.
- Proje teklifi sayfası oluşturun. Teklif sayfası; temel ihtiyaçların, hedeflerin veya sorunların listesini, olası belge çözümlerini ve olası metrikleri içerir. Bu sayfa herkese açık olmalı ve topluluk katkısına ve tartışmaya açık olmalıdır. Katılmak isteyen teknik yazarlar için bilgi ekleyin. Bu yazarların nerede soru sormaları, ilgilerini belirtmeleri veya projeniz hakkında daha fazla bilgi edinmeleri gerekir? (Örnekler için proje fikirleri listesini inceleyin.)
- Teklif sayfanızı topluluk kanallarınızda tanıtın ve kuruluşunuzu Dokümanlar Sezonu GitHub deposundaki ilgilenen kuruluşlar listesine ekleyin. Dilerseniz bağlantınızı Write The Docs Slack'teki #season-of-docs kanalında paylaşabilirsiniz. Tanıtım ve basın sayfasında, Dokümanlar Sezonu hakkında konuşurken kullanabileceğiniz logolar ve başka içerikler bulunur.
- Her bir belgeleme fikrinde, teknik yazarların topluluğunuz ve kuruluşunuzla başarılı bir şekilde çalışmak için hangi deneyim ve niteliklere sahip olması gerektiğini düşünün. Topluluğunuz teknik bir yazarın gelişmesine (örneğin, GitHub'ı veya doküman araç zincirinizi kullanarak) hangi becerileri sağlayabilir? (Teknik yazarlarla çalışma kılavuzuna bakın.
- Konuyla ilgilenen teknik yazarlardan gelen soruları yanıtlamak için gönüllülerden yardım isteyin.
- Projenizde çalışmak isteyen teknik yazarların gönderilen menfaat ifadelerini incelemeye başlayın.
Başvuru aşaması
- Teklif sayfanızdan en umut verici fikri seçin. Her kuruluş yalnızca bir teklif gönderebilir. Göz önünde bulundurulması gereken bazı noktalar:
- Teknik yazarlar en çok hangi fikirle ilgileniyor?
- Hangi fikir projenizin en büyük sorununu çözmeye yardımcı olur? Tamamlanma olasılığı daha yüksek olan ama projenizde büyük fark yaratmayacak bir belgeleme projesinden daha riskli bir fikir seçmek daha iyidir.
- Fikir, topluluğunuzun belirli üyelerinin katılımını gerektiriyor mu? Katılmak için vakitleri var mı?
Teklif şablonunu kullanarak teklifinizi oluşturun. Aşağıdakileri anladığınızdan ve bunlara yer verdiğinizden emin olun:
- Ele almak istediğiniz sorun
- İyileştirmek veya oluşturmak istediğiniz belgelerin kapsamı
- Belgelerinizin başarısını nasıl ölçeceksiniz
Teklifiniz bir bütçe de içermelidir. Tamamlanmamış teklifler dikkate alınmaz.
Başvuru Formu'nu son başvuru tarihi olan 26 Mart 2021 saat 18:00'e (UTC) kadar gönderin. Kabul edilen teklifler 16 Nisan 2021'de duyurulacaktır.
Proje geliştirme ve raporlama
Proje başlangıç toplantısı
- Kuruluşunuz projeniz için zaten bir teknik yazar veya yazar seçtiyse teknik yazarınızla bir başlangıç toplantısı düzenleyin. Çalışma için bir program oluşturmak ve düzenli görüşmeler yapmak üzere teknik yazarınızla iş birliği yapmalısınız.
- İlgili teknik yazarlardan birden fazla menfaat bildirimi aldıysanız teknik yazar seçiminizi herkese açık bir şekilde duyurun veya başvuranları kararınız hakkında başka şekilde bilgilendirin.
Ödeme yapma
- Dokümanlar Sezonu, 10 Haziran 2021'den itibaren teknik yazar çalıştırdıktan sonra her bir kuruluşun Open Collective hesabına bağış fonlarının% 40'ını yatıracaktır. Kuruluşların, proje başlangıcında yapılacak bir ödeme de dahil olmak üzere projenin ara hedeflerine göre teknik yazarlarla bir ödeme planı oluşturmalarını öneririz.
- Kalan% 60, son değerlendirmelerini ve örnek olaylarını tamamlayıp gönderen kuruluşların Open Collective hesaplarına 14 Aralık 2021'den itibaren yatırılacaktır.
- Open Collective hesabı oluşturma hakkında daha fazla bilgi edinmek için ödeme kılavuzunu inceleyin.
Proje durumu raporlaması
- Kuruluş yöneticileri, durum raporu formunun bağlantısını aldıktan sonra bir hafta içinde aylık durum raporlarını doldurmalıdır (bağlantı e-postayla gönderilecektir, lütfen spam klasörünüzü kontrol edin).
Proje nihai değerlendirmesi ve örnek olay
Kuruluşların, kalan hibe tutarlarını alabilmeleri için hem proje son değerlendirmesini hem de örnek olayı 30 Kasım 2021 saat 18:00'a (UTC) kadar tamamlayıp göndermeleri gerekir.
Son değerlendirme
Son değerlendirme formu, en geç bir ay önce 30 Kasım 2021 saat 18:00'de (UTC) kuruluş yöneticilerine sunulacaktır.
Örnek olay
Sezonu Dokümanlar örnek olayı, kuruluşunuzun Dokümanlar 2021 Sezonu'na katılımının temel teslimatıdır. Projeyle ilgili güncellemelerin haftalık olarak günlük kaydını tutmak, örnek olayınızı oluşturmanıza yardımcı olur. Her hafta projenin ilerlemesini (uygun olduğu durumlarda çekme isteklerine, sorunlara veya görüşmelere yönlendiren bağlantılar dahil), nelerin iyi (ya da kötü) olduğunu, öğrendiklerinizi ve sorulan soruları kaydedin.
Daha fazla bilgi için lütfen örnek olay oluşturma bölümünü okuyun ve örnek olayınızı oluşturmak için örnek olay şablonumuzu uyguladığınızdan emin olun. Örnek olayınızı nihai değerlendirme formuna bir bağlantı olarak göndereceksiniz.
Örnek olayınız, Dokümanlar Sezonu sitesinde yayınlanacak. Projeniz hakkında bilgi eklerken lütfen bunu göz önünde bulundurun.
Kuruluşların, Dokümanlar Sezonu projelerinin zaman içindeki başarısını takip etmemize yardımcı olması için en az üç takip anketine katılmalarını zorunlu tutuyoruz.
Formlar
| Form | Bağlantı | Ödemenin yapılacağı en ileri tarih |
|---|---|---|
| Kuruluş başvurusu | Kuruluş başvuruları kapanmıştır. Gelişmelerden haberdar olmak için season-of-docs-announce adresindeki duyuru posta listesine katılın. |
26 Mart 2021, 18:00 UTC |
| Kuruluşa ait ödeme bilgileri | Kuruluş ödeme bilgileri aşaması tamamlandı. Kuruluşunuzun ödeme bilgilerinde değişiklik yapmanız gerekiyorsa lütfen Dokümanlar Sezonu yöneticileriyle iletişime geçin. |
12 Mayıs 2021, 18:00 UTC |
| Teknik yazar işe alımına dair kanıt | Teknik yazar işe alma aşaması tamamlandı. |
17 Mayıs 2021, 18:00 UTC |
| Aylık değerlendirmeler | Zaman çizelgesini inceleyin | |
| Nihai proje değerlendirmesi ve örnek olay | Form, nihai proje değerlendirmesi ve örnek olay aşamasında (22 Kasım 2024 - 10 Aralık 2024) kullanılabilir. |
30 Kasım 2021, 18:00 UTC |
| Takip anketleri | Form, takip anketleri aşamasında (1 Mayıs 2025) kullanılabilir. |
Zaman çizelgesini inceleyin |
İlgili bilgiler
- Dokümanlar sezonu zaman çizelgesini inceleyin.