Yardım belgelerini yönetme
Yardım belgeleri ekranı, konsol ekranlarında açılan yardım metinlerinin yazıldığı, yayına alındığı ve güncel tutulduğu yerdir. Yayındaki her belge yardım merkezinde, bağlı olduğu ekranların yardım çekmecesinde ve CLAI'nin yanıtlarında kaynak olarak kullanılır. Belgeler yalnızca Türkçe yazılır; İngilizcesi her kayıtta Türkçe metinden otomatik üretilir. Ekran, belge yazma yetkisi olan yöneticiler içindir; diğer kullanıcılar belgeleri yalnızca okur.
Ekrana ulaşma
Yardım belgeleri ekranı menüde yer almaz; şu yollardan açılır:
- Yardım merkezi sayfasının üstündeki Makaleleri yönet düğmesi.
- Yardım merkezinde bir makale açıkken başlığın yanındaki Düzenle düğmesi. Doğrudan o belgenin düzenleme sayfasını açar.
- Herhangi bir ekranda üst çubuktaki Bu ekranın yardımı simgesiyle (ya da bir metin kutusunda değilken
?tuşuyla) açılan yardım çekmecesi:- Ekranın yardımı varsa çekmecenin altındaki Düzenle bağlantısı görüntülenen belgeyi açar.
- Ekranın yardımı yoksa Bu ekran için henüz yardım yazılmadı mesajının altındaki Bu ekran için yardım yaz bağlantısı, o ekrana bağlı yeni bir belge açar.
Bu düğme ve bağlantılar yalnızca belge yazma yetkisi olan hesaplarda görünür. Yetkiniz olmadan sayfanın adresine giderseniz yetki uyarısı sayfasına yönlendirilirsiniz.
Ekranın bölümleri
Sayfanın üstünde Yardım belgeleri başlığı, sağ üstte Yardım merkezini aç bağlantısı ve Yeni belge düğmesi bulunur. Altında üç sekme yer alır:
| Sekme | Yanıtladığı soru |
|---|---|
| Belgeler | Hangi belgeler var, hangi durumdalar? Yanında toplam belge sayısı görünür. |
| Ekran kapsaması | Menüdeki hangi ekranın yayında yardımı yok? |
| Güncellik | Hangi belgenin ekranı, belge yazıldıktan sonra değişti? Eskimiş ya da Gözden geçirilmeli belge varsa yanında sayısı görünür. |
Belgeler sekmesi
Filtreleme ve arama
| Alan | Ne işe yarar | İpucu |
|---|---|---|
| Başlık ya da kimlik ara | Başlığında ya da kimliğinde yazdığınız metin geçen belgeleri gösterir. | Siz yazdıkça liste anında süzülür. |
| Durum | Yalnızca Taslak, Yayında ya da Arşivde olan belgeleri gösterir. | Seçim yapılmadığında (Tüm durumlar) hepsi listelenir. |
| Ekran süzgeci | Yalnızca belirli bir ekrana bağlı belgeleri gösterir; "Ekran: …" çipi olarak görünür. | Ekran kapsaması sekmesinde bir ekranın belge sayısı düğmesine basınca eklenir; arama ve durum süzgeçleri o sırada temizlenir. Çarpı ile kaldırırsınız. |
Sağda süzgece uyan belge sayısı görünür. Süzgeçler sayfa adresinde saklanır; adresi paylaşırsanız aynı liste açılır.
Liste
En son değiştirilen belge en üsttedir; sıralama değiştirilemez.
| Kolon | Anlamı |
|---|---|
| Başlık | Belgenin başlığı ve altında kimliği. Güncellik kontrolü belgeyi Eskimiş ya da Gözden geçirilmeli olarak işaretlediyse başlığın yanında Güncelliği şüpheli rozeti çıkar; rozetin üzerine gelince kontrolün gerekçesi görünür. |
| Durum | Taslak, Yayında ya da Arşivde. |
| Bağlı ekranlar | Belgenin yardım çekmecesinde göründüğü ekranlar ("ürün · ekran adı"). Birden fazla ekran varsa ilki ve kalanların sayısı yazar ("… ve 2 ekran daha" gibi); üzerine gelince tam liste görünür. Hiç ekran bağlı değilse Bağlı ekran yok yazar (genel konu belgeleri böyledir). |
| Son değişiklik | Son kaydın tarihi ve saati, altında kaydı yapan kişi. |
| Doğrulama | Belgenin ekranla en son ne zaman karşılaştırıldığı. Hiç işaretlenmediyse Hiç doğrulanmadı rozeti, son doğrulama 90 günden eskiyse tarih ve yanında "— eski" yazan sarı rozet görünür; aksi hâlde yalnızca tarih yazar. |
Bir satıra tıkladığınızda belgenin düzenleme sayfası açılır. Hiç belge yoksa Henüz belge yok, süzgece uyan belge yoksa Süzgece uyan belge yok yazar.
Ekran kapsaması sekmesi
Bu sekme, menüdeki her ekranın okuyucuya açık bir yardımı olup olmadığını gösterir.
En üstteki özet kartında "40 / 120 ekranın yayında yardımı var" biçiminde bir satır bulunur. Yalnızca taslağı olan ekran varsa yanında "5 ekranda yalnız taslak var" biçiminde bir not çıkar. Sağdaki Yalnız yayında yardımı olmayanlar kutusunu işaretlerseniz yayında yardımı olan ekranlar gizlenir, yalnızca yapılacak işler kalır. Bütün ekranların yardımı varsa bu durumda Bütün ekranların yayında yardımı var yazar.
Altında ekranlar ürüne göre gruplanmış kartlarda listelenir. Her satırda ekranın menüdeki adı, altında ekran adresi ve bir kapsama rozeti bulunur:
| Rozet | Anlamı |
|---|---|
| Yayında | Ekrana bağlı en az bir yayındaki belge var; okuyucu yardım çekmecesinde bunu görür. |
| Yalnız taslak | Ekrana bağlı belge var ama hiçbiri yayında değil. Okuyucu hâlâ boş çekmece görür; bu ekran kapsanmış sayılmaz. |
| Yardım yok | Ekrana bağlı yayında ya da taslak belge yok. Arşivdeki belgeler hesaba katılmaz. |
Satırdaki düğmeler:
- Belgeyi aç: Ekrana bağlı (arşiv dışı) tek belge varsa onu açar.
- Belge sayısı düğmesi ("2 belge" gibi): Birden fazla belge varsa Belgeler sekmesini o ekrana süzülmüş açar. Orada arşivdeki belgeler de listelendiği için sayı farklı olabilir.
- Yaz: Ekranın yayında yardımı yoksa görünür. Bu ekrana bağlı yeni bir belge açar.
Yalnız taslak durumundaki ekranda Yaz ikinci, ayrı bir belge başlatır. Var olan taslağı yayına almak için onu açıp durumunu Yayında yapın.
Liste yalnızca hesabınızın menüde görebildiği ekranlardan oluşur. Menüde olmayan detay sayfaları (ör. bir siparişin kendi sayfası) burada çıkmaz; onları düzenleme sayfasında elle bağlarsınız.
Güncellik sekmesi
Her hafta otomatik bir kontrol, belgenin bağlı olduğu ekranları belge kaydedildiği andaki hâlleriyle karşılaştırır ve belgenin hâlâ doğru olup olmadığına dair bir karar yazar. Bu sekme her belgenin son kararını listeler.
Özet ve süzgeç
Üstteki kartta her güncellik durumu için bir rozet ve yanında belge sayısı bulunur (ör. "Eskimiş: 3"). Bir rozete tıklamak listeyi o duruma göre süzer; aynı rozete tekrar tıklamak süzgeci kaldırır. Aynı işi listenin üstündeki Güncellik durumu kutusuyla da yapabilirsiniz (Tüm durumlar süzgeci kaldırır).
Listede arşivdeki belgeler yer almaz. Henüz hiç kontrol kaydı olmayan belgeler yalnızca yayındaysa ve en az bir ekrana bağlıysa listelenir; hiçbir ekrana bağlı olmayan konu belgeleri ve taslaklar, kontrol kaydı oluşana kadar burada görünmez. Satırlar önem sırasına göre dizilir: Eskimiş, Gözden geçirilmeli, Kontrol edilmedi, Küçük değişiklik, Güncel. Aynı grupta en yeni kontrol üsttedir.
Liste
| Kolon | Anlamı |
|---|---|
| Başlık | Belgenin başlığı (tıklayınca düzenleme sayfası açılır) ve kimliği. |
| Güncellik | Son kontrolün kararı. Hiç kontrol yoksa Kontrol edilmedi. Hâlâ doğru işaretlenmiş ya da ilk kez karşılaştırma noktası alınmış belgelerde Referans alındı yazar; bu belgeler Güncel grubunda sayılır. |
| Gerekçe | Kararın kısa açıklaması: ekranda ne değiştiği, belgenin hangi kısmının etkilenebileceği. Hiç kontrol yoksa Haftalık kontrol bu belgeye henüz uğramadı yazar. |
| Değişiklikler | Kaç dosyanın ve arayüz etiketinin değiştiği ("2 dosya, 1 etiket"). Düğmeye basınca satırın altında ayrıntı açılır, tekrar basınca kapanır. |
| Kontrol | Kontrolün tarihi ve saati. |
Açılan ayrıntıda değişen dosyalar (değişti, eklendi, silindi ya da ekran kalktı rozetiyle; sonuncusu bağlı ekranın artık konsolda olmadığını gösterir), değişen arayüz etiketleri ("eski → yeni") ve karşılaştırmanın tarihi görünür. Belgede kalın yazdığınız bir düğme adı değiştiyse etiket listesinde görürsünüz.
Her satırın sağında iki düğme vardır:
- Aç: Belgenin düzenleme sayfasını açar.
- Hâlâ doğru: Belgeyi değiştirmeden, ekranın bugünkü hâlini yeni karşılaştırma noktası yapar (bkz. aşağıdaki işlem). Güncel grubundaki satırlarda görünmez. Bir doğrulama sürerken bütün satırlardaki Hâlâ doğru düğmeleri pasif olur; basılan satırda Doğrulanıyor… yazar.
Haftalık kontrol hiç çalışmadıysa Haftalık güncellik kontrolü henüz çalışmadı notu çıkar ve yayındaki bütün belgeler Kontrol edilmedi görünür; bu bir arıza değildir. Liste boşsa Bütün belgeler güncel yazar.
İşlemler
Yeni belge yazma
- Yeni belge düğmesine basın ya da Ekran kapsaması sekmesinde bir ekranın Yaz düğmesini kullanın.
- Başlık alanını doldurun. Yeni belgede Kimlik (slug) başlıktan kendiliğinden üretilir (ör. "Sipariş İade Süreci" →
siparis-iade-sureci). Kimliği elle değiştirirseniz başlıktan üretme durur. - Özet, Etiketler ve Bağlı ekranlar alanlarını doldurun (alan kuralları aşağıda).
- Metin (Markdown) alanına belgeyi yazın; önizlemede nasıl görüneceğini izleyin.
- Durum alanını seçin. Yeni belge Taslak olarak başlar; okuyuculara açmak için Yayında seçin.
- Kaydet düğmesine basın (ya da Ctrl+S / ⌘+S).
Kayıt sırasında sağ üstte Kaydediliyor ve İngilizceye çevriliyor… yazar ve form kilitlenir; kayıt birkaç saniye sürebilir. Kayıt bitince Belge kaydedildi (çeviri de yenilendiyse Belge kaydedildi, İngilizce çeviri güncellendi) bildirimi çıkar, sayfa belgenin kendi adresine geçer ve alttaki paneller görünür.
Var olan belgeyi düzenleme
- Belgeler listesinde satıra tıklayın (ya da yardım çekmecesinde veya yardım merkezinde Düzenle'ye basın).
- Alanları değiştirin. Değişiklik yaptığınız anda sağ üstte Kaydedilmemiş değişiklikler rozeti çıkar.
- Kaydet'e basın.
Kaydedilmemiş değişiklik varken konsolda başka bir sayfaya geçmek isterseniz Kaydedilmemiş değişiklikler kaybolacak. Sayfadan çıkılsın mı? onayı sorulur; sekmeyi kapatır ya da sayfayı yenilerseniz tarayıcı kendi uyarısını gösterir. Belge yayındaysa sağ üstteki Yardım merkezinde gör bağlantısıyla okuyucunun gördüğü hâli açabilirsiniz.
Ekranla karşılaştırıp doğrulandı olarak işaretleme
Belgeyi ekranla karşılaştırıp doğru olduğundan emin olduğunuzda, kaydetmeden önce Ekranla karşılaştırıldı, metin güncel kutusunu işaretleyin. Kayıtla birlikte doğrulama tarihi bugün olur ve listedeki Doğrulama kolonu güncellenir. Kutunun altında son doğrulama tarihi ya da Hiç doğrulanmadı yazar. Kutu kayıttan sonra kendiliğinden boşalır.
Hâlâ doğru (güncellik uyarısını kapatma)
Kontrol bir belgeyi Gözden geçirilmeli ya da Eskimiş işaretlediyse ama belge hâlâ doğruysa:
- Güncellik sekmesinde satırdaki Hâlâ doğru düğmesine ya da düzenleme sayfasındaki Güncellik panelinde Hâlâ doğru — kodu bugüne al düğmesine basın. Onay sorulmaz; işlem hemen yapılır.
- Belge doğrulandı; bugünkü kod referans alındı bildirimi çıkar. Belgenin kararı Referans alındı olur ve satır Güncel grubuna geçer.
Bu işlem belgenin metnini kaydetmez; yalnızca sonraki haftalık kontrolün karşılaştırma noktasını bugüne taşır. Kaydedilmemiş değişiklik varken panel bunu ayrıca hatırlatır; metninizi Kaydet ile kaydedin. Her kayıt da karşılaştırma noktasını bugüne alır; belgeyi düzeltip kaydettiyseniz Hâlâ doğru'ya basmanız gerekmez.
Bu sürümde kod manifesti yok uyarısı gelirse doğrulama şu an yapılamıyordur; belge değiştirilmemiştir, daha sonra tekrar deneyin.
Eski bir sürüme dönme
- Sürümler panelinde bir kayda tıklayın. Her satırda kayıt tarihi, kişi, metnin karakter sayısı ve o sürümdeki durum görünür.
- Açılan Sürüm önizlemesi penceresinde o sürümün başlığını, durumunu, özetini ve metnini inceleyin.
- Editöre yükle düğmesine basın. Başlık, özet, etiketler, bağlı ekranlar ve metin forma yüklenir; Sürüm editöre yüklendi — kaydetmeyi unutmayın bildirimi çıkar.
- Kaydet'e basın.
Editöre yükleme tek başına hiçbir şeyi kaydetmez. Belgenin Durum alanı da yüklenmez; formdaki mevcut durum korunur. Kaydettiğinizde eski metin yeni bir sürüm olarak geçmişe eklenir ve İngilizce çeviri yeniden üretilir.
Belgeyi silme
- Düzenleme sayfasında Belgeyi sil düğmesine basın.
- Belge silinsin mi? penceresinde belgenin bütün okuyuculardan ve CLAI'den kaldırılacağı ve işlemin geri alınamayacağı belirtilir; pencerede belgenin kimliği de yazar.
- Onaylamak için penceredeki Belgeyi sil'e, vazgeçmek için Vazgeç'e basın.
Silme başarılı olunca Belge silindi bildirimi çıkar ve belge listesine dönersiniz. Silme geri alınamadığı için, belgeyi yalnızca okuyuculardan gizlemek istiyorsanız durumunu Arşivde yapıp kaydetmeniz daha güvenlidir. Belgeyi sil düğmesi yeni (henüz kaydedilmemiş) belgede görünmez, kayıt sürerken pasiftir.
Durumlar
Belge durumu
| Durum | Anlamı | Sonraki adım |
|---|---|---|
| Taslak | Yazılıyor; okuyucular ve CLAI görmez. | Metin hazır olunca durumu Yayında yapıp kaydedin. |
| Yayında | Yardım merkezinde, bağlı ekranların yardım çekmecesinde ve CLAI'de görünür. | Güncellik sekmesini düzenli izleyin. |
| Arşivde | Okuyuculardan kaldırılmış ama silinmemiş. Ekran kapsamasında ve güncellik listesinde sayılmaz. | Gerekirse tekrar Yayında yapabilirsiniz. |
Güncellik durumu
| Durum | Anlamı | Sonraki adım |
|---|---|---|
| Eskimiş | Belgede yazan bir şey artık ekranla uyuşmuyor ya da bağlı ekran kaldırılmış. | Belgeyi güncelleyip kaydedin; bağlı ekran kalktıysa bağı kaldırın ya da belgeyi arşivleyin. |
| Gözden geçirilmeli | Ekranda kullanıcının gördüğü bir şey değişti. | Gerekçe ve Değişiklikler'e bakın; belge doğruysa Hâlâ doğru, değilse düzenleyip kaydedin. |
| Kontrol edilmedi | Haftalık kontrol bu belgeye henüz uğramadı. | Bekleyin ya da Hâlâ doğru ile bugünkü hâli karşılaştırma noktası yapın. |
| Küçük değişiklik | Ekranın kodunda değişiklik var ama kullanıcıya görünen bir fark yok. | Genellikle işlem gerekmez. |
| Güncel | Son kontrolden bu yana ekranda değişiklik yok. Referans alındı kararı da bu grupta sayılır. | İşlem gerekmez. |
Detay / düzenleme sayfası
Düzenleme sayfasının başlığı yeni belgede Yeni yardım belgesi'dir; altında Türkçe yazın; İngilizcesi kayıtta otomatik üretilir. notu yer alır. Var olan belgede başlık belgenin adıdır; altında son kaydın tarihi ve kişisi görünür.
Form alanları
| Alan | Zorunlu | Açıklama / kural |
|---|---|---|
| Başlık | Evet | En fazla 200 karakter. Yardım merkezinde ve çekmecede görünen ad. |
| Kimlik (slug) | Evet | 2–120 karakter; küçük harf, rakam ve tek tire (başta/sonda tire olmaz). new ve var olan bir belgenin kimliği kullanılamaz. İlk kayıttan sonra değiştirilemez; bağlantılar ve CLAI bu kimliği kullanır. |
| Özet | Hayır | En fazla 500 karakter. Listelerde ve arama sonuçlarında görünen bir iki cümle. |
| Durum | Evet | Taslak, Yayında, Arşivde. Yalnız yayındaki belgeler okuyuculara ve CLAI'ye görünür. |
| Etiketler | Hayır | En fazla 20 etiket, her biri en fazla 40 karakter. Etiketi yazıp Enter'a ya da virgüle basın; virgüllü bir liste yapıştırırsanız tek tek bölünür. Aynı etiket iki kez eklenmez. Kutu boşken Backspace son etiketi siler. |
| Bağlı ekranlar | Hayır | En fazla 30 ekran. Belge bu ekranların yardım çekmecesinde görünür. Menüden ekran seç kutusundan menüdeki ekranları arayıp seçin. Menüde olmayan bir detay sayfası için alttaki kutuya adresini yazıp Ekle'ye basın (ör. /oms/orders/$number). Seçilenler çip olarak görünür; çarpı ile kaldırılır. |
| Metin (Markdown) | Hayır | En fazla 100.000 karakter. Belgenin gövdesi. |
Kurala uymayan bir alanla Kaydet'e basarsanız Formda düzeltilmesi gereken alanlar var bildirimi çıkar, hatalı alanların altında ne düzeltilmesi gerektiği yazar ve kayıt yapılmaz. Kayıt başarısız olursa Belge kaydedilemedi bildirimi çıkar; yazdıklarınız formda kalır.
Metin editörü
Geniş ekranda yazma alanı solda, canlı önizleme sağdadır; dar ekranda üstteki Yaz / Önizleme düğmeleriyle ikisi arasında geçersiniz.
Araç çubuğunda Kalın, Başlık, Liste, Bağlantı ve Kod simge düğmeleri vardır. Metin seçiliyken seçimi biçimlendirir; seçim yoksa örnek metin ekleyip seçili bırakır. Başlık ve Liste seçilen bütün satırlara uygulanır; Bağlantı eklenince adres kısmı seçili gelir; Kod çok satırlı seçimi kod bloğuna çevirir.
Ekrandaki düğme ve alan adlarını metinde kalın yazın. İngilizce çeviri üretilirken kalın (ya da tırnak içindeki) etiketler konsolun kendi etiket sözlüğüyle eşlenir; böylece İngilizce belge de ekranda gerçekten yazan etiketi kullanır.
Alt paneller
Belge ilk kez kaydedilene kadar bu panellerin yerinde İngilizce çeviri ve sürüm geçmişi ilk kayıttan sonra burada görünür. notu durur.
- Güncellik: Son güncellik kararı, tarihi, gerekçesi ve değişiklik ayrıntıları. Hâlâ doğru — kodu bugüne al düğmesi buradadır; listeden farklı olarak karar Güncel olsa da görünür.
- İngilizce çeviri: Salt okunurdur; burada düzenlenmez, her kayıtta Türkçe metinden yeniden üretilir. Güncel rozeti çevirinin son Türkçe metinle uyumlu olduğunu, Eski — bir sonraki kayıtta yeniden çevrilecek rozeti Türkçe metnin çeviriden sonra değiştiğini gösterir. Çeviri hiç yoksa Henüz İngilizce çeviri yok yazar.
- Sürümler: Belgenin kayıt geçmişi (bkz. "Eski bir sürüme dönme"). Hiç sürüm yoksa Henüz sürüm yok, geçmiş okunamazsa Sürümler yüklenemedi yazar.
Sık karşılaşılan durumlar
- "Türkçe kaydedildi ancak İngilizce çeviri üretilemedi" uyarısı geldi. Türkçe belge kaydedilmiştir; yalnızca çeviri üretilemedi. Uyarının altında nedeni yazar. Belgeyi daha sonra yeniden kaydettiğinizde çeviri tekrar denenir; durumunu İngilizce çeviri panelinden izleyin.
- Kimlik alanının altında "Bu kimlikte bir belge zaten var" yazıyor. Yeni belgenin kimliği var olan bir belgeyle aynı. Kimliği değiştirin ya da var olan belgeyi Belgeler sekmesinde bulup onu düzenleyin.
- Belge yazdım ama ekranın yardım çekmecesinde görünmüyor. Belgenin durumu Taslak ya da Arşivde olabilir, ya da Bağlı ekranlar alanında o ekran yoktur. Durumu Yayında yapın, ekranı bağlayın ve kaydedin. Ekran kapsaması sekmesinde ekranın rozeti Yayında olmalıdır.
- "Yardım servisi yapılandırılmamış" uyarısı görünüyor. Belgeler şu an okunamıyor ve kaydedilemiyor; sekmeler görünmez, Yeni belge düğmesi de pasiftir. Bu bir yapılandırma durumudur, sistem yöneticinize bildirin.
- "Belge bulunamadı" yazıyor. Belge silinmiş ya da adresteki kimlik yanlış yazılmış olabilir. ← Belgelere dön ile listeye dönüp belgeyi arayın.