Mevcut aşama:
Sonuçlar açıklandı
zaman çizelgesi.
Bu kılavuz, Dokümanlar Sezonu programına başvuran veya bu programa katılan kuruluş yöneticileri için hazırlanmıştır.
Kuruluşunuz, Dokümanlar Dönemi 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 veya 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ıçta bir fikriniz veya hipoteziniz var mı?
- Teknik yazarı işe alma, değerlendirme ve ilk katılım sürecinde yardımcı olacak topluluk üyeleriniz var mı? Ayrıca, proje boyunca (başvuru dönemi dahil olmak üzere 6-8 ay) soruları yanıtlayacak ve başka destek verebilecek kişiler var mı?
- Kuruluş yöneticisi olarak görev yapmak ve başvuruyu oluşturmayı, program yöneticilerinin sorularını yanıtlamayı ve aylık değerlendirmeleri, son değerlendirmeyi ve örnek olayı göndermeyi koordine etmek isteyen bir topluluk üyeniz var mı? Kuruluş yöneticisi ayrıca, Dokümanlar Sezonu programı tamamlandıktan sonra takip anketlerini yanıtlamaya da istekli olmalıdır.
Kuruluşunuz, Open Collective hesabı oluşturma özelliği de dahil olmak üzere program uygunluk koşullarını da karşılamalıdır.
Kuruluş başvuru süreci
Keşif aşaması
Dokümanlar sezonu için başvurular 23 Şubat 2022'de açılsa da kuruluşların, başvurularını göndermeden önce Keşif aşamasındaki adımları tamamlamalarını önemle tavsiye ederiz.
- Proje teklifi sayfası oluşturun. Teklif sayfasında temel ihtiyaçların, hedeflerin veya sorunların listesi, olası belge çözümleri ve olası metrikler yer alır. 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. Nerede soru sormalı, ilgilerini belirtmeli veya projenizle ilgili daha fazla bilgi edinmeliler? Dokümanlar Sezonu hakkında açık kaynak kuruluşunuzla iletişime geçmek için bir e-posta adresi eklemenizi öneririz. Ancak açık kaynak kuruluşunuzla iletişim kurmak için e-posta adresi olarak kişisel bir e-posta adresi kullanmanızı kesinlikle önermeyiz. (Ö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 ilgili kuruluşlar listesine ekleyin. Bağlantınızı Write The Docs Slack'teki #season-of-docs kanalında da paylaşabilirsiniz. Tanıtım ve basın sayfasında, Dokümanlar Sezonu hakkında konuşurken kullanabileceğiniz logolar ve diğer içerikler yer alır.
- Her belgeleme fikrinde, teknik yazarın topluluğunuz ve kuruluşunuzla başarılı bir şekilde çalışmak için hangi deneyime ve niteliklere sahip olması gerektiğini düşünün. Topluluğunuz teknik yazarların gelişmesine hangi becerileri sağlayabilir (örneğin, GitHub'ı veya doküman araç zincirinizi kullanarak)? (Teknik yazarlarla çalışma kılavuzuna bakın.
- Konuyla ilgilenen teknik yazarların sorularını yanıtlamaya yardımcı olacak gönüllülerden yardım isteyin.
- Projenizle çalışmak isteyen teknik yazarların herhangi bir ilgi bildirimini 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. Dikkate alınması gereken bazı noktalar:
- Teknik yazarların en çok ilgisini çeken fikir hangisidir?
- Hangi fikir projenizin en büyük sorununu çözmeye yardımcı olur? Tamamlanma olasılığı daha yüksek olan ama projenizde önemli bir fark yaratmayacak olan 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 bu bilgilere yer verdiğinizden emin olun:
- Ele almak istediğiniz sorun
- İyileştirmek veya oluşturmak istediğiniz dokümanların 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 25 Mart 2022 saat 18:00'e (UTC) kadar gönderin. Kabul edilen teklifler 14 Nisan 2022'de duyurulacaktır.
Proje geliştirme ve raporlama
Proje başlangıç toplantısı
- Kuruluşunuz projeniz için daha önce teknik yazar veya yazar seçtiyse teknik yazarınızla bir başlangıç toplantısı yapın. Çalışma ve düzenli görüşmeler için bir zaman çizelgesi oluşturmak üzere teknik yazarınızla iş birliği yapmalısınız.
- İlgili teknik yazarlardan birden fazla ilgi beyanı aldıysanız teknik yazar seçiminizi herkese açık bir şekilde duyurun veya başvuranları kararınız konusunda bilgilendirin.
Hibe ödemeleri
- Dokümanlar'ın sezonu, 9 Haziran 2022'den itibaren teknik bir yazarla çalışmaya başladıktan sonra her bir kuruluşun Open Collective hesabına hibe fonlarının% 40'ını yatırır. Kuruluşların, proje başlangıcında yapılacak ödeme de dahil olmak üzere proje ara hedefleri doğrultusunda teknik yazarlarla bir ödeme planı oluşturmasını öneririz.
- Kalan% 60, nihai değerlendirmelerini ve örnek olaylarını tamamlayıp gönderen kuruluşların Open Collective hesaplarına 14 Aralık 2022'den itibaren yatırılacaktır. Proje tamamlanma zaman çizelgesine bakılmaksızın (ör. 3 ay ve 6 aylık projeler) tüm başarılı projeler için son ödeme tarihi 14 Aralık 2022'dir.
- Open Collective hesap 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 aylık durum raporlarını bir hafta içinde doldurmalıdır (bağlantı e-postayla gönderilir, bu nedenle lütfen spam klasörünüzü kontrol edin).
Proje son değerlendirmesi ve örnek olay
Kuruluşların, kalan hibe tutarlarını alabilmeleri için hem proje nihai değerlendirmesini hem de örnek olayı 30 Kasım 2022 saat 18:00'e (UTC) kadar doldurup göndermeleri gerekir.
Son değerlendirme
Son değerlendirme formu, en geç bir ay önce 30 Kasım 2022 saat 18:00'de (UTC) kuruluş yöneticilerinin kullanımına sunulacaktır.
Örnek olay
Sezon Dokümanlar örnek olayı, kuruluşunuzun Dokümanlar Dönemi'ne katılımının temel teslimatıdır. Proje güncellemelerinin haftalık kaydını tutmak örnek olayınızı oluşturmanıza yardımcı olur. Her hafta projenin ilerlemesini (alınan istekler, sorunlar veya görüşmeler için gerekli 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. Vaka analizinizi son değerlendirme formunda bağlantı olarak gönderebilirsiniz.
Örnek olayınız Dokümanlar Mevsimi sitesinde yayınlanacak. Projeniz hakkında bilgi eklerken lütfen bu durumu göz önünde bulundurun.
Kuruluşların, Dokümanlar Mevsimi projelerinin zaman içindeki başarısını izlememize 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ş uygulamaları artık kapanmıştır. Gelişmelerden haberdar olmak için season-of-docs-announce adresindeki duyuru posta listesine katılın. |
25 Mart 2022, 18:00 UTC |
| Kuruluş ödeme bilgileri | Bu form henüz kullanılamıyor. |
12 Mayıs 2022, 18:00 UTC |
| Teknik yazar işe alımına dair kanıt | Teknik yazar işe alım aşaması tamamlandı. |
16 Mayıs 2022, 18:00 UTC |
| Aylık değerlendirmeler | Aylık değerlendirme aşaması sona erdi. |
Zaman çizelgesine bakın |
| Nihai proje değerlendirmesi ve örnek olay | Proje değerlendirme aşaması sona erdi. |
30 Kasım 2022, 18:00 UTC |
| Takip anketleri | Form, takip anketleri sırasında kullanılabilir (2 Mayıs 2023). |
Zaman çizelgesine bakın |
İlgili bilgiler
- Dokümanlar dönemi zaman çizelgesini inceleyin.