Hata İletisi Yönergeleri

Hata iletisi, kullanıcının veya sistemin bir görevi tamamlamasını engelleyen bir sorunu açıklamak için görüntülenen metindir. Sorun veri bozulmasına veya kaybolmasına neden olabilir. Diğer ileti türleri arasında onaylar, uyarılar ve bildirimler bulunur. Bu konudaki yönergeler, yerelleştirilmesi kolay ve müşteriler için yararlı olan net hata iletileri yazmanıza yardımcı olmak için tasarlanmıştır.

Kötü yazılmış hata iletileri, kullanıcılar için bir hayal kırıklığı kaynağı olabilir ve teknik destek maliyetlerini artırabilir. İyi yazılmış bir hata iletisi kullanıcıya aşağıdaki bilgileri sağlar:

• Ne oldu ve neden?
• Kullanıcı için son sonuç nedir?
• Kullanıcı yeniden olmasını önlemek için ne yapabilir?

Geliştirici arabellek boyutlarını doğru işlediği sürece metnin uzunluğu sorun oluşturmaz. Kullanıcının sorunu çözmek için gerekli tüm bilgilere sahip olması önemlidir. İletinin birden çok hedef kitlesi varsa, yöneticiler, son kullanıcılar ve geliştiriciler için ayrı metinler sağlamanız gerekebilir.

En İyi Yöntemler

Hata iletilerinizi geliştirmenin yolları şunlardır:

• Hata koşullarından kaçının. Bir kullanıcı belirli bir eylemi gerçekleştirdiğinde bir hatanın oluşacağını tahmin edebilirseniz, kullanıcının hataya neden olabilmesi için kodunuzu yeniden yazın.
• Hatanın bilinen her nedeni için ayrı bir hata iletisi yazın. Hata oluştuğunda hatanın nedenini belirleyemiyorsanız, hatanın olası her nedenini açıklamak için tek ve genel bir ileti kullanmayın.
• Sorunu net bir şekilde belirtin ve kullanıcıya yardımcı olacaksa soruna neyin neden olduğunu açıklayın. Mümkün olduğunda, sistem ileti tablosu kaynaklarından gelen genel iletileri soruna özgü ayrıntılı bir iletiyle değiştirin.
• Kullanıcıya soruna bir çözüm sağlayın. Çözümün birden fazla adımı varsa, görevin ayrıntılı olarak açıklandığı bir yardım konusuna bakın.
• İletinin başlık çubuğunda yalnızca ürün, bileşen veya sihirbaz adını görüntüleyin. Bu, kullanıcının sorunun nerede olduğunu belirlemesine yardımcı olur. Sorunu başlık çubuğuna özetlemeyin veya "error" sözcüğünü eklemeyin.
• Teknik jargon kullanmayın, hedef kitlenizin anladığı terminolojiyi kullanın. Argo veya kısaltma kullanmayın.
• Tamam, İptal, Evet, Hayır ve Yeniden Dene gibi uygun komut düğmelerini kullanın. Bu düğmelerin bileşimlerini kullanabilirsiniz. Evet ve Hayır düğmeleri her zaman birlikte kullanılmalıdır ve her zaman bir sorudan önce olmalıdır.
  • bir işlemi durdurmak ve ileti kutusunu kapatmak için İptal düğmesini kullanın.
  • İleti kutusunu kapatmak için Kapat düğmesini kullanın.
  • Hatanın nedeni hakkında daha fazla bilgi sağlamak için Ayrıntılar düğmesini kullanın.
  • Sorunun çözümü hakkında daha fazla bilgi sağlamak için Yardım düğmesini kullanın.
  • İletiye bir kullanıcı eylemi eklenmişse, ileti kutusunu kapatmak için Tamam düğmesini kullanın.
  • Evet ve hiçbir düğmesi birlikte kullanılmalı ve her zaman bir sorudan önce olmalıdır.
• Hata kritik bir hataysa, olay günlüğüne yazın.

StilLe İlgili Dikkat Edilmesi Gerekenler

• Eksiksiz ama basit cümleler kullanın.
• Soruna neden olan koşulları veya hala var olan bir durumu açıklamak için mevcut zamanları kullanın. Geçmişte gerçekleşen ayrı bir olayı açıklamak için geçmiş zaman kullanabilirsiniz.
• Mümkün olduğunda etkin sesi kullanın. Pasif sesi kullanarak hata durumunu açıklayabilirsiniz.
• Büyük harfli metin ve ünlem işareti kullanmaktan kaçının.
• Sorun bir kullanıcı hatasının sonucu olsa bile kullanıcının kendini hatalı hissetmesini sağlamayın.
• Antropomorfize etmeyin. Programların veya donanımın düşünebileceğini veya hissedebileceğini ima etmeyin.
• Birlikte kullanılan sözcükleri veya tümcecikleri kullanmayın. Belirli kültürlerde rahatsız edici olabilecek terimleri kullanmayın.
• Anlamı netleştirmek için bir edat veya alt bildirim eklemeden birkaç isim birleştirmeyin. Örneğin, "Site Sunucusu LDAP Hizmeti dizin sunucusu" "Site Sunucusunun LDAP Hizmeti için dizin sunucusu" olarak değiştirilmelidir.
• Tümcenin anlamını netleştirmek için terimden önce tanımlayıcılar ekleyin. Örneğin, "Algıla seçeneği Hayır olarak ayarlandığında InfID belirtin", "Algıla seçeneği Hayır olarak ayarlandığında InfID parametresini belirtin" olarak değiştirilmelidir.
• "Kötü" sözcüğünü kullanmaktan kaçının. Kullanıcıya neyin yanlış olduğunu söylemek için daha açıklayıcı terimler kullanın. Örneğin, "Hatalı boyut" gibi iletilerden kaçının. Bunun yerine, kullanıcıya boyut belirtirken hangi ölçütlerin kullanılacağını söyleyin.
• "Lütfen" sözcüğünü kullanmayın. Gerekli bir eylemin isteğe bağlı olduğu anlamına gelebilir.
• hem dizinde hem de ileti dizesinin başına merkezi anlamla ilgili sözcükleri yerleştirin.