Mevcut aşama:
Belge geliştirme Zaman çizelgesini inceleyin.
Kuruluşunuzun proje teklifini oluşturmak için bu kılavuzu şablon olarak kullanın.
PROPOSAL TITLE - kuruluş adı
Teklif başlığınız kısa ve spesifik olmalıdır. "ORGNAME Katkıda Bulunan Kılavuzu'nu güncelleyin" iyi bir teklif başlığıdır. "Dokümantasyon İyileştirmeleri" çok belirsiz; "Katkıda Bulunan Kılavuzu, Oluşturma SSS ve Stil Kılavuzu Oluşturma Bölüm 5,7,23,99'daki güncelleme" çok uzun.
Kuruluşunuz hakkında
Bu bölümde, birkaç kısa paragrafla bize kuruluşunuzdan veya projenizden bahsedin. Projeniz hangi sorunu çözüyor? Kullanıcılarınız ve katkıda bulunanlar kimlerdir? Kuruluşunuz veya projeniz ne kadar süredir faaliyet gösteriyor? Teklifinizi finanse etmenin açık kaynakta ve dünyada neden olumlu bir etki yaratacağını anlamamıza yardımcı olmak için bağlam hakkında biraz bilgi verin.
Glorious Pickle (geçerli sürüm 1.2.3, ilk olarak 2009'da yayınlandı), tek bir bebek salatasından tek bir bebek salatalığından turp konteynerine kadar çeşitli miktarlarda mümkün olan her bir turşu sebze için tuz, şeker, sirke ve baharatların mükemmel oranını kolayca hesaplayan, MIT lisanslı bir kitaplıktır. Katkıda bulunanlarımız dünyanın her yerinden turşu meraklıları ve kullanıcılarımız ise evlerinde şefler, restoran şefleri ve büyük gıda işleme şirketleri ve kuruluşlarında lojistik alanında çalışan kişiler. En büyük kullanıcımız, gıda bankalarının kısa ömürlü sebzeleri istikrarlı turşu kavanozlarına dönüştürmesine yardımcı olarak birçok topluluktaki aç insanların beslenmesine ve gıda israfını azaltmasına yardımcı olan bir kuruluştur. Ayrıca, kullanıcılarımız Glorious Pickle'ı kullanımıyla ilgili isteğe bağlı metrikler gönderiyor. Bu metrikleri makine öğrenimi yoluyla yeni turşu tarifleri oluşturmaya yönelik büyük bir veri kümesi olan PickleSet'i oluşturuyoruz.
Projeniz hakkında
Projenizin sorunu
Projenizin çözmeye yardımcı olacağı sorun hakkında bize bilgi verin. Bu sorunu çözmek kuruluşunuz veya projeniz için neden önemli?
Kullanıcılar Glorious Pickle aracına yeni baharatlar ve diğer malzemeler (özellikle Avrupa dışındaki mutfaklardan gelen malzemeler) hakkında bilgi ekleyebilmek istiyor. Ne yazık ki bu bilgilerin eklenmesi süreci iyi belgelenmemiş. Bu da potansiyel katkıda bulunanların yardım almak için projede bir sorun açması (ya da tamamen vazgeçiyor) anlamına geliyor. Kullanıcılarımızın birçoğu profesyonel geliştirici olmasa da süreçte, katkıda bulunanların pull isteği sürecimizi ve GitHub'ı zaten bildiği varsayılır.
Elimizde ne kadar çok malzeme bilgisi olursa Glorious Pickle tüm kullanıcılarımız için o kadar kullanışlı olur!
Projenizin kapsamı
Kuruluşunuzun hangi belgeleri oluşturacağı, güncelleyeceğini veya iyileştireceğini belirtin. Kasıtlı olarak yapılmayan bir iş varsa bu bilgiyi de ekleyin. Süre tahminine yer verin ve projenizde çalışacak gönüllüleri ve teknik yazarları belirleyip belirlemediğinizi belirtin.
Glorious Pickle projesi (kod adlı PicklePlus) için:
- Mevcut belgeleri denetleyin ve en yaygın üç kullanım alanı (yeni bir malzeme ekleme, bir varyant malzeme ekleme ve bir malzemeyle ilgili bilgileri güncelleme veya düzeltme) için mevcut belgelerin sorunsuz bir günlüğünü oluşturun.
- Belgelerdeki boşlukları anlamak için kılavuz olarak sorun günlüğünü kullanarak en iyi kullanım alanları için güncellenmiş belgeler oluşturun.
- Yeni katkıda bulunanların istek çekmesine yardımcı olmak için kısa bir "yardımcı kısa not" ve işlemimizi kullanabilmelerine yardımcı olmak için GitHub oluşturun.
- Belge test kullanıcılarından (projedeki gönüllüler) ve daha geniş kapsamlı Glorious Pickle topluluğundan geri bildirimler alın.
- Glorious Pickle sitesindeki dokümanları güncellemek ve bundan sonra, dokümanların güncelleme aracıyla senkronize olmasını sağlayacak bir süreç oluşturmak için sürüm ekibiyle birlikte çalışın.
Bu proje için kapsam dışı olan çalışmalar:
- Bu proje, aynı bileşenin farklı yazımları veya adları arasında çapraz bağlantılar oluşturmak için bir süreç oluşturmaz.
- Bu proje herhangi bir GitHub eğiticisi oluşturmayacak. Bunun yerine yardımcı kısa bilgiler, alakalı ve yararlı olan mevcut materyallere bağlantı oluşturacaktır.
Bu proje için iki güçlü teknik yazım adayımız var ve bu çalışmanın tamamlanmasının üç ay alacağını tahmin ediyoruz. GloriousPickle PickleDocs SIG ve @Glorious PicklePat (malzeme ekleme API'sinin temel koruyucusu) projeyi desteklemeyi taahhüt ediyor.
Projenizin başarısını ölçme
Yeni belgelerinizin sorununuzu çözmeye yardımcı olduğunu nasıl anlayacaksınız? Hangi metrikleri kullanacaksınız ve bunları nasıl takip edeceksiniz?
Glorious Pickle, yeni malzemelerin ("malzeme" olarak etiketlenmiş) her çeyrekte eklenmesi veya güncellenmesi için ortalama on pull isteği alıyor. Bu çekme isteklerinin çoğunluğu (>%60) önceki katkıda bulunanlardan gelmektedir. Bu iyileştirilmiş belgelemenin, daha fazla çekme isteği ve katkıda bulunan yeni kullanıcılardan daha fazla pull isteği ile sonuçlanacağına inanıyoruz. Aktif olarak katkıda bulunan kullanıcılarımızın çoğu malzeme ekleyerek başladığı için bu dokümanları iyileştirmenin toplamda daha fazla aktif katkıda bulunan kişi olmasını sağlayacağını düşünüyoruz.
Dokümanlar yayınlandıktan sonra her ay iki metriği (içerikle ilgili çekme isteklerinin sayısı ve yeni katkıda bulunanlardan gelen çekme isteklerinin sayısı) izleyeceğiz. Dokümanlar yayınlandıktan sonra üç ayda bir başlayarak toplamda üçten fazla katkı yapan katkıda bulunanların sayısını da takip edeceğiz.
Yeni belgelerin yayınlanmasından sonra:
- Bileşenlerle ilgili pull isteklerinin sayısı %20 artıyor
- Katkıda bulunan yeni kullanıcılardan gelen pull isteklerinin sayısı %15 arttı
- 3'ten fazla katkıda bulunan katkıda bulunanların sayısı %10 artar (dokümanlar yayınlandıktan sonra çeyrek başlar)
Zaman Çizelgesi
Bu çalışmanın ne kadar süreceğini tahmin ediyorsunuz? Teknoloji yazarı görevlerini aya veya haftaya göre analiz edebiliyor musunuz?
Projenin tamamlanması yaklaşık altı ay sürecektir. Teknoloji yazarı işe alındığında, bir ay boyunca teknoloji yazarlarını oryantasyona ayıracağız, ardından denetim ve ek sorun günlüğüne geçeceğiz. Ayrıca son birkaç ay belgeleri oluşturmaya odaklanacağız.
| Tarihler | İşlem Öğeleri |
|---|---|
| Mayıs | Yön |
| Haziran - Ağustos | Mevcut belgeleri denetleme ve sorun günlüğü oluşturma |
| Eylül - Ekim | Doküman oluşturun |
| Kasım | Projenin tamamlanması |
Proje bütçesi
Genel yönergeler
- Bütçenizi teklifinize veya ayrı bir bağlantı olarak ekleyebilirsiniz. Bütçeniz 10 öğeden azsa bunu teklifinize dahil etmenizi öneririz.
- Tüm bütçeler ABD doları cinsinden olmalıdır. Hibelerin 5.000 ABD doları ile 15.000 ABD doları arasında olmasını bekliyoruz. Projeniz bu aralığın dışındaysa, bütçenizi gerekçelendirmek için ek bilgiler sağlayın.
- Bütçenizin büyük bir kısmının (en az% 60-70) projenizde çalışan teknik yazarlara ayrılmasını bekliyoruz. Mümkün olduğunda proje bazlı bütçe belirlemenizi öneririz.
- Açık kaynak projelerde mümkün olduğunda açık kaynak araçlar kullanılmasını bekleriz. Projeniz özel yazılım lisansları veya desteği için mutlaka finansmana ihtiyaç duyuyorsa tutar için bir gerekçe ekleyin.
- Diğer olası harcamalar şunlardır:
- Belge siteniz için marka bilinci oluşturma, logolar, şablonlar veya başka tasarım öğeleri oluşturmak üzere çalışma tasarlama
- Proje promosyon ürünleri için minimum tutar (200 ABD dolarından az) (katılımcılarınız için tişört veya çıkartmalar). Google Belgeler Sezonu logosunu kullanıyorsanız buna projenizin veya kuruluşunuzun logosu ya da adı eşlik etmelidir. Promosyonlarınızda Google adı kullanılamaz.
- Projede kayda değer danışmanlık veya rehberlik rolleri üstlenen gönüllüler için minimum burslar (Gönüllü başına 500 ABD dolarından fazla olmamasını öneririz)
- Diğer açık kaynak projelerine yönelik satış için yapılacak bağışlar, bütçenizin toplamının% 10'undan fazla olmamalıdır.
- Gerekirse diğer bütçe kalemlerini ve istenen tutarın gerekçesini ekleyin. Gider gerekçelendirmeleri, harcamaların projenin bir bütün olarak başarısına nasıl katkıda bulunacağını vurgulamalıdır.
Örnek bütçe
| Bütçe öğesi | Tutar | Değişen Toplam | Notlar/gerekçeler |
|---|---|---|---|
| Glorious Pickle için malzeme ekleme işlemiyle ilgili yeni belgeleri denetleme, güncelleme, test etme ve yayınlama | 5000,00 | 5000,00 | |
| Gönüllü bursları | 500 | 6.500,00 | Her biri 500 değerinde olmak üzere 3 gönüllü bursu |
| Proje tişörtleri (10 tişört) | % | 6650,00 | |
| 4,5 metrelik şişme dev tek boynuzlu at | 99,99 | 6.749,99 | Proje geliştirme döneminde teknik yazarın sorularına en hızlı şekilde yanıt veren ekibe şişme tek boynuzlu atı vereceğiz. |
| TOPLAM | 6.749,99 |
Ek bilgiler
Teklifinizle ilgili tüm ek bilgileri buraya ekleyin.
Teknik yazarlar veya dokümanlarla ilgili önceki deneyimleriniz: Siz veya mentorlarınız daha önce teknik yazarlarla çalıştıysanız ya da belge geliştirdiyseniz başvurunuzda bunu belirtin. Ürettiğiniz belgeleri ve teknik yazarla çalışma yöntemlerinizi açıklayın. Örneğin, kullandığınız inceleme süreçlerini veya teknik yazarın becerilerinin projenize ne açıdan faydalı olduğunu açıklayın. Bu deneyimin, Google Dokümanlar Sezonu'nda teknik yazarla çalışmanıza nasıl yardımcı olabileceğini açıklayın.
Google Dokümanlar Sezonu, Google Summer of Code veya diğerlerine önceki katılım: Siz veya mentorlarınızdan herhangi biri Google Summer of Code'a veya benzer bir programa katıldıysanız bu bilgiyi başvurunuzda belirtin. Bu programdaki başarılarınızı anlatın. Bu deneyimin Google Dokümanlar Sezonu'nda çalışma şeklinizi nasıl etkileyebileceğini açıklayın.