Sık sorulan sorular (SSS)

Mevcut aşama:
Sonuçlar açıklandı zaman çizelgesi.

Genel

Sezon, Dokümanlar bir işe alım programı mı?

Hayır. Google için çalışmak istiyorsanız lütfen Google iş fırsatları web sitesini ziyaret edin.

Mevcut programın, Dokümanlar Sezonu 2019 ve 2020'den farkı nedir?

Şu anki Dokümanlar Sezonu programında önceki yıllara göre önemli değişiklikler bulunuyor. Bu değişiklikler arasında şunlar yer alıyor:

  • Teknik yazarlar artık kuruluşlarla eşleşmek için Google üzerinden başvuruda bulunmuyor
  • Kuruluşlar, proje tekliflerini başvurularının bir parçası olarak, bir bütçe ve önerilen metrikler dahil
  • Kabul edilen kuruluşlar hibeler alır ve bu yardımları teknik yazarlara ödeme yapmak için kullanırlar
  • Kuruluşlar nihai değerlendirmeleri ve örnek olayları gönderirler

Dokümanlar Sezonu bu değişiklikleri neden yaptı?

Google'da misyonumuz dünyadaki bilgileri düzenlemek ve bunları herkes için erişilebilir kılarak kullanışlı hale getirmektir. Açık kaynakta etkili belgeleme uygulamaları hakkında bilgi edinmeyi vurgulamak için Dokümanlar Sezonuna yeniden odaklanarak uzun vadede daha büyük bir etki yaratmayı umuyoruz.

Kuruluşumuz Dokümanlar Dönemi'ne katılmak istiyor ama nereden başlayacağımızı bilmiyoruz!

Proje fikirlerinden oluşan tam listemize göz atın. Ayrıca teknik yazarlar topluluğuna da ulaşabilirsiniz (yardım veya teklif istemek için Write the Docs Slack'teki veya sosyal medya kanallarınızdaki #season-of-docs kanalını deneyin).

Kurumlar ne tür projeler önerebilir?

Aşağıdaki önerilerden yararlanabilirsiniz:

  • Teknik yazar ve açık kaynak kuruluşunun karar vereceği platformda bir belge sitesi oluşturun ve sitede ilk temel belge grubunu yayınlayın. Platformlara örnek olarak aşağıdakiler verilebilir:

  • Daha iyi bir kullanıcı deneyimi veya daha erişilebilir bir bilgi mimarisi sağlamak için açık kaynak projenin mevcut belgelerini yeniden düzenleyin.

  • Bir ürün veya özellik için kavramsal bir genel bakış ya da tanıtım yazın. Ekip genellikle aşağıdan yukarıya doğru teknik belgeleri oluşturur. Bunun sonucunda çok fazla ayrıntı vardır ama ürünü bir bütün olarak anlamak zordur. Teknik yazar bu sorunu düzeltebilir.

  • Önemli kullanım alanı için bir eğitim oluşturun.

  • Belirli görevler için bir dizi odaklanmış "Nasıl Yapılır?" kılavuzu oluşturun.

  • Açık kaynak projesine katkıda bulunan olarak çalışmaya başlama hakkında temel bilgilerin yanı sıra lisans sözleşmeleri, çekme istekleri ve yorumlar için süreçler, projenin oluşturulması vb. ile ilgili tüm kuralları içeren katkıda bulunanlar için bir kılavuz oluşturun.

Bir video, Dokümanlar Sezonu için olası bir proje midir?

Evet. Video gereksinimlerinin iyi geniş bir kapsama sahip olduğundan emin olun ve yüksek kaliteli video üretmek için önemli zaman ve kaynak gerektiğini unutmayın.

Dokümanlar Sezonu için doküman denetimi makul bir proje midir?

Doküman denetimi, Dokümanlar Sezonu için harika bir projedir. Elinizde ne kadar çok belge olduğuna dikkat edin; çok fazla belgeniz varsa kapsamı azaltmanız gerekebilir (örneğin, yalnızca eğitim içeriğini denetleme). Çok az belgeniz varsa veya hiç belgeniz yoksa projenizin bir parçası olarak en yüksek önceliğe sahip eksik belgelemeleri oluşturmayı düşünebilirsiniz.

Kuruluşların ve teknik yazarların kullanabileceği doküman şablonları var mı?

Dokümanlar sezonu, doküman denetimleri gerçekleştirmek için şablon ve yapılacaklar listesi içeren bir GitHub deposu içerir. Oluşturuldukça başka şablonlar eklemeyi umuyoruz.

İyi Dokümanlar Projesi açık kaynak için minimum uygulanabilir belge şablonları oluşturmak üzere çalışıyor.

Kuruluşların, teknik yazarlar tarafından hazırlanan belgeleri kullanması zorunlu mu?

Hayır. Zaman zaman projeler beklendiği gibi çıkmaz veya koşullar değişir. Kuruluşların üretilen belgeleri veya diğer materyalleri kullanmasını zorunlu kılmayız ancak nihai değerlendirmede ve vaka analizinde belgelerin neden kullanılmadığı ve projenin belgeleri ya da diğer malzemeleri kullanmama kararını nasıl verdiğinin ele alınmasını bekliyoruz.

Dokümanlar Mevsimi nerede gerçekleşir?

Dokümanlar sezonu tamamen çevrimiçi olarak gerçekleşir. Program kapsamında seyahat yapılması şart değildir.

Dokümanlar Dönemi'nden nasıl haberdar olabilirim?

Dokümanlar Sezonu ile ilgili en son güncellemeler ve duyurular için season-of-docs-announce adresindeki duyuru posta listesini ziyaret edin. Güncellemeleri e-postayla almak için gruba katılın.

Dokümanlar Sezonu zaman çizelgesini takvimime ekleyebilir miyim?

Evet, bu bağlantı aracılığıyla ekleyebilirsiniz.

Dokümanlar Mevsimi'ni duyurmak için ne yapabilirim?

Program hakkında tweet gönderebilir, blog yayınları yazabilir, video yayınlayabilir veya bölgenizde bir buluşma ya da bilgilendirme oturumu düzenleyebilirsiniz. Topluluğunuza (kuruluş, yazar grubu ve diğer kişiler) dağıtmak için kullanabileceğiniz bazı örnek içerik ve kaynaklar sunuyoruz.

Dokümanlar Sezonu bilgi oturumu veya buluşmasını nasıl düzenleyebilir ya da düzenleyebilirim?

Sizin için uygun olan zaman ve yerde bir buluşma planlayabilirsiniz. Lütfen program kurallarını inceleyin ve örnek içeriği kullanın.

Dokümanlar'ın 2019 ve 2020 Sezonlarıyla ilgili paylaşabileceğiniz herhangi bir istatistik var mı?

Evet, 2019 programı için Dokümanlar Sezonu sonuçlarımıza buradan, 2020 program sonuçlarına ise buradan ulaşabilirsiniz.

Mevsimlik Dokümanlar Tişörtü alacak mıyım?

Hayır, uluslararası gönderim kısıtlamaları nedeniyle artık Dokümanlar Dönemi projesini başarıyla tamamlayan katılımcılara tişört sağlayamayacağız.

Başka sorularım varsa ne yapmam gerekir?

Kuruluş yöneticisi kılavuzuna ve teknik yazar kılavuzuna göz atın.

Tüm dokümanları okuduktan sonra hala bir yanıt bulamıyorsanız, lütfen sorularınızı tartışma listesinde Mevsim Dokümanları topluluğuyla tartışmayı düşünün. Tartışma kanalları ve bizimle iletişime geçme ile ilgili bilgilere göz atın.

Sezon Dokümanları için nasıl mentor olabilirim?

Dokümanlar sezonu resmi bir mentor rolüne sahip değildir. Kuruluşlar, teknik yazarların programa nasıl dahil edileceğini ve destekleneceğini ve kuruluş başvurusu kapsamında belge katkılarının nasıl incelenip onaylanacağını belirtmelidir. Dokümanlar Sezonu kapsamında teknik yazarlara mentorluk yapmakla ilgileniyorsanız gönüllü olmak için kuruluşunuzun yöneticileriyle birlikte çalışmanızı öneririz.

Sezon, Google Summer of Code gibi midir?

Hayır. Season of Docs, teknik yazma deneyimi olan kişiler için tasarlanmıştır. Google Summer of Code gibi bir mentorluk programı olarak tasarlanmamıştır.

Teknik yazarlar için

Teknik yazarlar Dokümanlar Sezonu için ne zaman başvurabilir?

Dokümanlar sezonu için resmi bir teknik yazar başvurusu yoktur. Season of Docs'a teknik yazar olarak katılmak için, kendi Dokümanlar Sezonu program sayfalarındaki talimatları kullanarak açık kaynak kuruluşlarla doğrudan iletişime geçin. Dilerseniz kendinizi Season of Docs Technical Writer Directory'ye ekleyerek bu konuyla ilgilendiğinizi de belirtebilirsiniz. Daha fazla bilgi için teknik yazar kılavuzuna bakın.

Dokümanlar Dönemi'ne katılmak için hangi belge araçlarını ve çerçevelerini bilmem gerekir?

Kullanacağınız belgeleme araçları ve çerçeveler, çalışmak istediğiniz kuruluşa göre değişir. Season of Docs'un amacının bir parçası da, teknik yazarların açık kaynak ürünlerin belgelenmesinde kullanılan araçlar ve çerçeveler hakkında daha fazla bilgi edinmesine yardımcı olacak açık kaynak projelerdir. Bu nedenle, Dokümanlar Mevsimi projenize başlamadan önce genellikle belirli belge platformları hakkında ayrıntılı bilgiye sahip olmanız gerekmez.

Bununla birlikte, çoğu açık kaynak kuruluşu belgeleri için belirli bir Markdown aroması veya başka bir işaretleme dili kullanır. Seçtiğiniz kuruluşun hangi dili kullandığını öğrenmenizi ve söz dizimine aşina olmanızı öneririz. GitHub README dosyaları Markdown'ın bir türünü kullandığından Markdown iyi bir başlangıçtır. GitHub kılavuzunu inceleyerek Markdown'a göz atın.

Seçtiğiniz kuruluşun belgelerini bir web sitesinde zaten barındırıp barındırmadığını ve barındırıyorsa hangi platformu kullandığını öğrenin. Platform; Jekyll, Sphinx veya Hugo gibi statik bir site oluşturma aracı olabilir ya da kuruluş, dokümanlarını Dokümanlar'ı okuyun veya GitHub Sayfaları'nda barındırabilir. Kurumun hangi platformu kullandığını öğrendiğinizde, ilgili dili ve çerçeveyi inceleyin ve bunlarla denemeler yapın. Böylece açık kaynak projenize hemen başlayabilir ve seçtiğiniz açık kaynak projesine sağlam tavsiyelerde bulunabilirsiniz.

Dokümanlar Sezonu projelerine katılmak için hangi programlama dillerini bilmem gerekir?

Belgeleme projenizin yapısına bağlı olarak bir programlama dili bilmeniz gerekebilir. Bir belgeleme projesi seçerken ve önerirken bu durumu göz önünde bulundurun ve gerekli bilgi düzeyi konusunda açık kaynak kurumuna danışın.

Halihazırda açık kaynak bir projede çalışan teknik yazarlar, Dokümanlar Sezonu kapsamında bu proje üzerinde çalışmaya devam edebilir mi?

Evet, ancak kuruluş, teklifinde teknik yazarın projeyle önceki veya devam eden ilişkisini not etmelidir.

Katılım için uygunluk koşulları nelerdir?

Teknik yazar olarak önceden deneyime veya eğitime ihtiyacım var mı?

Daha önce teknik yazı yazma deneyimi veya eğitim almış olmak tercih edilir ancak gerekli değildir. Bir kuruma menfaat bildirimi gönderdiğinizde, deneyiminizi ve/veya eğitiminizi teknik yazılı yazılı olarak açıklayabilirsiniz. Yazdığınız belge örnekleri de dahil olmak üzere teknik belgelere veya açık kaynak belgelere gösterdiğiniz ilgiyi gösteren bazı kanıtlar sunabilmeniz gerekir. Açık kaynak kuruluşu, Dokümanlar projelerini başarıyla tamamlamak için kuruluşun ihtiyaç duyduğu deneyim düzeyinde teknik yazarlar arar.

Dokümanlar Dönemi'ne katıldığım için ödeme alacak mıyım?

Evet. Google, kabul edilen kuruluşlara teknik yazar istihdam etmek için kullanılmak üzere bağışlar sağlayacaktır.

Teknik yazarla ilgili iyi bir ilgi beyanı nasıl görünür?

En iyi menfaat beyanları, ifadelerini göndermeden önce, seçtikleri açık kaynak kuruluşla etkileşimde bulunmak ve fikirlerini tartışmak için zaman ayıran teknik yazarlardır. İlgi beyanınızı oluşturma kılavuzunu inceleyin.

Dokümanlar Sezonu'na katılım ne kadar sürer?

Proje büyüklükleri değişiklik gösterir, ancak program süresince haftada 5-30 saatlik iş yükü de değişebilir. Ancak harcadığınız zaman, kurumunuzla anlaştığınız projenin yapısına bağlıdır. Projeyi hayata geçirmeden önce projeyi değerlendirmeli ve açık kaynak kuruluşuyla süre tahmini üzerine konuşmalısınız.

Bir açık kaynak projesiyle ilgili belge oluşturmak için şahıs olarak kuruluş başvurusu gönderebilir miyim? Bir açık kaynak projesinin veya aracının nasıl kullanılacağıyla ilgili bir dizi blog yayını, video veya başka materyaller oluşturmak istiyorum, ancak bu projenin bir parçası veya katkıda bulunmuyorum.

Hayır, yalnızca açık kaynak projesi adına fon alabiliyorsanız teklif göndermelisiniz. Projeye ulaşmanızı ve bir başvuru teklifi üzerinde ortak çalışabilirsiniz.

Öğrenciyim, Dokümanlar Dönemi'ne katılabilir miyim? Season of Docs bana teknik yazar olmayı öğretecek mi?

Öğrenciler kabul edilen kuruluşlarla çalışmak için uygundur ancak Docs of Docs teknik yazma becerilerini öğretmek için tasarlanmamıştır. Programa katılan teknik yazarların profesyonel teknik yazma becerilerine veya eşdeğer deneyime sahip olmasını bekleriz. Katılmak isteyen öğrenciler, kendileriyle ilgilenen kuruluş ve projelere ulaşırken kendi yazma ve düzenleme deneyimlerini vurgulamalıdır.

Dokümanlar Sezonu'nda teknik yazar ve Google Summer of Code öğrencisi olarak katılabilir miyim?

Bu durum şu anda kurallara aykırı olmasa da, Google Summer of Code'a kabul edilen öğrencilerin Dokümanlar Mevsimi teknik yazarı olmak için başvuruda bulunmamalarını önemle tavsiye ederiz. Öğrenciler, Dokümanlar Sezonu'na başvurmak yerine Google Summer of Code çalışmalarına odaklanmalıdır.

Dahası, Season of Docs yeni başlayanlar için değil, çok iyi teknik yazma becerilerine ve deneyimine zaten sahip olan kişiler için tasarlanmıştır. Dokümanlar Sezonu'ndaki teknik yazarlara akıl hocalığı yapılmaz. Bunun yerine, kuruluş yöneticileri ve diğer topluluk üyelerinden minimum rehberlik alarak kuruluşun projesini ele almak üzere planlarını yapmak için kendi kendilerini organize edebilmeli ve motive olmaları gerekir.

Teknik yazar olarak, başka sorularım veya endişelerim olursa Dokümanlar Sezonu Google programı yöneticileriyle nasıl iletişim kurabilirim?

Season of Docs Google program yöneticileriyle iletişim kurmak için season-of-docs@google.com adresine e-posta gönderebilirsiniz.

Teknik yazı şirketi veya danışmanlık şirketi Dokümanlar Dönemi'ne katılabilir mi?

Evet, kuruluş tekliflerinde belirtilen işleri yapmak için bir şirketle anlaşabilir.

Özgeçmişimde Dokümanlar Sezonu'na nasıl referans verebilirim?

Diğer tüm serbest çalışmalarla olduğu gibi listeleyin. Örneğin, "Dokümanlar Döneminde [proje adı] projesi için teknik yazar olarak çalıştınız."

Dokümanlar Mevsimi'ne katılım için bitirme sertifikası veriyor musunuz?

Teknik yazarlara proje katılım sertifikaları veya onayları gönderemiyoruz.

Açık kaynak kuruluş yöneticileri için

Açık kaynak bir kuruluşun uygunluk koşulları nelerdir?

Kuruluş olarak katılmaya uygun olmak için BRL-CAD gibi etkin bir ücretsiz/açık kaynak yazılım projesini yürüten bir grup olmanız gerekir. Projenin yasal olarak tüzel kişiye ait olması gerekmez. Kuruluşların programa katılabilmeleri için Açık Kaynak Girişimi onaylı bir lisans kapsamında halihazırda yazılım üretmiş ve yayınlamış olmaları ve tüm Dokümanlar Sezonu programının kuruluş yöneticisi olarak hizmet vermek üzere en az iki katkıda bulunanı olmalıdır.

Program kurallarında açıklanan uygunluk koşullarına ve ABD Hazine Bakanlığı'nın Yaptırım Programları ve Ülke Bilgileri'ne de bakın.

"Kuruluş", açık kaynak projesine eşdeğer mi?

Bir kuruluşun bir veya daha fazla açık kaynak projesi olabilir. Vakıflar gibi bazı kuruluşlarda, her biri bir veya daha fazla açık kaynak projesi bulunan birden fazla alt kuruluş bulunabilir. Kuruluşunuzun bağımsız alt kuruluşları varsa lütfen her alt kuruluş için ayrı başvuru ve teklifler gönderin.

Bir kuruluş birden fazla teklif başvurusu gönderebilir mi?

Hayır. Lütfen kuruluş başına yalnızca bir başvuru gönderin. Kuruluşunuzun alt kuruluşları varsa (örneğin, kuruluşunuz pek çok açık kaynak projesine sahip bir vakıfsa) hibe fonları şemsiye kuruluş tarafından karşılanacak olsa bile her proje kendi başvurusunu göndermelidir.

Bir grup açık kaynak proje, tek bir belge projesi üzerinde çalışmak için birlikte teklif gönderebilir mi?

Teklif başvurusunu bir kuruluş sunmalı ve diğer katılımcı projelerde yapılacak çalışmaları ve desteği koordine etmekten sorumlu olmalıdır. (Örneğin, büyük bir projenin eklentileri olan ve eklentiler oluşturmak için ortak bir "Nasıl Yapılır?" kılavuzu üzerinde çalışmak isteyen bir grup küçük açık kaynak projesi, projeye liderlik edecek bir kuruluş seçmelidir.)

Kuruluşum paraları nasıl alacak?

Para almak için kuruluşunuzun bir Open Collective hesabı olmalıdır.

Kuruluşlar Dokümanlar Sezonu'na katılım için herhangi bir para alıyor mu?

Kuruluşlar proje bütçelerinin bir parçası olarak yönetim, mentorluk veya çalışmaları gözden geçirme fonlarına yer verebilirler.

Google, ödeme işlemi ücretlerini karşılar mı?

Ödeme işleme ücretleri, ödeme yöntemine bağlı olarak farklılık gösterdiğinden, Google tarafından karşılanmaz. Bununla birlikte Google, Open Collective platform ücretini karşılar ve mali barındırmanız olarak Open Collective'yi kullanmaya karar verirseniz bu ücret de karşılanır. Daha fazla bilgi için Bağış Alma rehberine bakın.

Kuruluşum, teknik yazarlık masraflarını nasıl karşılamalı?

Dokümanlar maaş anketini yazma sayfasına göz atmanızı ve saatlik ücretler belirlemenizi öneririz. Ayrıca Write The Docs Slack'e katılabilir ve #season-of-docs kanalında ilgi gösteren teknik yazarların teklif vermesini isteyebilirsiniz.

Kuruluşum, mevcut bir katkıda bulunan kullanıcıya ödeme yapmak için Dokümanlar Sezonu bağışını kullanabilir mi?

Evet. Ancak proje teklifleri yeni işler için olmalıdır (bakım çalışmaları, revizyon veya mevcut belgelere yükseltme dahil). Tamamlanmış bir çalışma için ödeme yapmak üzere hibe başvurusunda bulunamazsınız.

Kuruluşum, öğrenci teknik yazarlarla çalışabilir mi?

Projenizde teknik yazar öğrencilerinin çalışmasını sağlayabilirsiniz. Öğrencilerle çalışmayı tercih ederseniz katılımı yalnızca aşağıdaki özelliklere sahip öğrencilerle sınırlamanızı önemle tavsiye ederiz:

  • 18 yaşından büyük kullanıcılar
  • Teknik yazı veya teknik iletişim programına ya da kursuna kayıtlı olmak
  • Programları veya kursları aracılığıyla teknik yazım koçluğuna kanıtlanabilir erişime sahip olmak

Kuruluşum birden fazla teknik yazarla çalışabilir mi?

Kuruluşunuz birden fazla teknik yazar seçip ödeme yapabilir ancak kuruluşunuzla çalışan tüm teknik yazarlar, önerdiğiniz projede çalışmalıdır. Birden fazla teknik yazarla çalışmak projenizi daha karmaşık hale getirir, daha fazla gönüllü çalışma ve yönetim süresi gerektirir.

Kuruluşum, projemizde çalışması için bir teknik yazarlık şirketiyle çalışabilir mi?

Evet, kuruluşunuz projeniz üzerinde çalışması için bir teknik yazar şirketiyle çalışabilir. Çalıştığınız şirketin Open Collective üzerinden ödeme alabilmesini sağlayın.

Teknik yazarımız program bitmeden programdan ayrıldı. Kalan tutarı almaya devam edebilir miyiz?

Program sona ermeden önce projenizi tamamlayacak yeni bir teknik yazar bulmayı denemenizi önemle tavsiye ederiz. Ancak kalan fonların ödemesi projenin tamamlanmasına değil, örnek olayın tamamlanması ve nihai değerlendirmenin tamamlanmasına bağlıdır.

Projeniz tamamlanamadıysa örnek olayınızın bunun nedenlerini incelemesi beklenir. Örneğin, belgeleme araçlarınızın çok karmaşık olduğunu ve teknik yazarların çalışmaya başlamasının önünde bir engel olduğunu ya da projenizin testler ve güncellemeler içerdiği için kapsamlı kodlama deneyimi gerektirdiğini fark etmiş olabilirsiniz. Deneyimlerinize dayanarak diğer projelere ne önerirsiniz? Bu bilgileri örnek olayınıza ekleyin.

Kurumsal başvurular, son gönderim tarihinden önce incelenebilir mi?

Maalesef kuruluş başvurusu hakkında geri bildirim sağlayamıyoruz.

Kurumlar proje tekliflerinin kapsamını nasıl belirlemelidir?

Proje fikirleri geliştirirken, kuruma değer sağlayacak en küçük projeleri bulmaya çalışın (ancak zaman kalırsa bu proje artırılabilir). Ne kadar küçükse o kadar iyidir. Proje teklifinizi oluştururken daha az detay içeren, büyük projeler yerine daha küçük ve detaylı projelere bağlı kalmanızı öneririz. Projenizde çok fazla alan uzmanlığı gerekiyorsa bu konuda bilgi sahibi olmayan birinin üzerinde çalışabileceği projeleri dahil etmeye çalışın.

Sezon Dokümanları'na kuruluş yöneticisi olarak ve Google Summer of Code'a mentor olarak katılabilir miyim?

Evet. Dokümanlar sezonu ve Google Summer of Code ayrı programlardır. Her iki programa da katılmak için gereken bant genişliğine sahipseniz sorun yoktur.

Kuruluşumuz önceki Dokümanlar Sezonu programlarına katılmıştı. Tekrar başvuru yapabilir miyiz?

Evet, önceki Dokümanlar Sezonu programlarına katılmış olan kuruluşlar tekrar başvurabilir.

Arşivlenen veriler

Dokümanlarım Sezonu arşivinden bilgilerimi nasıl kaldırabilirim?

Bilgilerinizin kaldırılması için bize ulaşın.