Bu sayfa, Google Dokümanlar Sezonu için kabul edilen teknik yazı projesinin ayrıntılarını içerir.
Proje özeti
- Açık kaynak kuruluşu:
- moja global
- Teknik yazar:
- Ahmet
- Proje adı:
- Raporlama Aracı Kodu Dokümanları
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Moja Global kuruluşu için Raporlama Aracı'nı belgeleme fırsatı bulduğumda, farklı amaçlar için farklı kitleler tarafından kullanılacak 6 tür belge geliştirmeyi öneriyorum. Bu değişiklikler 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şturmalarına yardımcı olun.
1.3) Biçim Raporlama Aracı'nın derlenmesi ve çalıştırılmasına elverişli olacak ortamı ayarlamak için Sistem Mühendislerinin uygulaması gereken sıralı adımları açıklayan Bir Nasıl Yapılır Makalesi.
2) Oluşturma Kılavuzu
2.1) Hedef Kitle Sistem Mühendisleri
2.2) Amaç Sistem Mühendislerinin kaynak kodundan Raporlama Aracı bileşenlerini oluşturmaları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) Kurulum Kılavuzu
3.1) Hedef Kitle Sistem Mühendisleri
3.2) Amaç Sistem Mühendislerinin yeni oluşturulan Raporlama Aracı bileşenlerini yüklemelerine yardımcı olma
3.3) Biçim Sistem Mühendislerinin, Raporlama Aracı'nı yeni kurulmuş bir ortamda dağıtmak için atması gereken sıralı adımları açıklayan bir Nasıl Yapılır Makalesi.
4) Operasyon Rehberi
4.1) Hedef Kitle Sistem Entegratörleri
4.2) Amaç Sistem Mühendislerinin yeni yüklenmiş bir Raporlama Aracı örneğini çalıştırmasına yardımcı olma
4.3) Biçim Sistem Entegratörü'nün çalışan bir Raporlama Aracı örneğindeki Flux Çıktı Veritabanlarını yüklemek ve işlemek için uygulaması gereken sıralı adımları açıklayan Bir Nasıl Yapılır Makalesi.
Operasyon Rehberi Fux Çıktısı Veritabanlarını Raporlama Aracı'na ekleme ve işleme
5) Kullanıcı Rehberi
5.1) Hedef Kitle Son Kullanıcılar
5.2) Amaç Son Kullanıcıların İçerik Bildirme Aracı'nda yer alan farklı özellikleri ve bu özelliklerin nasıl kullanılması gerektiğini anlamalarına yardımcı olma.
5.3) Biçimlendirme Son Kullanıcıların Raporlama Aracı'nın İşlevlerini doğru bir şekilde kullanmak için atması 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 İçerik Bildirme Aracı'nda yer alan farklı özellikleri ve bu özelliklerin nasıl kullanılması gerektiğini anlamalarına yardımcı olma.
6.3) Biçim a) Aracı oluşturan ana tasarım öğeleri b) Yukarıdaki öğelerin işlevsel ayrımı c) İşlevsel olarak ayrıştırılan öğelerin yürütme öğeleri d) aracın kaynak kodu / kitaplık düzeni
Kodun kullanıcıya özel koşullara nasıl uygun olabileceğini açıklayan kısa bir eğitim de