Bu sayfa, Google Dokümanlar Sezonu için kabul edilen bir teknik yazı projesinin ayrıntılarını içerir.
Proje özeti
- Açık kaynak kuruluşu:
- moja global
- Teknik yazar:
- Anıl
- Projenin adı:
- İçerik Bildirme 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ı göz önüne alarak, farklı kitleler tarafından farklı amaçlar doğrultusunda kullanılacak 6 tür belge geliştirmeyi öneriyorum. Bunlar aşağıda özetlenmiştir:
1) Ortam Kurulum Kılavuzu
1.1) Hedef Kitle Sistem Mühendisleri
1.2) Hedef Sistem Mühendislerinin İçerik Bildirme Aracı için yerel bir derleme ve yürütme ortamı oluşturmasına yardımcı olur.
1.3) Biçim Raporlama Aracı'nın geliştirilmesine ve çalıştırılmasına yardımcı olacak ortamı kurmak için Sistem Mühendislerinin uygulaması gereken sıralı adımları açıklayan Nasıl Yapılır Makalesi.
2)Oluşturma Kılavuzu
2.1) Hedef Kitle Sistem Mühendisleri
2.2) Hedef 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 Kodu'nu edinmek ve derlemek için uygulaması gereken sıralı adımları açıklayan 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 ortama dağıtmak için uygulaması gereken sıralı adımları açıklayan "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örlerinin çalışan bir Raporlama Aracı örneğindeki Akı Çıktısı Veritabanlarını yüklemek ve işlemek için uygulaması gereken sıralı adımları açıklayan Nasıl Yapılır Makalesi.
Operasyon Rehberi Alux Çıktı 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çim Son Kullanıcıların İçerik Bildirme Aracı'nın İşlevlerini doğru bir şekilde kullanmak için izlemesi gereken sıralı adımları açıklayan "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 Referans Makaleler: a) Aracı oluşturan ana tasarım öğeleri b) Yukarıdaki öğelerin işlevsel ayrışması c) İşlevsel olarak ayrıştırılan öğelerin yürütme öğeleri d) aracın kaynak kodu / kütüphane düzeni e) sürekli iyileştirme için uzun vadeli vizyon ve yön f) iyileştirme için mantıklı gelecek alanlar
Kodun kullanıcıya özel durumlara göre nasıl ayarlanabileceğini açıklayan kısa bir eğitim