Mevcut aşama:
Projenin tamamlanması. Zaman çizelgesine bakın.
Kuruluşunuzun proje teklifini oluşturmak için bu kılavuzu şablon olarak kullanın.
ÖNERİ BAŞLIĞI - kuruluş adı
Teklif başlığınız kısa ve net olmalıdır. "ORGNAME Katkıda Bulunan Kılavuzu'nu Güncelleme" iyi bir teklif başlığıdır. "Doküman İyileştirmeleri" çok belirsiz; "Katkıda Bulunanlar Kılavuzu'nun 5, 7, 23, 99. Bölümlerini Güncelleme, SSS Oluşturma ve Stil Kılavuzu Oluşturma" çok uzun.
Kuruluşunuz hakkında
Bu bölümde, kuruluşunuz veya projeniz hakkında birkaç kısa paragrafta bilgi verin. Projeniz hangi sorunu çözüyor? Kullanıcılarınız ve katkıda bulunanlarınız kimler? Kuruluşunuz veya projeniz ne kadar süredir faaliyette? Teklifinizi finanse etmenin açık kaynak ve dünya üzerinde neden olumlu bir etki yaratacağını anlamamıza yardımcı olacak bazı bilgiler verin.
GloriousPickle (mevcut sürüm 1.2.3, ilk sürüm 2009'da yayınlandı), turşu yapılabilir her sebze için tuz, şeker, sirke ve baharatların mükemmel oranını tek bir küçük salatalıktan konteyner gemisi dolusu turpa kadar değişen miktarlarda kolayca hesaplamak amacıyla MIT lisanslı bir kitaplıktır. Katkıda bulunanlarımız dünyanın dört bir yanından turşu tutkunları, kullanıcılarımız ise ev şefleri, restoran şefleri ve büyük gıda işleme şirketleri ile kuruluşların lojistik departmanlarında çalışan kişilerdir. En büyük kullanıcımız, gıda bankalarının kısa raf ömrü olan sebzeleri turşu kavanozlarına dönüştürmesine yardımcı olan bir kuruluştur. Bu kuruluş, birçok toplulukta aç insanları beslemeye ve gıda israfını azaltmaya yardımcı olur. Ayrıca kullanıcılarımız, GloriousPickle'ı kullanımlarıyla ilgili isteğe bağlı metrikleri bize gönderir. Bu metrikleri, makine öğrenimi aracılığıyla yeni turşu tarifleri oluşturmak için kullandığımız büyük bir veri kümesi olan PickleSet'i oluşturmak için kullanırız.
Projeniz hakkında
Projenizin sorunu
Projenizin çözüme ulaştıracağı sorundan bahsedin. Bu sorunun kuruluşunuz veya projeniz için çözülmesi neden önemlidir?
Kullanıcılar, GloriousPickle aracına yeni baharatlar ve diğer malzemeler (özellikle Avrupa dışındaki mutfaklardan malzemeler) hakkında bilgi eklemek istiyor. Maalesef bu bilgileri ekleme süreci iyi belgelenmemiş. Bu da potansiyel katkıda bulunanların yardım almak için projede bir sorun açması gerektiği anlamına geliyor (veya tamamen vazgeçiyorlar). Ayrıca, kullanıcılarımızın çoğu profesyonel geliştirici olmasa da bu süreçte, katkıda bulunanların pull isteği sürecimiz ve GitHub'ı zaten bildiği varsayılır.
Ne kadar çok içerik bilgisi paylaşırsanız GloriousPickle tüm kullanıcılarımız için o kadar faydalı olur.
Projenizin kapsamı
Kuruluşunuzun oluşturacağı, güncelleyeceği veya iyileştireceği dokümanlar hakkında bilgi verin. Bazı çalışmalar kasıtlı olarak yapılmıyorsa bu bilgileri de ekleyin. Bir zaman tahmini ekleyin ve projenizle birlikte çalışacak gönüllü kuruluş üyeleri ve teknik yazar olup olmadığınızı belirtin.
GloriousPickle projesi (kod adı PicklePlus), şunları yapacaktır:
- Mevcut dokümanları denetleyin ve en çok kullanılan üç kullanım alanı (yeni bir bileşen ekleme, varyant bileşen ekleme ve bir bileşenle ilgili bilgileri güncelleme veya düzeltme) için mevcut dokümanların sorun günlüğünü oluşturun.
- Dokümanlar arasındaki boşlukları anlamak için rehber olarak zorluk günlüğünü kullanarak en popüler kullanım alanları için güncellenmiş dokümanlar oluşturun.
- Pull isteklerinde ve GitHub'da yeni olan katkıda bulunanların sürecimizi kullanabilmeleri için hızlı bir "kılavuz" oluşturun.
- Doküman test kullanıcılarından (projedeki gönüllülerden) ve GloriousPickle topluluğunun geri bildirimlerini dahil edin.
- GloriousPickle sitesindeki dokümanları güncellemek ve dokümanları güncelleme aracıyla senkronize tutmak için sürüm ekibiyle birlikte çalışın.
Bu projenin kapsamı dışında kalan çalışmalar:
- Bu proje, aynı bileşenin farklı yazım veya adları arasında çapraz bağlantı oluşturma işlemi gerçekleştirmez.
- Bu projede GitHub eğiticileri oluşturulmaz. Bunun yerine, ipuçlarının yer aldığı sayfada alakalı ve faydalı mevcut materyallere bağlantı verilir.
Bu proje için iki güçlü teknik yazım adayımız var ve bu çalışmanın tamamlanmasının üç ay süreceğini tahmin ediyoruz. GloriousPickle PickleDocs SIG ve @GloriousPicklePat (içerik ekleme API'sinin temel geliştiricisi), projeyi destekleme sözü verdi.
Projenizin başarısını ölçme
Yeni dokümanlarınızın sorununuzu çözmeye yardımcı olduğunu nasıl anlarsınız? Hangi metrikleri kullanacak ve bunları nasıl izleyeceksiniz?
GloriousPickle, üç ayda ortalama on tane yeni içerik ekleme veya güncelleme ("ingredient" etiketli) isteği alır. Bu alma isteklerinin çoğu (>%60) önceki katkıda bulunanlardan gelir. Bu iyileştirilmiş dokümanların, daha fazla çekme isteği ve yeni katkıda bulunanlardan daha fazla çekme isteği alacağımıza inanıyoruz. Etkin katkıda bulunanlarımızın çoğu, içeriklere içerik eklemeye başladığından bu dokümanları iyileştirmenin genel olarak daha fazla etkin katkıda bulunanla sonuçlanacağını düşünüyoruz.
Dokümanlar yayınlandıktan sonra iki metriği (bileşenle ilgili çekme isteklerinin sayısı ve yeni katkıda bulunanların çekme isteklerinin sayısı) aylık olarak izleriz. Ayrıca, dokümanlar yayınlandıktan sonra üçten fazla katkıda bulunanların sayısını üç ayda bir takip edeceğiz.
Yeni dokümanların yayınlanmasından sonra projenin başarılı olduğunu düşünürüz:
- İçerikle ilgili çekme isteklerinin sayısı %20 artar
- Yeni katkıda bulunanların gönderdiği çekme isteklerinin sayısı %15 artar
- 3'ten fazla katkıda bulunanların sayısı %10 artar (dokümanlar yayınlandıktan sonraki çeyrekten itibaren)
Zaman çizelgesi
Bu çalışmanın ne kadar süreceğini tahmin ediyorsunuz? Teknik yazar görevlerini aya veya haftaya göre ayırabiliyor musunuz?
Projenin tamamlanması yaklaşık altı ay sürecektir. Teknik yazar işe alındıktan sonra bir ay boyunca teknik yazar oryantasyonu, ardından denetim ve sorun günlüğü, son birkaç ay ise doküman oluşturmaya odaklanacağız.
| Tarihler | İşlem Öğeleri |
|---|---|
| Mayıs | Yön |
| Haziran - Ağustos | Mevcut dokümanları denetleme ve sorun günlüğü oluşturma |
| Eylül - Ekim | Doküman oluşturma |
| 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 on öğeden azsa teklifinize eklemenizi öneririz.
- Tüm bütçeler ABD doları cinsinden olmalıdır. Hibelerin 5.000 ila 15.000 ABD doları arasında olmasını bekleriz. Projeniz bu aralığın dışındaysa bütçenizi gerekçelendirmek için ek bilgi sağlayın.
- Bütçenizin büyük kısmının (en az% 60-70) projeniz üzerinde çalışan teknik yazara ayrılmasını bekliyoruz. Mümkün olduğunda proje bazında bütçe oluşturmanızı öneririz.
- Açık kaynak projelerinin mümkün olduğunda açık kaynak araçları kullanmasını bekleriz. Projeniz için tescilli yazılım lisansları veya destek için kesinlikle paraya ihtiyaç varsa tutarın gerekçesini ekleyin.
- Diğer olası harcamalar şunlardır:
- Doküman siteniz için marka, logo, şablon veya diğer tasarım öğeleri oluşturmak üzere tasarım çalışmaları
- Proje hediyeleri (katılımcılarınız için tişörtler veya çıkartmalar) için minimum tutarlar (<200 ABD doları). Google Dokümanlar Sezonu logosunu kullanıyorsanız projenizin veya kuruluşunuzun logosu ya da adıyla birlikte kullanmanız gerekir. Hediyelerinizde Google adını kullanılamaz.
- Projede önemli mentorluk veya rehberlik rolleri üstlenen gönüllülere minimum ücret (gönüllü başına en fazla 500 ABD doları önerilir)
- Diğer açık kaynak projelerine yapılan bağışlar, toplam bütçenizin% 10'undan fazla olmamalıdır.
- İstenilen tutarın gerekçesiyle birlikte gerektiğinde diğer bütçe öğelerini ekleyin. Harcama gerekçeleri, harcamanın projenin genel 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 |
|---|---|---|---|
| Teknik yazar, GloriousPickle için içerik ekleme sürecine ait yeni dokümanları denetleyip güncelleyin, test edin ve yayınlayın. | 5000,00 | 5.000,00 | |
| Gönüllülere verilen ek ödemeler | 500 | 6.500,00 | 3 gönüllü harcırahı x 500 |
| Proje tişörtleri (10 tişört) | 150,00 | 6.650,00 | |
| Dev şişme tek boynuzlu at (4,5 metrelik sürüm) | 99,99 | 6749,99 | Şişme tek boynuzlu atı, proje geliştirme döneminde teknik yazarın sorularını en hızlı yanıtlayan ekibe vereceğiz. |
| TOPLAM | 6749,99 |
Ek bilgiler
Önerinizle ilgili ek bilgileri buraya ekleyin.
Teknik yazarlarla veya dokümanlarla ilgili önceki deneyimler: Siz veya mentorlarınızdan biri daha önce teknik yazarlarla çalıştıysa ya da doküman geliştirdiyseniz bunu başvurunuzda belirtin. Hazırladığınız dokümanları ve teknik yazarla çalışma şeklinizi açıklayın. Örneğin, kullandığınız inceleme süreçlerini veya teknik yazarın becerilerinin projenize nasıl fayda sağladığını açıklayın. Bu önceki deneyimin, Google Dokümanlar Sezonu'nda teknik bir yazarla çalışmanıza nasıl yardımcı olabileceğini açıklayın.
Google Dokümanlar Sezonu, Google Yaz Kodu veya başka programlara daha önce katılım: Siz veya mentorlarınızdan biri Google Yaz Kodu veya benzer bir programa katıldıysanız bunu başvurunuzda belirtin. Bu programdaki başarılarınızı açıklayın. Bu deneyimin, Google Dokümanlar Sezonu'nda çalışma şeklinizi nasıl etkileyebileceğini açıklayın.