İyi bir stil için ipuçları

Bunlar iyi bir wiki sayfasının nasıl yazılacağına dair birkaç ipucu.



1. Sayfa yapıları


  • Sayfanıza anlamlı bir başlık içeren birinci seviye bir başlıkla başlayın.
  • Başlık seviyelerini doğru sırayla yerleştirin, ikinci seviyedeki bölümler ikinci seviye bir başlıkla başlamalıdır.
  • Paragraflar arasında boş bir satır bırakarak metninizi paragraflara ayırın. Ortalama bir paragraf 10-20 satırdan uzun olmamalıdır.
  • Metniniz birkaç (3-5) paragraftan daha uzunsa, ikinci ila beşinci seviye başlıklar ekleyerek bölümlere ayırmayı düşünün.
  • Metniniz 2-3 ekran sayfasından daha uzun olduğunda, ilk başlıktan sonra sayfanın içeriğinin kısa bir özetini koyun. Sayfanız önemli ölçüde uzadığında, birden fazla sayfaya bölmeyi düşünün.
  • Diğer wiki sayfalarına veya harici kaynaklara çok sayıda bağlantınız varsa, daha fazla referans içeren özel bir bölüm ekleyin (aşağıya bakın).
  • Bir ad alanındaki sayfaların çoğu ortak bir yapıyı paylaşıyorsa, herhangi bir yeni sayfanın bu iskelet yapısıyla başlayabilmesi için bir ad alanı şablonu ekleyin.
  • Aşırı karmaşık ad alanı yapılarından kaçınmaya çalışın. Kısa, hatırlanması kolay ad alanı adları kullanmaya çalışın.

2. Metin biçimlendirme


  • Kalın veya italik harfler kullanarak tek kelimeleri veya kısa metin pasajlarını vurgulayın. Bunlardan birini seçin ve seçiminize sadık kalın.
  • Ekran çıktısını ve düğmeler veya menü etiketleri gibi ekrandaki metinleri temsil etmek için bir stil seçin ve bunu tutarlı bir şekilde kullanın. Wiki'nize stil kurallarınızın açıklamasını içeren bir sayfa eklemek iyi bir fikir olabilir.
  • Birbirinden bağımsız ifadeler için sırasız listeler kullanın. Bir düşünce dizisi geliştiriyorsanız, sürekli bir cümle dizisi halinde yazın.
  • Dipnotları idareli ve yalnızca çok kısa ek açıklamalar için kullanın. Belirli bir konuda söylenecek daha çok şey varsa, bunu yeni bir wiki sayfasına koyun. Diğer (harici) bilgi kaynaklarına atıfta bulunmak istiyorsanız, bunun yerine bağlantıları kullanın.
  • Tablolar, yapılandırılmış verilerin okunabilirliğini büyük ölçüde artırabilir. Bir tablo eklerseniz, anlamlı hücre başlıklarına sahip olduğundan emin olun ve tablonun içeriğini açıkça belirten bir başlık sağlayın (örneğin, "Tablo 1.2: Gezegenler arasındaki ortalama uzaklıklar").
  • Büyük tabloların düzenlenmesi çok zor olma eğilimindedir. Bunun yerine verileri iç içe geçmiş bir listede göstermeyi düşünün.

3. Dil


  • Düzgün cümleler yazın ve gerektiğinde isimler için artikel kullanın.
  • Her cümleye büyük harfle başlayın ve cümleyi nokta ya da diğer uygun noktalama işaretleriyle bitirin.
  • Yan cümlelere çok fazla başvurmadan kısa, net cümleler yazmaya çalışın. Sayfanızı bitirdiğinizi düşündüğünüzde, tekrar okuyun ve aşırı karmaşık bir yapıya sahip olan herhangi bir cümleyi gözden geçirin.
  • Okuyucularınıza nasıl hitap edeceğinize karar verin. Wiki dokümantasyon yazmaya yönelik olduğundan, okuyucularınıza belirli şeyleri nasıl yapacakları konusunda sık sık talimat vermeniz gerekecektir. Emir kipi ("Bunu yap!"), biz/siz kipi ("Sonra biz/siz...'e tıklayın") veya ben kipi ("Sonra foo'yu bar'a... kullanarak ekliyorum") kullanabilirsiniz. Bu formları karıştırmayın.
  • Sayfanızı kaydetmeden önce dilbilgisi veya yazım hatalarına karşı kontrol edin. Metninizde çok sayıda hata varsa, ne kadar iyi düşünülmüş olurlarsa olsunlar ifadelerinizin güvenilirliği azalacaktır.
  • Kendi tarzınızı geliştirin. Kendinizi rahat olmadığınız bir tarzda yazmaya zorlamayın. Bu sadece kulağa doğal gelmeyecek ve okunması hoş olmayacaktır.

4. Referanslar


  • Daha fazla açıklama gerektiren bir terimle karşılaştığınızda, terim için yeni bir viki sayfası ekleyin ve ona bağlantı verin.
  • Sayfanızı bitirmeden önce tekrar kontrol edin ve sayfanızın ana terimlerine mevcut wiki sayfalarına bağlantılar ekleyin.
  • Belirli bir terimin her geçtiği yere bağlantı eklemeyin. Sayfadaki ilk/en belirgin geçişi bir bağlantı haline getirin ve belki referans bölümüne bir bağlantı ekleyin.
  • Resimlerin, verilerin ve alıntıların kaynaklarına bağlantılar sağlayın.
  • Sayfanızın sonuna bir "Ayrıca bakınız:" satırı eklemeyi düşünün. Sayfanızın konusuyla yakından ilgili olan viki sayfalarına bağlantılar verin.
  • Konunuz hakkında daha fazla bilgi içeren veya sayfanızı yazarken kullandığınız harici kaynaklara işaret etmek istiyorsanız, sonuna "Referanslar" veya "Daha fazla bilgi" adlı bir bölüm ekleyin ve bağlantıların veya diğer işaretçilerin (örneğin ISBN numaraları) bir listesini verin. Ana metinde daha önce yapmadıysanız, referansın amacını belirtin.
  • İnterwiki kısayolları oluşturmak, ortak kaynaklara bağlantı kurmaya yardımcı olabilir.

5. Görüntüler ve diğer medya


  • "Bir görüntü bin kelimeden daha fazlasını söyler." Hatta söylemek istediğinizden daha fazlasını ifade edebilir. İnsanlar görüntülerin gerçekliğini dilden daha az sorgulama eğilimindedir. Kısa bir metin açıklaması, doğru olmayan bir resimden daha iyidir.
  • Tablolarda olduğu gibi, görseller için de her zaman görselle ne göstermek istediğinizi belirten bir başlık ekleyin.
  • Resmi kendiniz oluşturmadıysanız, kaynağı (muhtemelen bir bağlantı ile) ve telif hakkını belirtin.
  • Açıkça izin verilmediği sürece harici sitelerden resimlere bağlantı vermeyin. Bu öncelikle bir telif hakkı meselesidir, ancak harici resimler için önbellekleme devre dışı bırakıldığında bant genişliği çalma meselesi de olabilir.
  • Resim bir ekran sayfasının yaklaşık üçte birinden daha büyükse, küçük resim eklemek için yeniden boyutlandırma talimatları içeren bir bağlantı kullanın.

Read comments (0 comments)