Mevcut aşama:
Projenin tamamlanması. Zaman çizelgesine bakın.
Bu sayfa, kuruluş başvuru sürecinin keşif aşamasında olan açık kaynak kuruluşlar içindir. Bu proje fikirleri, kuruluşların proje fikirleri sayfasındaki olası doküman projelerini nasıl tanımlayabileceğini gösteren örneklerdir. Kuruluşlar bu listede yer almayan projeler önerebilir.
Proje fikri: Katkıda bulunanlara yönelik ilk katılım kılavuzu oluşturma
Sorun
- Yeni katkıda bulunanlar, projemize anlamlı katkılarda bulunmak için ihtiyaç duydukları kurulum bilgilerini bulamıyor. Bazı süreçler (testlerimize katkıda bulunma gibi) hiç belgelenmez.
Başarıyı nasıl ölçeriz?
- Yeni katkıda bulunanların sayısındaki artış
- Kod dışındaki yeni katkıda bulunanların sayısını artırma (dokümanlara veya testlere katkıda bulunmayı kolaylaştırarak)
- Yeni katkıda bulunanlar tarafından bildirilen sorunların sayısındaki azalma
- "İyi bir ilk sorun" etiketiyle kapatılmış sorunların sayısı arttı
Teknik yazarların bu projede çalışmak için hangi becerilere sahip olması gerekir?
- Zorunlu: GitHub hakkında bilgi sahibi olmak (veya GitHub eğitimlerini incelemeye istekli olmak)
- İsteğe bağlı: Testlerimizi çalıştırmak ve bu konudaki dokümanları güncellemek için test çalıştırıcımız hakkında bilgi sahibi olmak
Gönüllüler
Topluluk üyelerini belirli görevlerde yardımcı olmak için kaydolmaya teşvik edin. Örneğin:
- @JaneQDev, testlerimizle ilgili soruları yanıtlamaya yardımcı olabilir
- @ChenPCoder, docs pull isteklerini incelemekten memnuniyet duyarım
- @ErichJEngineer, teknik yazarla mevcut katkı sürecini inceleyebilir misiniz?
İletişim bilgileri
- Bu projede çalışmak isteyen teknik yazarlar email@project adresine e-posta göndermelidir. Teknik yazı çalışmalarınız veya portföyünüzün/özgeçmişinizin/CV'nizin bağlantılarını ekleyin.
Proje fikri: Kitaplığımızı ... ile kullanmaya yönelik eğitici içerikler yazma
Sorun
- Projemiz, kitaplığımızı $TechnologyX ile kullanmaya çalışan kullanıcılar tarafından çok sayıda sorunla karşılaşıyor. $TechnologyX ile entegrasyon için net bir kılavuzumuz yok ve bu işlem biraz karmaşık olabilir.
Başarıyı nasıl ölçeriz?
- "$TechnologyX" etiketli sorunların sayısında azalma
- $TechnologyX ile ilgili hataları düzeltmemize veya dokümanlara ekleme yapmamıza yardımcı olan yeni katkıda bulunanlardan gelen çekme isteklerinin sayısı arttı
- $TechnologyX projelerinden projemize daha fazla bağlantı
Teknik yazarların bu projede çalışmak için hangi becerilere sahip olması gerekir?
- İsteğe bağlı: $TechnologyX hakkında bilgi sahibi olmak
Gönüllüler
Topluluk üyelerini belirli görevlerde yardımcı olmak için kaydolmaya teşvik edin. Örneğin:
- @JaneQDev, $TechnologyX ile ilgili soruları yanıtlama konusunda yardımcı olabilir.
- @ChenPCoder, docs pull isteklerini incelemekten memnuniyet duyarım
İletişim bilgileri
- Bu projede çalışmak isteyen teknik yazarlar email@project adresine e-posta göndermelidir. Teknik yazı çalışmalarınız veya portföyünüzün/özgeçmişinizin/CV'nizin bağlantılarını ekleyin.
Proje fikri: Dokümanlarımızı yeniden düzenleyin
Sorun
- Dokümanlarımız çok geniş ve dağınık. Birçok kullanıcı, dokümanlarda yanıt aramaktan vazgeçip forumlarımızda sorun bildirmeyi veya soru sormayı tercih ediyor. Sayfalarımız, alakalı anahtar kelimeler için bile arama sonuçlarında görünmüyor.
Başarıyı nasıl ölçeriz?
- Dokümanlar için daha iyi SEO
- Belgelerde ele alınan konularla ilgili olarak bildirilen sorunların sayısındaki düşüş
- Doküman katkılarının sayısındaki artış
Teknik yazarların bu projede çalışmak için hangi becerilere sahip olması gerekir?
- İsteğe bağlı: Büyük ve gelişmiş doküman kümelerini yeniden düzenleme deneyimi, SEO bilgisi
Gönüllüler
Topluluk üyelerini belirli görevlerde yardımcı olmak için kaydolmaya teşvik edin. Örneğin:
- @ChenPCoder, docs pull isteklerini incelemekten memnuniyet duyarım
İletişim bilgileri
- Bu projede çalışmak isteyen teknik yazarlar email@project adresine e-posta göndermelidir. Teknik yazı çalışmalarınız veya portföyünüzün/özgeçmişinizin/CV'nizin bağlantılarını ekleyin.
Proje fikri: Belge düzeltme çalışması yapın
Sorun
- Dokümanlarımızla ilgili birçok küçük hata ve eski sorun var. Topluluğumuz bu konuda size yardımcı olmaktan memnuniyet duyar ancak sorunun çözümünü organize edip yürütecek bir kişiye ihtiyacımız var.
Başarıyı nasıl ölçeriz?
- Kapatılmış dokümanlarla ilgili sorun sayısı
- Doküman katkılarının ve yeni katkıda bulunanların sayısı artıyor
Teknik yazarların bu projede çalışmak için hangi becerilere sahip olması gerekir?
- İsteğe bağlı: Doküman düzeltme aracını çalıştırma deneyimi
- Mükemmel organizasyon becerileri
Gönüllüler
Topluluk üyelerini belirli görevlerde yardımcı olmak için kaydolmaya teşvik edin. Örneğin:
- @ChenPCoder, düzeltmeyle ilgili video ve sohbeti düzenlemeye ve diğer saat dilimlerindeki gönüllüleri bulmaya yardımcı olabilir
İletişim bilgileri
- Bu projede çalışmak isteyen teknik yazarlar, email@project adresine e-posta gönderebilir/sorun açabilir veya forumumuzda soru sorabilir. Teknik yazı çalışmalarınız veya portföyünüzün/özgeçmişinizin/CV'nizin bağlantılarını ekleyin.
Proje fikri: Doküman denetimi yapma
Sorun
- Dokümanlarımızın durumu hakkında net bir bilgimiz yok. Bir yol haritamız veya en acil sorunların ne olduğuna dair bir fikrimiz olmadığı için dokümanlardaki iyileştirmelere öncelik vermek zor. Ayrıca, silinmesi veya arşivlenmesi gereken çok sayıda güncel olmayan içeriğimiz var.
Başarıyı nasıl ölçeriz?
- Topluluğun genel onayı ile doküman yol haritası oluşturma
- Eski veya yanlış doküman sayfalarının sayısı azalıyor
Teknik yazarların bu projede çalışmak için hangi becerilere sahip olması gerekir?
- İsteğe bağlı: Dokümanlar denetleme deneyimi
Gönüllüler
Topluluk üyelerini belirli görevlerde yardımcı olmak için kaydolmaya teşvik edin. Örneğin:
- @JaneQCoder, topluluk toplantımızda doküman yol haritasının sunulmasını koordine etmeye yardımcı olabilir.
İletişim bilgileri
- Bu projede çalışmak isteyen teknik yazarlar, email@project adresine e-posta gönderebilir/sorun açabilir veya forumumuzda soru sorabilir. Teknik yazı çalışmalarınız 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'ndan bahsederken kullanabileceğiniz logolar ve diğer içerikler yer alır.
- PyCon Australia 2017'de çekilen bu videoda, kullanıcıların faydalı bulacağı şekilde dokümanlarınızı düzenlemeyle ilgili ipuçları veriliyor: Daniele Procida tarafından hazırlanan What nobody tells you about documentation (Dokümanlar hakkında kimsenin size söylemediği şeyler).