Bu sayfada, Google Dokümanlar Sezonu için kabul edilen bir teknik yazım projesinin ayrıntıları yer almaktadır.
Proje özeti
- Açık kaynak kuruluşu:
- moja global
- Teknik yazar:
- Ahmet
- Proje adı:
- İçerik Bildirme Aracı Kodunun Dokümanları
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
Moja Global kuruluşu için Raporlama Aracı'nı belgeleme fırsatı verildiğinde, farklı amaçlar için farklı kitleler tarafından kullanılacak 6 tür doküman geliştirmeyi öneriyorum. Bunlar aşağıda özetlenmiştir:
1)Ortam Kurulum Kılavuzu
1.1) Hedef Kitle Sistem Mühendisleri
1.2) Amaç Sistem Mühendislerinin Raporlama Aracı için yerel bir derleme ve yürütme ortamı oluşturmasına yardımcı olun.
1.3) Şekillendirme: Raporlama Aracı'nın oluşturulması ve çalıştırılması için uygun ortamı ayarlamak üzere sistem mühendislerinin uygulaması gereken sıralı adımları açıklayan bir nasıl yapılır makalesi.
2) Derleme Kılavuzu
2.1) Hedef Kitle: Sistem Mühendisleri
2.2) Amaç Sistem mühendislerinin raporlama aracı bileşenlerini kaynak koddan oluşturmasına yardımcı olma
2.3) Biçim Sistem Mühendislerinin Raporlama Aracı'nın Kaynak Kodunu almak ve derlemek için uygulaması gereken sıralı adımları açıklayan bir Nasıl Yapılır Makalesi.
3)Yükleme Kılavuzu
3.1) Hedef Kitle: Sistem Mühendisleri
3.2) Amaç: Sistem mühendislerinin yeni oluşturulan Raporlama Aracı bileşenlerini yüklemesine yardımcı olun
3.3) Biçim Sistem Mühendislerinin, Raporlama Aracı'nı yeni oluşturulmuş bir ortama dağıtmak için sırayla atması gereken bir dizi adımın açıklandığı bir Nasıl Yapılır Makalesi.
4)Kullanım Kılavuzu
4.1) Hedef Kitle Sistem Entegratörleri
4.2) Hedef: Sistem Mühendislerinin yeni yüklenmiş bir Raporlama Aracı örneği çalıştırmasına yardımcı olma
4.3) Sistem entegratörlerinin, çalışan bir Raporlama Aracı örneğinde Flux Çıkış Veritabanı'nı yüklemek ve işlemek için uygulaması gereken sıralı adımları açıklayan bir Nasıl Yapılır makalesi biçimlendirin.
İşlem Kılavuzu Raporlama Aracı'nda Flux Çıkış Veritabanları'nı kullanmaya başlama ve işleme
5) Kullanıcı Rehberi
5.1) Hedef Kitle Son Kullanıcılar
5.2) Amaç: Son kullanıcıların, Raporlama Aracı'na yerleştirilmiş farklı özellikleri ve bu özelliklerin nasıl kullanılacağını anlamalarına yardımcı olun.
5.3) Biçim: Raporlama aracının işlevlerini doğru şekilde kullanmak için son kullanıcıların uygulaması gereken sıralı adımları açıklayan bir nasıl yapılır makalesi.
6) Geliştirme Kılavuzu
6.1) Hedef Kitle: Programcılar
6.2) Amaç Son Kullanıcıların Bildirim Aracı'nda yerleşik olan farklı özellikleri ve bu özelliklerin nasıl kullanılması gerektiğini anlamalarına yardımcı olma.
6.3) Biçim Aşağıdakileri açıklayan referans makaleler: a)Aracı oluşturan temel tasarım öğeleri b)Yukarıdaki öğelerin işlevsel olarak ayrıştırılması c)İşlevsel olarak ayrıştırılmış öğelerin yürütme öğeleri d)Aracı kaynak kodu / kitaplık organizasyonu e)Sürekli iyileştirme için uzun vadeli vizyon ve yön f)İyileştirme için mantıklı bir sonraki alanlar
Ayrıca, kodun kullanıcıya özgü koşullara nasıl ayarlanabileceğini açıklayan kısa bir eğitim