Mevcut aşama:
Sonuçlar açıklandı
zaman çizelgesi.
Kuruluşunuzun proje teklifini oluşturmak için bu kılavuzu şablon olarak kullanın.
TEKLİF BAŞLIĞI - 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. "Belge İyileştirmeleri" çok muğlak; "Katkıda Bulunan Kılavuzu, SSS Oluşturma ve Stil Kılavuzu Oluşturma Bölüm 5,7,23,99 Güncelleme Bölümleri" çok uzun.
Kuruluşunuz hakkında
Bu bölümde, birkaç kısa paragrafla kuruluşunuz veya projenizden bahsedin. Projeniz hangi sorunları çö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ğlamla ilgili bilgi verin.
Glorious Pickle (mevcut sürüm 1.2.3, ilk sürümü 2009'da kullanıma sunuldu), mümkün olan her bir turşu sebze için mükemmel tuz, şeker, sirke ve baharat oranının kolayca hesaplanabilmesini sağlayan 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 evde yemek yapan şefler, restoran şefleri ve büyük gıda işleme şirketleri ile 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 ve birçok topluluktaki aç insanların beslemesine ve gıda israfını azaltmasına yardımcı olan bir kuruluş. Ayrıca, kullanıcılarımız Glorious Pickle'ın kullanımıyla ilgili olarak bize isteğe bağlı metrikler gönderiyor. Bu metrikleri, makine öğrenimi yoluyla yeni turşu tarifleri oluşturmak için büyük bir veri kümesi olan PickleSet'i oluşturmak için kullanıyoruz.
Projeniz hakkında
Projenizin sorunu
Projenizin çözülmesine yardımcı olacağı sorunu bize anlatın. Bu sorunu çözmek kuruluşunuz veya projeniz için neden önemlidir?
Kullanıcılar, Glorious Pickle aracına yeni baharatlar ve diğer malzemeler (özellikle Avrupa dışındaki mutfaklardan gelen malzemeler) hakkında bilgi ekleyebilmek ister. Maalesef bu bilgileri ekleme süreci iyi belgelenmemiştir. Bu da potansiyel katkıda bulunanların yardım almak için projede bir sorun açmaları (ya da tamamen vazgeçerler) anlamına gelir. Kullanıcılarımızın çoğu profesyonel geliştirici olmasa da süreçte, katkıda bulunanların çekme isteği sürecimizi ve GitHub'ı zaten bildiği varsayılır.
İçerikle ilgili ne kadar fazla bilgiye sahip olursak, Glorious Pickle'ın tüm kullanıcılar için o kadar yararlı olacağı kesin!
Projenizin kapsamı
Kuruluşunuzun hangi belgeleri oluşturacağı, güncelleyeceğini veya iyileştireceğini belirtin. Bazı çalışmalar kasıtlı olarak yapılmıyorsa o bilgiyi de ekleyin. Süre tahminine yer verin ve daha önce projenizde çalışacak gönüllü kuruluş gönüllüleri ve teknik yazar belirleyip belirlemediğinizi belirtin.
Glorious Pickle projesi (kod adlı PicklePlus) şunları yapar:
- Mevcut belgeleri denetleyip en yaygın üç kullanım alanı (yeni malzeme ekleme, varyant malzeme ekleme ve bir malzemeyle ilgili bilgileri güncelleme veya düzeltme) için geçerli belgelerin bir olay günlüğü oluşturun.
- Belgelerdeki boşlukları anlamak için kılavuz olarak sorun günlüğünü kullanarak en yaygın 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" hazırlayın ve GitHub'ı kullanarak işlemlerimizi kullanabilmelerine yardımcı olun.
- Belge test eden kullanıcıların (projedeki gönüllüler) ve daha geniş Glorious Pickle topluluğunun geri bildirimlerini dahil edin.
- Glorious Pickle sitesindeki dokümanları güncellemek ve bundan sonra da güncelleme aracıyla senkronize edilecek bir süreç oluşturmak için sürüm ekibiyle birlikte çalışın.
Bu proje için kapsam dışı olan işler:
- Bu proje, aynı malzemenin farklı yazımları veya adları arasında karşılıklı bağlantılar kurmaya yönelik 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ı verecek.
Bu proje için iki güçlü teknik yazar adayımız var ve bu çalışmanın tamamlanmasının üç ay süreceğini tahmin ediyoruz. GloriousChoosele Pickle olabilecek 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 bileceksiniz? Hangi metrikleri kullanacaksınız ve bunları nasıl takip edeceksiniz?
Glorious Pickle, yeni bileşenler ("malzeme" olarak etiketlenir.) eklemek veya güncellemek için her çeyrekte ortalama on çekme isteği alır. Bu çekme isteklerinin çoğu (>%60) önceki katkıda bulunanlardan gelir. Bu iyileştirilmiş belgelerin, daha fazla çekme isteği ve katkıda bulunan yeni kullanıcılardan daha fazla çekme isteği sağlayacağı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 bulunmasını sağlayacağını düşünüyoruz.
Belgeler 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 belgenin yayınlanmasından sonra aşağıdaki durumlar söz konusuysa projeyi başarılı kabul ederiz:
- Bileşenlerle ilgili çekme isteklerinin sayısı %20 artar
- Yeni katkıda bulunanlardan gelen çekme isteklerinin sayısı %15 arttı
- 3'ten fazla katkıda bulunan katkıda bulunanların sayısı %10 artar (belgeler yayınlandıktan sonra çeyrek başlangıcından itibaren)
Zaman çizelgesi
Bu çalışmanın ne kadar süreceğini tahmin ediyorsunuz? Teknoloji yazarı görevlerini aya/haftaya göre ayırabiliyor musunuz?
Projenin tamamlanması yaklaşık altı ay sürecektir. Teknoloji yazarı işe alındıktan sonra bir ay boyunca teknoloji yazarlarının oryantasyonunu inceleyecek, ardından denetleme ve sorun günlüğüne geçeceğiz. Son birkaç ay boyunca belge 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 eklemenizi öneririz.
- Tüm bütçeler ABD doları cinsinden olmalıdır. Hibelerin 5000 ABD Doları ile 15.000 ABD Doları arasında değişmesini bekliyoruz. Projeniz bu aralığın dışındaysa, lütfen bütçenizi gerekçelendirecek ek bilgiler sağlayın.
- Bütçenizin büyük bir kısmının (minimum% 60-70) projenizde çalışan teknik yazarlara ayrılmasını bekliyoruz. Mümkün olduğunda proje bazlı bütçe hazırlamanızı öneririz.
- Açık kaynak projelerinin mümkün olduğunda açık kaynak araçları kullanmasını bekliyoruz. Projeniz özel yazılım lisansları veya desteği için mutlaka fonlar gerektiriyorsa lütfen tutar için bir gerekçe ekleyin.
- Diğer olası harcamalar şunlardır:
- Belgeleme 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 (katılımcılarınız için tişört veya çıkartmalar) için minimum tutar (200 ABD dolarından az). Dokümanlar Sezonu logosunu kullanıyorsanız buna, proje veya kuruluşunuzun logosu ya da adınız eşlik etmelidir. Promosyonunuzda Google adı kullanılamaz.
- Projede önemli ölçüde mentorluk veya rehberlik pozisyonları üstlenen gönüllüler için asgari burslar (gönüllü başına 500 ABD dolarından fazla bütçe ayırmamanızı öneririz)
- Diğer açık kaynak projelere yönelik aşağı akış bağışları, toplam bütçenizin% 10'undan fazla olmamalıdır.
- Gerektiğinde diğer bütçe kalemlerini ve istenen tutarın gerekçesini ekleyin. Gider gerekçelendirmeleri, harcamaların bir bütün olarak projenin 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 dokümanları denetleme, güncelleme, test etme ve yayınlama | 5000,00 | 5000,00 | |
| Gönüllü bursları | 500 | 6500.00 | 3 gönüllü bursu x 500 |
| Proje tişörtleri (10 tişört) | 150.00 | 6.650,00 | |
| Şişirilebilir dev tek boynuzlu at (4 metrelik versiyon) | 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 diğer bilgileri buraya ekleyin.
Teknik yazarlarla veya belgelemeyle ilgili önceki deneyim: Siz veya mentorlarınızdan herhangi biri daha önce teknik yazarlarla çalıştıysanız veya 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 tüm inceleme süreçlerini veya teknik yazarın becerilerinin projenize ne açıdan faydalı olduğunu açıklayın. Bu deneyimin, Dokümanlar Sezonu'nda bir teknik yazarla çalışmanıza nasıl yardımcı olabileceğini açıklayın.
Sezon of Docs, Google Summer of Code veya diğerlerine önceki katılım: Siz veya mentorlarınızdan biri Google Summer of Code'a veya benzer bir programa katıldıysanız başvurunuzda bundan bahsedin. Programdaki başarılarınızı anlatın. Bu deneyimin Dokümanlar Dönemi'nde çalışma şeklinizi nasıl etkileyebileceğini açıklayın.