Mevcut aşama:
Dökümanlar Sezonu 2019 programı 6 Mart 2020'de sona erdi. Zaman çizelgesini inceleyin.
Bu sayfada, Dokümanlar Sezonu'nda yer alan teknik yazarlara yönelik kılavuz yer almaktadır.
Giriş
Dokümanlar Sezona hoş geldiniz! Bu kılavuz, Dokümanlar Dönemi'ne katılımınızla ilgili biraz bilgi verir ve programın her aşamasında gerçekleştirmeniz gereken etkinlikler konusunda size yardımcı olur.
Dokümanlar Dönemi'ne katılmaya uygunluk
Dokümanlar Sezonu'na teknik yazar olarak katılmak için aşağıdaki şartları karşılamanız gerekir:
- Kayıt sırasında en az 18 yaşında olmanız gerekir.
- Rol açıklamalarını ve çalışma örneklerini göndererek önceki teknik yazım deneyimini gösterebilme.
- Program süresince ikamet ettikleri ülkede çalışmaya uygunluk.
- Şu anda ABD tarafından ambargo uygulanmayan bir ülkede ikamet eden kişiler. ABD Hazinesi'nden Yaptırım Programları ve Ülke Bilgileri'ni inceleyin.
Teknik yazar şartlarının tamamını inceleyin.
Açık kaynak mentorlarınız
Dokümanlar danışmanları teknik yazarlar olmayabilir ve teknik iletişim konusunda çok az deneyime sahip olabilirler. İyi belgelemenin değerini bilen, açık kaynaklı süreçler ve araçlar konusunda deneyime sahip olan açık kaynak organizasyonunun üyeleridir.
Mentorlarınızla aranızdaki ilişki bir ortak çalışma ürünüdür. Açık kaynak organizasyonuna belgeleme deneyim ve becerileri kazandırıyorsunuz. Mentorlarınız açık kaynak ve kod bilgileriyle katkıda bulunur. Birlikte teknik belgeler geliştirebilir ve açık kaynaklı projenin süreçlerini iyileştirebilirsiniz.
Program duyurusu ve kurum başvuru aşamaları
Dokümanlar Sezonu için duyurulan tarih 11 Mart 2019'dur. İlgilenen açık kaynak kuruluşlar, 2 Nisan 2019 - 23 Nisan 2019 tarihleri arasında Dokümanlar Sezonu'na katılmak için başvurabilir. Google program yöneticileri, başarılı kuruluşların listesini 30 Nisan 2019'da yayınladı.
Program duyurusu ile programa katılan açık kaynak kuruluşların yayınlanması arasındaki dönemde gelişmeleri takip etmenizi öneririz. Bu web sitesine geri dönebilir ve ayrıca web'deki blog yayınlarını veya diğer haberleri izleyebilirsiniz. Bazı açık kaynak kuruluşlar, kuruluşun başvuru aşamasında bile fikirlerini paylaşabilir.
Ayrıca Dokümanlar'ın Sezonu'nu ve programa neden ilgi gösterdiğinizi herkese duyurmaya davet ediyoruz. Grafikler ve fikirler için promosyon materyaline göz atın.
Teknik yazar keşfi aşaması
Teknik yazar keşfi aşaması 30 Nisan - 28 Mayıs 2019 tarihleri arasında gerçekleştirilir. Bu süre zarfında, katılımcı kurumların listesini ve proje fikirlerini inceleyebilirsiniz.
İlginizi çeken bir ya da daha fazla proje bulduğunuzda proje fikirlerini tartışmak için doğrudan ilgili açık kaynak kuruluşuyla iletişime geçmelisiniz.
| Bu aşamada teknik yazar olarak görevleriniz | |
|---|---|
|
Katılımcı açık kaynak kuruluşlarının listesini ve bu kuruluşların proje fikirlerini keşfedin. |
Birlikte çalışmak istediğiniz açık kaynak kuruluşu bulmak için listeyi inceleyin. Kuruluşların önerdiği teknik yazım projelerine bakıp hangi projelerin size uygun olduğuna karar verin. Birden fazla kuruluşa başvurabilirsiniz. Dokümanlar Sezonu'nun bu aşamasında birden fazla seçeneği keşfetmek iyi bir fikirdir. Son seçim süreci teknik yazar başına yalnızca bir proje kabul eder. |
|
Açık kaynak kuruluşlarıyla proje fikirlerini tartışın. |
Proje fikirlerini, proje fikirlerini katılımcı kuruluşlarla tartışabilirsiniz. İletişim kurmak için kuruluşun katılımcı kuruluşlar listesinde gösterilen e-posta adresini kullanın. Erken görüşmeler, teknik yazar başvurusu aşamasında Google program yöneticilerine göndermek üzere iyi bir proje teklifi hazırlamanıza yardımcı olur. İlk proje fikirleri, kurumun önerdiği fikirler listesinden alınabilir. Kendi fikirlerinizi de önerebilirsiniz. |
Teknik yazar başvuru aşaması
Teknik yazar başvurusu aşaması 29 Mayıs 2019 - 28 Haziran 2019 tarihleri arasında gerçekleşecektir. Bu dönemde, Dokümanlar Dönemi'ne katılmak için başvurabilirsiniz. Google program yöneticileri, uygulamanızdaki ilgili ayrıntıları seçtiğiniz açık kaynak kuruluşa iletir. Açık kaynak kuruluş yöneticileri ve mentorları, mentorluk yapmak istedikleri projeleri seçer.
| Bu aşamada teknik yazar adayı olarak görevleriniz | |
|---|---|
|
Dokümanlar Sezonu'na katılmak için başvurunuzu gönderin. |
Dokümanlar Sezonu başvurunuzu 28 Haziran 2019'dan önce gönderin. 2019 Sezonu Dokümanlar teknik yazar başvuruları sona erdi. |
Toplulukla bağ kurma aşaması
Toplulukla bir araya gelme aşaması 7 Ağustos-1 Eylül 2019 tarihleri arasında gerçekleşecek. Bu süre boyunca açık kaynak mentorlar, açık kaynak projesi ve topluluğu hakkında bilgi edinmenize yardımcı olur.
| Bu aşamada teknik yazar olarak görevleriniz | |
|---|---|
|
İletişim kanalları oluşturabilirsiniz. |
Birlikte çalışmayı seçtiğiniz açık kaynak kuruluştaki mentorlarınızla iletişime geçin. Mentorunuzla ve kuruluş yöneticileriyle doğrudan iletişim kurmak için güvenilir bir yönteme sahip olduğunuzdan emin olun. Kuruluş yöneticileri, kuruluşları için Dokümanlar'ın ana Sezonu olarak görev yapan açık kaynak kuruluşunun üyeleridir. |
|
Açık kaynak projesine ve topluluğa dahil olun. |
Açık kaynak kuruluşun kullandığı araçlar ve süreçler hakkında mentorunuza sorular sorun. Açık kaynak topluluğunun posta listeleri, sohbet, Slack kanalı ve diğer tüm paylaşılan iletişim kanallarında kendinizi tanıtın. |
|
Ürünü bir bütün olarak anlamak. |
Mentorunuzdan, yakında belgeleyeceğiniz ürünü (özellikle kavramsal olarak) açıklamasını isteyin. Belgelerin hedef kitlesiyle ayrıntılı olarak görüşün. |
|
Hedefler ve beklentileri belirleyin. |
Teknik yazı projenizin hedeflerini hassaslaştırmak ve her iki tarafta da beklentileri belirlemek için mentorunuzla birlikte çalışın. Bu hedefleri ve beklentileri şimdi belirlemek projenizin başarılı olmasını sağlamanın iyi bir yoludur. |
Belge geliştirme aşaması
Belge geliştirme aşaması 2 Eylül 2019 ile 22 Kasım 2019 tarihleri arasında gerçekleştirilir. (Uzun süren projeler için bitiş tarihi farklıdır.) Bu süre boyunca mentorlarınızla yakın danışarak projeniz üzerinde çalışıyorsunuz.
| Bu aşamada teknik yazar olarak görevleriniz | |
|---|---|
|
Projenizi tamamlamak için mentorunuzla birlikte çalışın. |
Projenizi tamamlamak için mentorunuzla yakından çalışın. Ortaya çıkan belgelerin incelenmesini istemek ve güncellemeleri açık kaynak deposuna göndermek için açık kaynak topluluğu prosedürlerini uygulayın. Örneğin, GitHub'da barındırılan açık kaynak projeler, inceleme ve gönderim için alma isteği oluşturarak dosya ekler veya günceller. |
|
Endişelerinizi kuruluşun yöneticisine iletme |
Mentorlarınızla iletişim kurma konusunda endişeleriniz varsa veya projenizin başarıyla tamamlanmasını etkileyebilecek başka sorunlarla karşılaşırsanız açık kaynak kuruluş yöneticisine bildirin. |
|
Google program yöneticilerinin anketlerini tamamlayın. |
Google program yöneticileri, ilerlemeyi değerlendirmek için proje ortasında bir anket gönderebilir. Anketi doldurup cevaplarınızı anket belgesinde belirtildiği şekilde Google program yöneticilerine gönderin. |
Projeyi kesinleştirme ve değerlendirme aşaması
Projenin kesinleşme aşaması 25-29 Kasım 2019 tarihleri arasında, değerlendirme aşaması ise 25 Kasım - 6 Aralık 2019 tarihleri arasında gerçekleşecektir. (Uzun süreli projeler için tarihler farklıdır.) Projenin kesinleşme süresi boyunca nihai çalışma ürünleriniz de denen proje raporunuzu gönderirsiniz. Değerlendirme aşamasında, mentorlarınız hakkındaki değerlendirmenizi ve Dokümanlar Sezonu'nun katılımcısı olarak yaşadığınız deneyimi sunarsınız.
| Bu aşamada teknik yazar olarak görevleriniz | |
|---|---|
|
Proje raporunuzu yazın. |
Proje raporunuzu yazın (bazen iş ürününüz olarak da adlandırılır). Proje raporu, Dokümanlar Sezonu boyunca yaptığınız çalışmaların bir açıklamasını ve ilgili bağlantıları içerir. 2019 Dokümanlar Dönemi projesinin sonuçlandırma aşaması sona erdi. |
|
Mentorunuzdan proje raporunuzu incelemesini isteyin. |
Mentorunuz başarılarınızı nasıl açıklayacağınız konusunda değerli bilgilere sahip olabilir. Ayrıca mentorunuz projeyi başarılı bir şekilde tamamlayıp tamamlamadığınızı belirtmeden önce bu aşamada projenin durumu konusunda ortak bir anlayışa sahip olmak faydalı olur. |
|
Proje raporunuzu sonuçlandırın. |
Proje raporunuzu 28 Şubat 2020 saat 18:00'e (UTC) kadar kesinleştirin. Form düzenlenebilir ancak belirtilen tarihe kadar son sürümü göndermeniz gerekir. 2019 Dokümanlar Dönemi projesinin sonuçlandırma aşaması sona erdi. |
|
Mentorunuzla ilgili değerlendirmenizi ve Dokümanlar Sezonu deneyiminizi yazıp gönderin. |
Değerlendirmenizi 28 Şubat 2020 saat 18:00 (UTC) tarihine kadar tamamlayıp gönderin. Teknik yazarlar tarafından yapılan değerlendirmeler 2019 Dokümanlar Dönemi projesinin sonuçlandırma aşaması sona erdi. |
Uzun süreli projeler
Dokümanlar Sezonu'ndaki standart uzunlukta teknik yazarlık projeleri için doküman geliştirme aşaması 2 Eylül 2019 - 22 Kasım 2019 tarihleri arasında gerçekleştirilir. Ancak bazı teknik yazarlar, açık kaynak kuruluşuna danışmak üzere uzun süreli bir projeye başvurabilir. Uzun süreli bir projede belge geliştirme aşaması 2 Eylül 2019 ile 21 Şubat 2020 arasında gerçekleştirilir.
Uzun süreli projeler için projenin kesinleşme ve değerlendirme dönemi 24-28 Şubat 2020'dir.
Görevleriniz ve sorumluluklarınız, standart uzunluktaki teknik yazarlık projeleri için bu sayfada açıklananlarla aynıdır. Tek fark, proje kesinleştirme ve değerlendirme tarihlerinin daha sonra olmasıdır.
İlgili bilgiler
- Dokümanlar dönemi zaman çizelgesini inceleyin.
- Seçtiğiniz açık kaynak kuruluşla olan ilişkiniz hakkında daha fazla bilgi edinmek için kuruluş yöneticisi ve mentorluk sorumluluklarını ve teknik yazarla çalışma ile ilgili mentor yönergelerini okuyun.