Mevcut aşama:
Sonuçlar açıklandı. Zaman çizelgesini inceleyin.
Bu sayfa, kuruluş başvuru sürecinin keşif aşamasında bulunan açık kaynak kuruluşlar içindir. Bu proje fikirleri, kurumların proje fikirleri sayfasında olası belge projelerini nasıl açıklayabileceklerini gösteren sadece örneklerdir. Kuruluşlar bu listede yer almayan projeler önerebilirler.
Proje Fikri: Katkıda bulunanlar için ilk katılım rehberi oluşturma
Sorun
- Yeni katkıda bulunanlar, projemize anlamlı katkılarda bulunmak için ihtiyaç duydukları kurulum bilgilerini bulamıyor. Bazı işlemler (testlerimize katkıda bulunmak gibi) hiç belgelenmemiştir.
Başarıyı nasıl ölçebiliriz?
- Yeni katkıda bulunan kullanıcı sayısındaki artış
- Kod yazmadan katkıda bulunan yeni kullanıcıların sayısında artış (dokümanlara veya testlere katkıda bulunmayı kolaylaştırarak)
- Yeni katkıda bulunan kullanıcılar tarafından bildirilen sorun sayısında düşüş
- “İlk sorun iyi” olarak etiketlenmiş, kapatılan sorunların sayısında artış
Teknik bir yazarın bu projede çalışması için hangi becerilere sahip olması gerekir?
- Gereklilikler: GitHub hakkında bilgi sahibi olma (veya GitHub eğitimleri aracılığıyla çalışma isteği)
- Yararlı bilgiler: Testlerimizi gerçekleştirmek ve bunu yapmaya ilişkin belgeleri güncellemek için test çalıştırıcımıza aşina olma
Gönüllüler
Topluluk üyelerini belirli görevlere yardımcı olmaları için kaydolmaya teşvik edin. Örneğin:
- @JaneQDev, testlerimizle ilgili soruları yanıtlamanıza yardımcı olabilir
- @ChenPCoder, dokümanlar çekme isteklerini incelemekten memnuniyet duyarız
- @ErichJEngineer, mevcut katkı sürecine teknik yazarla birlikte bakabilir
İletişim bilgileri
- Bu projede çalışmak isteyen teknik yazarlar email@project adresine e-posta göndermelidir. Lütfen teknik yazarlık çalışmanızın veya portföyünüzün/özgeçmişinizin/CV'nizin bağlantılarını ekleyin.
Proje Fikri: Kitaplığımızı ... ile kullanmak için eğitici içerikler
Sorun
- Projemiz, $TechnologyX ile kitaplığımızı kullanmaya çalışan kullanıcıların bildirdiği birçok soruna yol açıyor. $TechnologyX ile entegrasyon konusunda net bir rehberimiz yok ve zorlu olabilir.
Başarıyı nasıl ölçebiliriz?
- "$TechnologyX" olarak etiketlenen sorunların sayısında düşüş
- Hataları düzeltmemize veya $TechnologyX ile ilgili belgelere eklememize yardımcı olan yeni katkıda bulunanlardan gelen çekme isteklerinin sayısında artış
- $TechnologyX projelerinden projemize daha fazla bağlantı
Teknik bir yazarın bu projede çalışması için hangi becerilere sahip olması gerekir?
- Faydalı: $TechnologyX konusunda biraz bilgi sahibiyim
Gönüllüler
Topluluk üyelerini belirli görevlere yardımcı olmaları için kaydolmaya teşvik edin. Örneğin:
- @JaneQDev, $TechnologyX ile ilgili soruları yanıtlamanıza yardımcı olabilir
- @ChenPCoder, dokümanlar çekme isteklerini incelemekten memnuniyet duyarız
İletişim bilgileri
- Bu projede çalışmak isteyen teknik yazarlar email@project adresine e-posta göndermelidir. Lütfen teknik yazım çalışmanızın veya portföyünüzün/özgeçmişinizin/CV'nizin bağlantılarını ekleyin.
Proje Fikri: Belgelerimizi yeniden düzenleyin
Sorun
- Dokümanlarımız geniş kapsamlı ve dağınık. Birçok kullanıcı dokümanlarda yanıt bulmaya çalışmaktan vazgeçer ve bunun yerine yalnızca forumlarımızda sorun belirtir veya soru sorar. Sayfalarımız, alakalı anahtar kelimeler için bile arama sonuçlarında görünmez.
Başarıyı nasıl ölçebiliriz?
- Belgelerimiz için daha iyi SEO
- Dokümanlarda ele alınan konularla ilgili olarak bildirilen sorunların sayısında düşüş
- Belgeleme katkılarındaki artış
Teknik bir yazarın bu projede çalışması için hangi becerilere sahip olması gerekir?
- Faydalı: Büyük ve olgun belge setlerini yeniden düzenleme deneyimi, SEO'yu anlama
Gönüllüler
Topluluk üyelerini belirli görevlere yardımcı olmaları için kaydolmaya teşvik edin. Örneğin:
- @ChenPCoder, dokümanlar çekme isteklerini incelemekten memnuniyet duyarız
İletişim bilgileri
- Bu projede çalışmak isteyen teknik yazarlar email@project adresine e-posta göndermelidir. Lütfen teknik yazım çalışmanızın veya portföyünüzün/özgeçmişinizin/CV'nizin bağlantılarını ekleyin.
Proje Fikri: Bir belgeleme düzeltmesi yapma
Sorun
- Dokümanlarımızda çok sayıda küçük hatamız ve eski sorunlar var. Topluluğumuz devreye girmekten ve bir şeylerin düzeltilmesine yardımcı olmaktan mutluluk duyar; ancak asıl düzeltmeyi düzenleyip çalıştıracak birine ihtiyacımız var.
Başarıyı nasıl ölçebiliriz?
- Kapatılan belgelerle ilgili sorunların sayısı
- Dokümantasyona katkıda bulunanların ve yeni katkıda bulunanların sayısında artış
Teknik bir yazarın bu projede çalışması için hangi becerilere sahip olması gerekir?
- Yararlıdır: Doküman düzeltme işlemi çalıştırma deneyimi
- Mükemmel organizasyon becerileri
Gönüllüler
Topluluk üyelerini belirli görevlere yardımcı olmaları için kaydolmaya teşvik edin. Örneğin:
- @ChenPCoder, düzeltme için video ve sohbetin düzenlenmesine ve diğer saat dilimlerindeki gönüllülerin bulunmasına yardımcı olabilir
İletişim bilgileri
- Bu projede çalışmak isteyen teknik yazarlar e-posta@proje adresine bir e-posta göndermelidir/forumumuzda bir sorun açmalı/soru sorabilirler. Lütfen teknik yazım çalışmanızın veya portföyünüzün/özgeçmişinizin/CV'nizin bağlantılarını ekleyin.
Proje Fikri: Belgeleme denetimi yapın
Sorun
- Elimizdeki dokümanların durumu hakkında net bir fikrimiz yok. Bir yol haritamız veya en acil sorunların neler olduğu hakkında bir fikrimiz olmadığı için belge iyileştirmelerine öncelik vermek zordur. Ayrıca, silinmesi veya arşivlenmesi gereken çok sayıda eski içeriğimiz de var.
Başarıyı nasıl ölçebiliriz?
- Topluluğun genel onayıyla bir belge yol haritasının oluşturulması
- Eski veya yanlış belge sayfalarının sayısında azalma
Teknik bir yazarın bu projede çalışması için hangi becerilere sahip olması gerekir?
- Faydalı: Dokümanlar denetimi yapma deneyimi
Gönüllüler
Topluluk üyelerini belirli görevlere yardımcı olmaları için kaydolmaya teşvik edin. Örneğin:
- @JaneQCoder, topluluk toplantımızda belgeleme yol haritasının sunulmasını koordine etmenize yardımcı olabilir.
İletişim bilgileri
- Bu projede çalışmak isteyen teknik yazarlar e-posta@proje adresine bir e-posta göndermelidir/forumumuzda bir sorun açmalı/soru sorabilirler. Lütfen teknik yazım çalışmanızın veya portföyünüzün/özgeçmişinizin/CV'nizin bağlantılarını ekleyin.
İlgili bilgiler
- Tanıtım ve basın sayfasında, Google Dokümanlar Sezonu hakkında konuşurken kullanabileceğiniz logolar ve başka içerikler bulunur.
- PyCon Australia 2017'de yayınlanan bu videoda, belgelerinizi faydalı bulabilmeniz için belgelerinizi nasıl düzenleyebileceğinize dair ipuçları verilmektedir: Daniele Procida'nın belgelerle ilgili bilgi vermediği içerikler.