İçeriğe atla
ALBA

Şirket hafızası ve bilgi tabanı · 11 / 20

Teknik belgeye soru sorup cevap almak

Bir sistemin arayüz belgesi yüzlerce sayfadır ve içinde arama yapmak bilgi gerektirir. Geliştirici ya da entegrasyonu yapan kişi doğru bölümü bulmak için belgeyi baştan tarar, çoğu zaman yanlış yerde arar ve iş uzar.

Otomatikleşince ne değişir

Soru düz cümleyle sorulur; belgenin ilgili bölümü bulunur ve cevap kaynak parçasıyla birlikte döner.

Çalışırken

Elle tetikli · 14 adım · 3 farklı adım türü

Yukarıdaki liste, akışın 14 adımı boyunca geçtiği 3 farklı adım türünü sırasıyla gösterir; aynı tür birden çok kez tekrarlanabildiği için liste toplam adım sayısından kısadır. Ok tuşlarıyla gezebilir, boşluk tuşuyla durdurabilirsiniz.

Teknik belgeye erişim bugün nasıl yapılıyor?

Bir sistemin arayüz belgesi yüzlerce sayfadır ve içinde arama yapmak bilgi gerektirir. Geliştirici ya da entegrasyonu yapan kişi doğru bölümü bulmak için belgeyi baştan tarar, çoğu zaman yanlış yerde arar ve iş uzar.

Yanlış yerde arama ne kaybettiriyor?

Saatler doğru bölümü bulmaya gidiyor, entegrasyon işi gecikiyor. Yanlış anlaşılan bir teknik detay hatalı bir uygulamaya yol açabiliyor. Bu hata genelde test aşamasında fark ediliyor, düzeltmek zaman alıyor.

Sistem kurulunca ne değişir?

Soru düz cümleyle soruluyor; belgenin ilgili bölümü bulunuyor ve cevap kaynak parçasıyla birlikte dönüyor. Belgeyi baştan taramaya gerek kalmıyor. Doğru bölüme doğrudan ulaşılıyor.

Sık sorulanlar

Bu iş hakkında sorulanlar

Kod örnekleri de bulunabiliyor mu?
Evet, belgedeki kod örnekleri de metin gibi aranabiliyor ve ilgili soruya karşılık geldiğinde döndürülüyor. Kod biçimlendirmesi mümkün olduğunca korunuyor. Karmaşık kod blokları bazen basitleştirilerek gösterilebiliyor.
Belge güncellenirse cevaplar da güncellenir mi?
Evet, sistem belgenin güncel sürümüne bakıyor, eski bir kopyaya güvenmiyor. Belge güncellendiği an yeni sorular güncel içeriğe göre yanıtlanıyor. Ayrı bir güncelleme adımına gerek kalmıyor, eski sürüm sessizce arşivde kalıyor.
Birden fazla belge birlikte aranabiliyor mu?
Evet, birden fazla teknik belge aynı sisteme yüklenip birlikte aranabiliyor. Hangi belgenin hangi konuyu kapsadığı ayrıca belirtilmesi gerekmiyor. Sistem bunu içerikten çıkarıyor ve doğru belgeye yönleniyor.
Yanlış bölüm bulunursa ne olur?
Sistem emin olamadığı bir eşleşmede bunu belirtiyor, kesin olmayan bir cevabı kesinmiş gibi sunmuyor. Kişi isterse belgenin ilgili kısmını kendisi kontrol edebiliyor. Yanlış eşleşme fark edildiğinde bildirilip iyileştirilebiliyor.
Ne kadar sürede kurulur?
Tek belge ve standart sorularla kurulum birkaç günle ölçülüyor. Birden fazla belge ya da sık güncellenen içerik süreyi uzatıyor. Kesin süre, mevcut belge hacmi incelendikten sonra yazılı olarak veriliyor.

Şeffaflık

Bu, sizin için kurulmuş bir iş değil — kurulabilecek bir iş.

Yukarıdaki adımlar çalışan bir iş akışı tanımından çıkarıldı. Sizin şirketinizde kurulduğunda adımların bir kısmı aynı kalır, bir kısmı sizin sisteminize göre değişir: hangi tabloya yazılacağı, kimin onaylayacağı, hangi belge biçimini okuyacağı. Görüşmede bunu birlikte çıkarıyoruz.

Aynı ailede

Şirket hafızası ve bilgi tabanı ailesindeki diğer işler

  1. Elle başlatılır
  2. Siteye yazı olarak yayımlanır
  3. Yollar birleştirilir
  4. Alanlar düzenlenir
  5. Kayıtlar süzülür
  6. Biçimlendirme dönüştürülür
  7. 3 adım türü daha
  1. Elle başlatılır
  2. Dış sisteme bağlanılır
  3. Sayfadan alan seçilir
  4. Özel kural çalıştırılır
  5. Alanlar düzenlenir
  6. Yollar birleştirilir
  7. 1 adım türü daha

Şirket hafızası ve bilgi tabanı ailesinin tamamı