Mevcut aşama:
Sonuçlar açıklandı. Zaman çizelgesini inceleyin.
Kendi örnek olay raporunuzu oluşturmanıza yardımcı olması için bu örneği kullanın.
PicklePlus: Glorious Pickle Katkı Aracını Belgeleme
Kuruluş veya Proje: Glorious Pickle'ın kuruluşunuzun veya projenizin ana sitesinin bağlantısını burada
Kuruluş Açıklaması: Glorious Pickle (geçerli sürüm 1.2.3, ilk olarak 2009'da kullanıma sunuldu.), tek bir bebek salatalığından tek bir bebek salatalığından turp konteynerlerine kadar çeşitli miktarlarda olası tuz, şeker, sirke ve baharatların tuz, şeker, sirke ve baharat oranının kolayca hesaplanabilmesini sağlayan MIT lisanslı bir kitaplıktır.
Yazarlar: isteğe bağlı: örnek olayın yazarlarını listeleyin; istenirse kullanıcı adlarını kullanın
Sorun Bildirimi/Teklif Özeti
Yeni veya iyileştirilmiş dokümanlarla hangi sorunu çözmeye çalışıyordunuz? Mümkünse proje sitenizdeki teklif sayfasına bağlantı verin.
Glorious Pickle aracının malzeme veritabanına bileşen eklemek zaman alıcı, karmaşık ve araçta iyi dokümanlar yok. Katkıda bulunan çoğu kullanıcının git kullanımı veya pull istekleri oluşturma deneyimi yoktur. Bu durum, Glorious Pickle'ın malzeme verilerimizde ciddi eksiklikler olduğu ve aracımızı daha az kullanışlı hale getirdiği anlamına geliyor. Yeni malzemelerin eklenmesiyle ilgili dokümanları geliştirerek yeni katılımcıları ve daha fazla turşuyu teşvik etmeyi umuyoruz.
Proje Açıklaması
Teklifi oluşturma
Google Dokümanlar Sezonu teklifinizi nasıl oluşturdunuz? Kuruluşunuz bir fikre karar vermek için hangi süreci kullandı? Geri bildirimleri nasıl topladınız ve projeye nasıl dahil ettiniz?
Glorious Pickle Pickle olabilecek SIG, Google Dokümanlar Sezonu programını Google'ın Açık Kaynak Programlar Ofisi'nden bir tweet'le duymuş. SIG, iki haftada bir düzenlediği toplantıda program hakkında konuştu ve bir teklif oluşturmayı kabul etti. SIG'nin iki üyesi (@KimChiCook ve @Dillicious), bir sonraki toplantıda incelenmesi için taslak öneri üzerinde çalışmaya gönüllü oldu.
PickleDokümanlar SIG teklif taslağı üzerinde anlaştıktan sonra, daha kapsamlı proje için geri bildirim isteyen bir e-posta gönderildi. Malzeme ekleme API'sinin geliştiricisi @Glorious PicklePat'in de aralarında olduğu on dört topluluk üyesi geri bildirimde bulundu. @Glorious PicklePat program boyunca kaynak olmaya gönüllü oldu.
Alınan geri bildirim tartışılıp değerlendirildikten sonra, teklif, oylamak üzere Glorious Pickle Proje Yönlendirme Komitesi'ne gönderildi. GPPSC'nin beş üyesi de teklifin ve başvurunun gönderilmesi için +1'e oy verdi ve @VinegarViv, programa katılmak ve ödemeleri denetlemek için gereken Open Collective hesabının oluşturulmasına yardımcı olmayı kabul etti.
Bütçe
Bütçenize kısa bir bölüm ekleyin. Çalışmayı nasıl tahmin ettiniz? Beklenmedik harcamalar var mıydı? Hibe ödülünden daha az harcama yaptınız mı? Fonları doğru şekilde paylaştınız mı yoksa bütçede daha fazla/daha az/gereksiz mi bütçe ayırdınız? Google Dokümanlar'ın Google Sezonu dışında kullanabileceğiniz başka bir kaynak oldu mu?
Glorious Pickle Pickle olabilecek SIG üyesinin iki üyesi, biri Avrupa'da, diğeri Arjantin'de olmak üzere teknik yazar olarak çalışmıştı. Çalışmaları tahmin etmemize ve daha önce yaptıkları taslak teklif çalışmasını karşılaştırarak benzer proje bütçeleri bulmamıza yardımcı oldular. Ayrıca, projeye ayırdığımız 2019 PicklePals kongresinden kalan 1.000 ABD doları da sınırsız sponsorluk paramız vardı.
Öngörülemeyen bir harcama, teknik yazarımızın yangından etkilenen ve evinde internet erişimini kaybettiği bir bölgede kablosuz hotspot kiralamasına yardımcı oldu. Ayrıca katılımcılara planladığımızdan daha az tişört göndermeyi de başardık. Bu nedenle de dengeyi koruduk.
Ayrıca, teknik yazarın hazırladığı belgelerin metin düzenleme ve düzeltmeler aşamalarında yardımcı olması için, Glorious Pickle'a katkıda bulunan @Piccalily'ye (bir zamanlar sadece profesyonel metin editörlüğü yapan) ödeme yapmaya karar verdik.
Katılımcı sayısı
Bu projede kimler çalıştı (katılımcılar tarafından istenirse kullanıcı adlarını kullanabilir)? Teknik yazarınızı nasıl bulup işe aldınız? Diğer gönüllüleri veya ücretli katılımcıları nasıl buldunuz? Hangi roller üstlendiler? Ayrılan oldu mu? İşe alım, iletişim ve proje yönetimi hakkında neler öğrendiniz?
Bu projede çalışan çekirdek ekip:
- @Dillicious, @KimChiCook (Pickle bekleyen SIG)
- @Piccalily (kopya düzenleyici)
- @GherKen, @VinegarViv (yönetici yardımı, GPPSC)
- @BBChips, @Glorious PicklePat (konu uzmanları)
- Sam Scribe (teknik yazar)
Sam Scribe'ı Google Dokümanlar GitHub deposu listesinde bulduk. Bu kişilerin deneyimlerinin (Sam bir yemek dergisinde çalışmış ve web siteleri için dokümanlar hazırlamış) projemizle uyumlu olduğunu düşündük. Sam, iki haftada bir yapılan PickleDocument SIG telefon görüşmesine katıldı ve proje hakkında bizimle konuşarak teklife dahil ettiğimiz çok değerli birkaç öneride bulundu. SIG üyelerimizin ağları aracılığıyla tanıdığımız iki teknik yazarla da iletişime geçtik, ancak bunların ikisi de program süresince söz konusu yazarlara ulaşamadık.
Cem'in saat dilimi PickleDokümanlar SIG üyesi olanların çoğu için yalnızca birkaç saat çakıştığından, tartışma forumumuzda, Sam'in saat diliminde olan ve malzeme ekleme işlemini bilen Picklers için bir telefon görüşmesi gönderdik. @BBChips, Sam'in sorularını yanıtlamak ve gerektiğinde başka uzmanlar bulmalarına yardımcı olmak için gönüllü oldu. @Glorious PicklePat, Sam'in aracın temel mimarisini ve API'den gelecek olası hata mesajlarını anlamasına yardımcı olmak için gönüllü oldu ve GitHub ile git yardımı sağladı.
Ne yazık ki programın ortasında @VinegarViv kişisel nedenlerle projeden bir adım geri çekilmek zorunda kaldı. GPPSC üyesi @GherKen, yönetim ve ödemeyle ilgili soruları yanıtlamak için devreye girdi.
Eksik sorulardan (Glorious Pickle ücretsiz bir Slack örneği kullanıyor ve bazen tartışmalar o kadar hızlı ilerliyor ki, kayan arşiv sınırı nedeniyle sohbetlerimiz kayboluyor), çalışan soruların bir listesini paylaşılan bir dokümanda tutmamız gerektiğini öğrendik (paylaşılan bir Google Dokümanı kullandık). PickleDokümanlar SIG üyeleri her toplantıdan önce bunu kontrol etmiş ve toplantı bitmeden önce cevaplarını almaya dikkat etmişti. Cem, acil sorular için @BBChips'e doğrudan ping atabildi.
Sam ve Sam ile çalışmaktan çok memnunuz. Glorious Pickle belgelerini güncelleyerek, kendi halinde de meraklı bir seçici olduk.
Zaman çizelgesi
Projenizin zaman çizelgesine ilişkin kısa bir genel bakış sunun (tahmini bitiş tarihini veya proje devam ediyorsa ara hedefleri belirtin).
Google Dokümanlar Sezonu Programı'nın katılan kuruluşları duyurmasını beklerken PickleDocument SIG üyeleri, Sam'in işine yarayacağını düşündüğümüz eski çalışmaları aradı. Bir ay boyunca, durmuş belgeleri güncellemeye yönelik daha önceki bir çalışmada bazı notlar aldık. Ayrıca, Google Opendocs deposundaki doküman olgunluğu denetimi malzemelerinin bazı bölümleri üzerinde çalıştık.
Google Dokümanlar Mevsimi için seçildiğimizi öğrendiğimizde, Sam ve PickleDokümanlar SIG'yle tanışıp kaba bir program hazırladık.
| Aşama | Tamamlayan: |
|---|---|
| Doküman denetimini inceleyin | 7 Mayıs |
| Sorun günlüğü 3 kullanım alanları | 14 Mayıs |
| @Glorious PicklePat ve @BBChips ile soruşturma günlüklerini inceleme, sorguları yanıtlama | 28 Mayıs |
| Güncellenen dokümanların ilk taslağı kullanım alanı 1 | 25 Haziran |
| Kullanım alanı 1 taslak | 2 Temmuz |
| Güncellenen dokümanların ilk taslağı kullanım alanı 2 | 2 Temmuz |
| Kullanım alanı 2 taslağı @Glorious PicklePat ve @Dillicious tarafından incelendi | 9 Temmuz |
| Güncellenen dokümanların ilk taslağı kullanım alanı 3 | 9 Temmuz |
| @Dillicious ve @KimChiCook tarafından incelenen kullanım alanı 3 taslağı | 16 Temmuz |
| Tüm kullanım alanlarında yanıtlanmış tüm sorgular | 30 Temmuz |
| PickleDokümanlar SIG'nin çoğu 1-20 Ağustos tarihleri arasında tatildeydi | -- |
| Topluluktaki yeni dokümanları test etmeye başlayın (Glorious Pickle sitesinde taslak olarak yayınlanan dokümanlar) | 21 Ağustos |
| Test geri bildirimleri dahil edildi | 10 Eylül |
| Yeni belgeleri kopyalayın ve gözden geçirin | 17 Eylül |
| Dokümanların taslak durumu kaldırıldı, dokümanlar resmi olarak kullanıma sunuldu | 28 Eylül |
| Oluşturulan belgeleri güncelleme süreci | 1 Kasım |
| Bu örnek olay oluşturuldu | 8 Kasım |
| Örnek olay gönderildi | 16 Kasım |
Teklif bütçemizde teknik yazarın projemiz üzerinde çalışmak için haftada 10-15 saat harcayacağını tahmin etmiştik. Sam, harcanan zamanı kayıt altına aldı ve haftada ortalama 11,5 saat aldı.
Sonuçlar
Neler oluşturuldu, güncellendi veya başka bir şekilde değiştirildi? Varsa, yayınlanan dokümanların bağlantılarını ekleyin. Teklifte oluşturulmamış teslimatlar var mıydı? Bunları da listeleyin.
Üç temel kullanım alanı, eksiksiz "Nasıl Yapılır?" kılavuzlarıyla belgelenmiştir:
Glorious Pickle'a yeni bir malzeme nasıl eklenir?
Glorious Pickle'a varyant malzeme nasıl eklenir?
Glorious Pickle'daki bir malzemeyi güncelleme veya düzeltme
Bu kılavuzlarda, katkıları kolaylaştırmak için yeni çekme isteği şablonları da yer alıyordu.
Ayrıca Sam, proje sırasında öğrendiği terimlerin yer aldığı küçük bir Pickle Sözlüğü hazırladı ve bu sözlük de Glorious Pickle proje sitesinde yayınlandı.
Bu kullanıcı "Nasıl Yapılır?" kılavuzlarını güncellemek için proje wiki'mize talimatlar ekledik.
GitHub'a yeni katılan katılımcılar için süreçlerimizi ve araçlarımızı kullanmalarına yardımcı olacak yardımcı kısa bilgiler oluşturmayı da eklemiştik, ancak mevcut kaynaklara göz attığımızda bunun yerine başka bir projenin yardımcı kısa bilgilerini not edebildik.
Metrikler
Projenin başarısını ölçmek için hangi metrikleri seçtiniz? Bu metrikleri toplayabildiniz mi? Metrikler proje için istediğiniz sonuçlarla iyi veya kötü bağdaştırdı mı? Teklifinizden bu yana metrikleriniz değişti mi?
Teklifimizde iki metrik önermiştik:
- bileşenle ilgili çekme isteklerinin sayısı
- yeni katkıda bulunanlardan gelen pull isteklerinin sayısı
Eylül ayında (taslak dokümanların yayınlanmasından sonraki ilk tam ay) malzemelerle ilgili çekme isteklerinde% 5 artış gördük (Ağustos'ta 20'den Eylül'de 21'e) ve toplam dört çekme isteği gönderen üç yeni katılımcı gördük (Ağustos'ta iki çekme isteği gönderen iki yeni katılımcıya kıyasla). Bu metrikleri aylık olarak izlemeyi planlıyoruz.
1 Ocak'tan itibaren, dokümanlar yayınlandıktan sonra üç ayda bir başlayarak toplamda üçten fazla katkı sağlayan katılımcı sayısını da takip edeceğiz.
Anekdot olarak, bu yeni belgenin yeni katılımcıların Glorious Pickle malzeme veritabanına eklenmesinde fark yarattığına inanıyoruz. Yeni bir katılımcı, halkla ilişkiler ekibinin yorumunda daha önce denediği ancak süreci anlamadığı için güncellemelerini tamamlamadığını belirttiğinden söz ediyor.
Analiz
Projede hangi süreçler yolunda gitti? Beklenmedik olan neydi? Hangi engellerle veya aksiliklerle karşılaştınız? Projenizin başarılı olduğunu düşünüyor musunuz? Neden evet veya neden hayır? (Söylemek için henüz erkense projenizin başarısını ne zaman değerlendirebileceğinizi düşündüğünüzü açıklayın.)
Google Dokümanlar Mevsimi projemizin sonucundan çok memnunuz ve bunu başarılı sayıyoruz. Yeni belge hem açık hem de faydalıdır. Ayrıca, malzemelerle ilgili çekme isteklerinin ve katkıda bulunan yeni kullanıcılardan gelen çekme isteklerinin sayısında şimdiden bir miktar artış gözlemledik.
Ayrıca, orijinal teklifle ilgili geri bildirim vererek ve yeni dokümanları taslak biçimde test ederek neredeyse tüm Glorious Pickle topluluğunun katılımda bulunmasından da memnunuz.
Beklenmedik birkaç güçlükle karşılaştık. Sam'in eyaletindeki orman yangınlarının internet kesintisinden daha büyük bir zarara yol açmadığı için minnettarız. Ayrıca, @VinegarViv'i projeden kaybettiğimiz için üzgünüz. Kendisine ve ailesine iyi dileklerimizi iletiyor ve yakında tekrar görmeyi umuyoruz.
Sam belgeleme üzerinde çalışmaya başlayana kadar fark etmediğimiz bir şey de turşuyla ilgili kaç tane terimin ve kısaltmaların turşuyla ilgili bir bilgisi olmayan projemize gelip gelmediğiydi. Ancak Sami, bilmediği her terimin bir listesini tutmaya özen gösterdi ve kendi araştırmaları ve topluluk üyelerinden açıklamaları ile referans vermelerini isteyerek bu terimleri tanımladı. Bu Pickle Sözlüğü, gelecekte daha çok kişiyi turşulama topluluğuna davet etmemize çok yardımcı olacak.
Özet
Proje deneyiminizi 2-4 paragrafta özetleyin. Öğrendiklerinizi ve gelecekte neleri farklı yapmak istediğinizi vurgulayın. Benzer bir sorunu belgelemeyle çözmeye çalışan diğer projelere ne tavsiye edersiniz?
Kısacası, deneyimimiz mükemmeldi. Belge teslimatlarımızı tamamladık ve metriklerimiz hedeflerimize uygun görünüyor.
Teknik yazarımız Sam Scribe ile çalışma şansımız bu projenin başarısının büyük bir kısmını oluşturuyordu. [Bunu yazmadım— Sam] Sam'in GitHub'la ilgili hiç bir turizm veya tecrübesi olmasa da deneyimli bir teknik yazar olarak yeni bir konuya dalma, soru sorma ve araştırma yapma konusunda rahat davranıyorlardı. Sam sadece proje araçlarımızı (işleri takip etmek için Kanban panosu kullanıyoruz) ve kurşun şakalarımızı hızlıca kavradı. Sam'in turşu böceği yakalamasından ve topluluğumuza "şişelenmesinden" çok mutluyuz.
Diğer projelere şunları öneriyoruz:
- Tekliflerinizin küçük ve yönetilebilir olmasını sağlayın. (Teklifimize ilk başta tahmin aracımızı endüstriyel toplu devirme makineleriyle birlikte kullanmaya ilişkin belgeleri dahil etmek istiyorduk; ancak bunu dışarıda bırakmıştık çünkü açık kaynaklı turşu makinesinde yoğun olarak çalışan topluluk üyelerimizden biri program sırasında doktora tezini yazacaktı.) Cem'i meşgul etmeye yetecek kadar işimiz oldu.
- Teknik yazar ararken ağlarınızdan yararlanın. Topluluğunuzdaki herkesten öneri isteyin. Sam'i Dokümanlar'ın Google Sezonu GitHub'da bulabilsek de, başvuru dönemi boyunca birkaç kişiyle görüştüğümüz için onlarla çalışırken kendimizden emin olduk.
- Teknik yazarınızı topluluğunuza hoş geldiniz! Sam, Glorious Picklers'ın coşkulu tutumunun soru sormayı kolaylaştırdığını bize bildirdi.
- Teknik yazarınızın açık kaynak becerileri kazanmasına yardımcı olun. Sami daha önce hiç gitmiş olmasa da birkaç eğiticiyi tamamladıktan sonra hızlıca gelişmeye başladı. Sam, topluluktan ne kadar geri bildirim alabilecekleri ve bu geri bildirimleri buna nasıl dahil edecekleri konusunda endişeliydi, ancak topluluğumuzun "kaba fikir birliği" modeli ("tüm sorunlar ele alındığında, ancak her zaman kabul edilmese bile"), kendi teknik yazımını kullanarak eleştirileri ele alma konusunda kendinden emin olmasını sağladı.
Ek
Bağlantı vermek istediğiniz başka materyalleriniz varsa (örneğin, teknik yazarınızla çalışmak için paylaşmak istediğiniz bir sözleşme oluşturduysanız veya belge projeniz için şablonlar ya da başka açık belge kaynakları hazırladıysanız, söz konusu kaynakları burada listeleyip bağlayabilirsiniz). Ek olarak, kullandığınız tüm belge araçlarına veya kaynaklara yönelik bağlantıları listeleyebilir ya da yukarıdaki bölümlerde yer almayabilecek teşekkür veya teşekkür ilave etmek için ek kullanabilirsiniz.
Tasdik
Ekibimiz aşağıdaki kişilere ve konulara teşekkür etmek istiyor:
- @Dillicious, partnerine ve düşük yayın yapan hip hop radyosuna da teşekkür etmek istiyor
- @KimChiCook, turşusu yapmayı öğrettiği için 할머 sertifikalarına teşekkür ediyor
- @Piccalily, Chicago Style Online of Style Online için teşekkür etmek istiyor
- @GherKen, üç çocuğuna yapabildiği turşuları yedikleri için teşekkür ediyor
- @VinegarViv, istifa ettiği için emek veren ekipteki diğer kişilere teşekkür ediyor
- @BBChips, turkuaz olmayan en iyi yiyecek olan Tunnock'ın Karamel Gofer'i için teşekkür etmek istiyor.
- @Glorious PicklePat, bu projeyi üstlendiği için PickleDokümanlar SIG'sine teşekkür etmek istiyor
- Sam Scribe, tüm Glorious Pickle topluluğuna, özellikle de 2021 yazının kavanoz doluluğunda kendilerine konserve kavanoz gönderen koleksiyonculara teşekkür etmek istiyor. Bu şekilde lezzetli turşuların peşine düşüyorlar.