Harika Teknik Yazım: Belge Aramalarını İyileştirin

GENEL BAKIŞ

Kullanıcı Belgelerinde (kılavuzlar, vb.) Yapılan aramalar genellikle Okuyucu bir kavram için yazarın kullandığından farklı kelimeler kullandığından başarısız olur. Okuyucunun kelimeleri belgede görünmediği için, belge arama mekanizması bunları bulamaz ve hayal kırıklığına neden olur. Bu makale, Kullanıcıların davranışını veya arama yazılımını değiştirmek zorunda kalmadan aramaları iyileştirmek için Kullanıcı dostu bir tekniği açıklar.

OKUYUCULARINIZIN KELİMELERİ

İnsanlar konuşurken, yazarken veya ararken bildikleri kelimeleri kullanırlar. Okuyucuyu yazarın terminolojisini kullanmaya zorlamak aptallıktır; Okuyucu basitçe “uygun” terimi bilmiyor olabilir. Bilinmeyen sözcükler kullanmaya zorlanan Okuyucu, Kullanıcı Belgesini kibirli veya en azından kullanımı zor bulacaktır.

Örneğin, bir kelime işlemci programı için bir Kullanım Kılavuzu, karakter yazı tipleri ve boyutunun yanı sıra sayfa düzeniyle uğraşırken muhtemelen “biçimlendirme” kelimesini kullanacaktır. Ancak, Reader’ınızın bu konulara atıfta bulunmak için “görünüm” kelimesini kullandığını varsayalım. Okuyucu “görünüm” ararsa, doğru sonucu sağlamak için arama mekanizmasını nasıl elde edebiliriz?

TEKNİK CEVAP: BİR THESAURUS ARAMASI

Teknik çözüm, belge arama yazılımını “tam terim” aramasından “Eş Anlamlılar Sözlüğü Aramasına” dönüştürmek olacaktır. Bir Eş Anlamlılar Sözlüğü Aramasında, Kullanıcı bildiği bir sözcük girer ve arama belgedeki eşanlamlıları veya eşanlamlıları döndürür. Bu nedenle, düzgün bir şekilde kurulmuş bir Eş Anlamlılar Sözlüğü Araması, Okuyucu “görünüm” için arama yaparsa “biçimlendirme” referanslarını döndürmelidir.

Ne yazık ki, Eş Anlamlılar Sözlüğü Araması nadiren bulunur ve bir tane oluşturmak için mevcut arama programında değişiklik yapılması gerekir. Düşük teknolojili bir çözüm en iyi cevap olabilir.

CEVAP: SENONİMLER

Bu teknik için, aramanın bulmasını istediğiniz sayfalara yazarın kelimesinin eş anlamlılarını (“biçimlendirme”) koymanız gerekir. Bu tür eşanlamlılar “görünüm”, “tasarım” ve “düzen” içerebilir. Bu basit ve etkili bir çözümdür.

Çoğu kelime işlemcinin ve birçok kütüphanenin bileşeni olan eşanlamlılar sözlüğünü kullanarak uygun eşanlamlıları bulabilirsiniz. Okuyucularınızın kullanması muhtemel olan eş anlamlıları seçin. “Kullanılması muhtemel”, Reader’ınızın analizine dayanır.

Bu bizi bir sonraki soruya götürür: Eş anlamlıları sayfaya nasıl koyarsınız?

GİZLİ METİN KULLANMAYIN

Teknik açıdan bilgili yazarlar “eş anlamlılar için neden gizli metin kullanılmıyor?” Bunun yararı, gizli metnin sayfayı “karıştırmamasıdır”.

Dolayısıyla, Kullanıcı Belgesinin “biçimlendirmenin” sunulduğu bölümlerinde, yazar “görünüm” sözcüğünü gizli metin olarak koyarsa (arama yardımcı programının bu gizli bilgiyi bulacağını varsayarak), o zaman aşağıdakiler gerçekleşir:

1. Reader “görünüm” arar.

2. Arama, Reader’ı belgenin “biçimlendirme” bölümüne götürür.

3. Okuyucu “Buraya nasıl geldim?” Diye merak ediyor. Onun aradığı kelime (“görünüm”) gizli olduğu için sayfada görünmüyor.

Bir Kullanıcı Belgesinin amacının Okuyucunun sorularını yanıtlamak olduğu düşünüldüğünde, başka bir soru sormasına neden olan herhangi bir şey yapmak (“Buraya nasıl geldim?”) Ters etki yaratır. Gizli eş anlamlılar en iyi cevap değildir.

ŞIK ÇÖZÜM: “BUNU … OLARAK BİLİYORSUNUZ”

Eş anlamlıları gizlemek iyi bir fikir değildir. Okuyucunun neler olduğunu bilmesini sağlamak daha iyidir. En kolay yol, konunun göründüğü sayfaya bir satır metin eklemektir. Bu metin satırı, “Bunu şu şekilde biliyor olabilirsiniz …” cümlesiyle başlar.

“Biçimlendirme” örneğimize devam edersek, açıklayıcı eşanlamlı ifademiz “Bunu görünüm, düzen veya tasarım olarak biliyor olabilirsiniz” olur. “Görünüm” araması, Reader’ı “Biçimlendirme” bölümüne getirir.

Okuyucu, “Bunu görünüm, düzen veya tasarım olarak biliyor olabilirsiniz” ifadesini gördükten sonra, aramanın bu konumu neden bulduğunu bilir. Arama Okuyucuyu tatmin etti ve duruma belirsizlik katmadı.

ALT ÇİZGİ

Tüm iyi Kullanıcı Belgelerinin amacı, Okuyucunun ürünle ilgili deneyimini iyileştirmektir. Yazar, “teknik” terimlerin eş anlamlılarını kullanarak, gerekli konular Okuyucunun kelimeleri kullanılarak bulunacağından, Okuyucunun belge aramalarını daha etkili hale getirir.

Eş anlamlıları gizlemeyerek, Okuyucunun belgedeki o yere neden geldiği konusunda kafası karışmaz. Sonuç, belge ve ürünle daha iyi bir deneyimdir.