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 yer alan olası belge projelerini nasıl açıklayabileceklerini gösteren örneklerdir. Kurumlar, bu listeye dahil edilmeyen projeler önerebilirler.
Proje Fikri: Katkıda bulunanlar için ilk katılım rehberi oluşturma
Sorun
- Yeni katkıda bulunanlar, projemize anlamlı katkıda 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 dışı yeni katkıda bulunanların sayısındaki artış (dokümanlara veya testlere katkıda bulunmayı kolaylaştırarak)
- Yeni katkıda bulunanların bildirdiği sorun sayısında düşüş
- "Önce iyi sorun" etiketine sahip kapatılmış sorunların sayısında artış
Bu projede çalışmak için teknik bir yazarın hangi becerilere sahip olması gerekir?
- Zorunluluk: GitHub hakkında bilgi sahibi olmak (veya GitHub eğitimleri üzerinde çalışmaya istekli olmak)
- Yararlı bilgiler: Testlerimizi çalıştırmak ve bunu yapmak için gereken dokümanları güncellemek için test çalıştırıcımıza aşina olma
Gönüllüler
Topluluk üyelerini belirli görevlerde yardımcı olmak üzere kaydolmaya teşvik edin. Örneğin:
- @JaneQDev, testlerimizle ilgili soruları yanıtlamanıza yardımcı olabilir
- @ChenPCoder, doküman çekme isteklerini incelemekten memnuniyet duyarız
- @ErichJEngineer, mevcut katkı sürecini teknik yazarla birlikte inceleyebilir
İ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.
Project Fikir: kitaplığımızı aşağıdakilerle birlikte kullanmak için eğitici içerikler yazın:
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 olabiliyor.
Başarıyı nasıl ölçebiliriz?
- "$TechnologyX" etiketli sorunların sayısında düşüş
- Hataları düzeltmemize veya $TechnologyX ile ilgili belgelere ekleme yapmamıza yardımcı olan yeni katkıda bulunanlardan gelen çekme isteklerinin sayısında artış
- $TechnologyX projelerinden projemize ilişkin daha fazla bağlantı
Bu projede çalışmak için teknik bir yazarın hangi becerilere sahip olması gerekir?
- Faydalı: $TechnologyX konusunda biraz bilgi sahibi olma
Gönüllüler
Topluluk üyelerini belirli görevlerde yardımcı olmak üzere kaydolmaya teşvik edin. Örneğin:
- @JaneQDev, $TechnologyX ile ilgili soruları yanıtlamanıza yardımcı olabilir
- @ChenPCoder, doküman ç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 yazarlık ç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 düzensiz. Birçok kullanıcı dokümanlarda yanıt bulmaya çalışmaktan vazgeçer ve bunun yerine forumlarımızda sadece sorun dile getirir ya da soru sorar. Sayfalarımız, alakalı anahtar kelimeler için bile arama sonuçlarında çıkmıyor.
Başarıyı nasıl ölçebiliriz?
- Dokümanlarımız için daha iyi SEO
- Dokümanlarda ele alınan konularla ilgili olarak bildirilen sorunların sayısında düşüş
- Belgeleme katkılarının sayısında artış
Bu projede çalışmak için teknik bir yazarın hangi becerilere sahip olması gerekir?
- Yararlı olanlar: Büyük ve olgun belge gruplarını yeniden düzenleme deneyimi, SEO'yu anlama
Gönüllüler
Topluluk üyelerini belirli görevlerde yardımcı olmak üzere kaydolmaya teşvik edin. Örneğin:
- @ChenPCoder, doküman ç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 yazarlık çalışmanızın veya portföyünüzün/özgeçmişinizin/CV'nizin bağlantılarını ekleyin.
Proje Fikri: Bir belge düzeltme çalışması 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 memnuniyet duyacaktır. Ancak, sorunu çözecek ve sorunu çözecek birine ihtiyacımız var.
Başarıyı nasıl ölçebiliriz?
- Belgelerle ilgili kapatılan sorunların sayısı
- Belgeleme katkıları ve yeni katkıda bulunanların sayısında artış
Bu projede çalışmak için teknik bir yazarın hangi becerilere sahip olması gerekir?
- Faydalı: Doküman düzeltme işlemi çalıştırma deneyimi
- Mükemmel organizasyon becerileri
Gönüllüler
Topluluk üyelerini belirli görevlerde yardımcı olmak üzere 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, email@project adresine e-posta gönderebilir/forumumuzda bir sorun açabilir/sorun açabilir. 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: Belgeleme denetimi yapın
Sorun
- Dokümanların durumu hakkında net bir fikrimiz yok! Belge iyileştirmelerine öncelik vermek zordur çünkü bir yol haritamız ya da en acil sorunların neler olduğunu bilemeziz. Ayrıca silinmesi veya arşivlenmesi gereken çok sayıda eski içeriğimiz de bulunmaktadır.
Başarıyı nasıl ölçebiliriz?
- Topluluğun genel onayıyla belgeleme yol haritasının oluşturulması
- Eski veya yanlış belge sayfalarının sayısında azalma
Bu projede çalışmak için teknik bir yazarın hangi becerilere sahip olması gerekir?
- Faydalı: Dokümanlar denetimi yapma deneyimi
Gönüllüler
Topluluk üyelerini belirli görevlerde yardımcı olmak üzere kaydolmaya teşvik edin. Örneğin:
- @JaneQCoder, topluluk toplantımızda belgeleme yol haritasının sunulmasında koordinasyon sağlanmasına yardımcı olabilir
İletişim bilgileri
- Bu projede çalışmak isteyen teknik yazarlar, email@project adresine e-posta gönderebilir/forumumuzda bir sorun açabilir/sorun açabilir. 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.
İlgili bilgiler
- Tanıtım ve basın sayfasında, Google Dokümanlar Sezonu hakkında konuşurken kullanabileceğiniz logolar ve diğer içerikler bulunur.
- PyCon Australia 2017'de yayınlanan bu videoda, belgelerinizi faydalı bulmaları için düzenlemeyle ilgili ipuçları verilmektedir: Daniele Procida'nın belgelerle ilgili bilgi vermediği içerikler.