Proje fikirleri

Mevcut aşama:
Dökümanlar Sezonu 2019 programı 6 Mart 2020'de sona erdi. Zaman çizelgesini inceleyin.

Proje fikirleri, teknik yazarın Dokümanlar Sezonu sırasında bir mentorla ortak çalışarak tamamlayabileceği projeler için açık kaynak bir kuruluşun önerileridir.

Bu sayfadaki bilgiler, proje fikirleri listesini hazırlayan açık kaynak kuruluş yöneticileri ve danışmanlar içindir. Bu bilgiler, teknik yazarlar için kuruluşların Dokümanlar Sezonu'na katılımıyla ilgili arka plan olarak da yararlıdır.

Örnek projeler

Aşağıda, teknik yazarın başa çıkabileceği proje türüyle ilgili bazı fikirler verilmiştir:

  • Platformda teknik yazar ve açık kaynak mentorun karar vereceği 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.

Yukarıdaki fikirler, kapsam ve boyut bakımından kasıtlı olarak farklılık göstermektedir. Bir projenin süresi; belge setinin boyutu, ürünün karmaşıklığı, teknik yazar ve açık kaynak mentorların deneyimi, açık kaynak projenin sunduğu araçlar ve süreçler ve daha fazlası dahil olmak üzere bir dizi faktöre bağlıdır.

Yukarıdaki listede amacımız başlangıç yapmaktır. Başka proje türleri de önerebilirsiniz.

Proje fikirleri listenizi yayınlayın

Proje fikirlerinizi herkese açık bir web sayfasında, bir blog yayınında veya herkese açık başka bir belgede yayınlamalısınız.

Proje fikirleri sayfanız şunları içermelidir:

  • Açık kaynak kuruluşunuzla ilgili bilgiler:

    • Kuruluş adı.
    • Kuruluş açıklaması.
    • Açık kaynak deponuza ve/veya web sitenize yönlendiren bir bağlantı.
    • (İsteğe bağlı) Dokümanlar Sezonu hakkında kuruluşunuzla iletişime geçmek için kullanılacak e-posta adresi. Bu adres, kuruluşunuzun Dokümanlar Sezonu başvuru formuna eklediğiniz e-posta adresiyle aynı olmalıdır.
    • (İsteğe bağlı) Kuruluşunuzun yönetimi ve mentorlarıyla ilgili bilgiler (ör. görünen adları). Bunlar, kuruluşunuzun Dokümanlar Sezonu başvuru formuna eklediğiniz görünen adlarla aynı olmalıdır.

  • Kuruluşunuzun bu yılki Dokümanlar Dönemi'ne katılmak için başvurduğuna dair bir duyuru. Tanıtım ve basın sayfasında, Dokümanlar Sezonu hakkında konuşurken kullanabileceğiniz logolar ve başka içerikler bulunur.

  • Her bir proje fikri için aşağıda açıklanan bilgiler de dahil olmak üzere proje fikirleriniz.

Kuruluşunuzun Dokümanlar Sezonu başvurusunu oluştururken proje fikirleri sayfanıza bir bağlantı eklemeniz gerekir.

Her proje fikrindeki bilgiler

Her proje fikri en azından aşağıdaki bilgileri içermelidir:

  • Proje adı: Kısa ancak açıklayıcı bir başlık seçin.
  • Açıklama: Gereken belge çalışmasının daha uzun bir açıklaması. İlk fikrinizi ayrıntılı bir şekilde açıklayın. Konuyla ilgilenen teknik yazarlara fikri geliştirmeleri veya hassaslaştırmaları için fırsatlar sunun.

  • İlgili materyal:

    • Belge ihtiyacı olan açık kaynak projesinin bağlantısı.
    • Mevcut bir belge setinde güncellemeler yapılmasını içeren teknik bir yazım projesi öneriyorsanız söz konusu belge setine bağlantı verin.
    • Bir eğitim veya bir dizi nasıl yapılır kılavuzu öneriyorsanız belgelenmesi gereken özellikleri ya da kullanım alanlarını açıklayın.
    • Katkıda bulunanlar için bir kılavuz öneriyorsanız mevcut bir README dosyasına veya varsa diğer ilgili materyallere bağlantı verin. Henüz kullanılabilir bir şey yoksa bunu söylemenizde sakınca yoktur.
    • Gerekirse diğer projelerdeki benzer belgelerin bağlantılarını ekleyin.

Proje fikirlerinin önemi

Proje fikirleriniz çeşitli açılardan önemlidir:

  • Fikirler üzerinde çalışmak, kurumunuzun gerekli belge görevlerini belirlemesine ve teknik yazarla çalışmaya hazırlanmasına yardımcı olur.
  • Proje fikirleri Google program yöneticilerine, teknik yazarların kurumunuzla mentorluk ilişkisine girdiklerinde nasıl bir çalışmayla uğraşacaklarına dair bir gösterge sağlar. Google program yöneticileri, kurumun Dokümanlar Sezonu'na katılım ve program boyunca teknik yazarlara mentorluk yapma taahhüdünü değerlendirmek için proje fikirlerini kullanır.
  • Proje fikirleri ilgili teknik yazarları kuruluşunuza çeker. Sizin önerdiğiniz projelerinizi, kendi proje teklifleri için temel olarak kullanabilirler.
  • Tanıtım ve basın sayfasında, 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ı bulmaları için düzenlemeyle ilgili ipuçları verilmektedir: Daniele Procida'nın belgelerle ilgili bilgi vermediği içerikler.