Çoğu bilgisayar kullanıcısı tarafından sıklıkla göz ardı edilse de, yardım dosyaları, ilişkili oldukları yazılım uygulamasının nasıl kullanılacağı hakkında önemli bilgiler sağlar. Bir kullanıcı, "Yardım"ı tıklatarak, programın özelliklerine genel bir bakış, baktığı ekranın açıklamasını, belirli bir görevi gerçekleştirmek için programın nasıl kullanılacağına ilişkin yönergeleri veya programla ilgili sık sorulan soruların listesini okuyabilir. programı ve cevapları. Bir yardım dosyası yazmak, hem yazılım uygulamalarıyla çalışma becerisini hem de kullanıcıların anlayabileceği şekilde şeyleri açıklama becerisini gerektirir.
adımlar
Adım 1. Belgeleyeceğiniz yazılımın bir kopyasını alın
Mümkünse, tüm yazılım geliştiriciler onlarla çalışmasa da, programın yazılı özelliklerinin bir kopyasını da almalısınız. Bazı durumlarda, programcı kısa geliştirme süresine veya belirli bir özelliği kodlayamamasına bağlı olarak özelliklerden sapacaktır.
Adım 2. Bir yardım yazma aracı edinin
Zengin metin biçimli (.rtf) bir dosya kullanarak elle bir yardım dosyası oluşturmak mümkün olsa da, çoğu yardım dosyası yazarı, yardım dosyalarını yazmak için RoboHelp, Help and Manual, Doc-To gibi bir yazılım uygulaması kullanır. -Yardım, MadCap Flare veya HelpLogix. Çoğu yardım yazma aracı, bir metin düzenleyici içerir veya Microsoft Word gibi bir kelime işlemci programıyla çalışır ve yardım yazarının, sahne arkasında bilgisayar kodu yazarken yardım dosyasının nasıl görüneceğini görmesine olanak tanıyan bir kullanıcı arabirimi sağlar. yardım dosyasının çalışmasını sağlamak için. Bazı yardım yazma araçları, yardım dosyasına dahil edilecek ekran görüntüleri oluşturmaya yönelik grafik düzenleyicileri de içerir.
Birkaç yardım dosyası biçimi vardır: En yaygın olanı, Windows'ta çalışan uygulamalar tarafından kullanılan HTML Yardımıdır. (Daha eski bir biçim olan WinHelp artık desteklenmemektedir.) Apple ve Unix'in her birinin kendi biçimleri vardır ve JavaHelp ile Sun Microsystems'in yaptığı gibi. Birkaç işletim sistemi altında çalışacak şekilde tasarlanmış yazılım uygulamaları, kullanıcının Web tarayıcısında çalışan platformlar arası bir yardım sistemi kullanabilir. Hangi yardım yazma aracını kullanırsanız kullanın, içinde yardım dosyaları oluşturacağınız yardım biçimini/biçimlerini desteklemelidir
Adım 3. Yardım projesi dosyasını oluşturun
Yardım yazma aracınız, sağladığınız dosya adına ve diğer bilgilere dayalı olarak sizin için bir yardım projesi dosyası oluşturacaktır. Ana proje dosyası, bir içerik dosyası, bir dizin dosyası, bir veya daha fazla görüntü dosyası ve diğer dosyaları içeren diğer dosyalar hakkında bilgi içerir.
- İçindekiler dosyası, yardım dosyasındaki, belgelediğiniz yazılım uygulamasının nasıl çalıştığını açıklayan metni içerir. Metin genellikle belirli bir ekranı, özelliği veya prosedürü kapsayan konulara ayrılır.
- Dizin dosyası, yardım dosyasının konularının bir listesidir. Kullanıcıların görüntülemek üzere bir konu seçmek için kullanabilecekleri bir içindekiler tablosu ve yardım dosyası içinde aranabilir bir dizin oluşturmak için kullanılır.
- Görüntü dosyaları, kullanıcıların yardım dosyası metninin ne anlama geldiğini anlama yeteneğini geliştirmek için program ekranlarının grafik dosyaları veya yardım dosyası içinde görüntülenen bu ekranların bölümleridir.
Adım 4. Yardım penceresinin boyutunu ayarlayın
Yardım dosyasını kullanıcının Web tarayıcısında görünecek şekilde yazmadığınız sürece, yardım dosyası kendi penceresinde görünecektir. Yardım yazma aracınız, pencerenin yatay ve dikey boyutlarını, son kullanıcının yardım dosyasını uygulamanın önüne geçmeden okumasını sağlayacak bir boyuta ayarlamanıza olanak tanır. Ana yardım penceresi genellikle soldaki içindekiler tablosu ve sağdaki seçilen konu ile üç bölmeli bir biçimdedir.
Yardım dosyaları, ana pencereye ek olarak, belirli bir özelliği ayrıntılı olarak açıklayan ikincil pencerelere ve özelliklerin kısa açıklamalarını veren, otomatik olarak boyutlandırılan açılır pencereleri de içerebilir. Yardım dosyaları, yalnızca vurgulanan metin veya bir düğme tıklandığında görünen gömülü metin de içerebilir
Adım 5. Yardım konularını yazın
Bunu yapmak için, programın ekranlarını ve özelliklerini belgeleyecek konuları oluşturmak üzere özellikleri veya programın kendisini gözden geçirmeniz gerekir. Her bir konuyu oluşturduğunuzda, yardım yazma aracınız onu yardım dosyasının içindekiler tablosuna ve dizinine ekleyecektir.
- Gittikçe içindekiler tablosunu oluşturabilirsiniz, ancak bunun nasıl organize edileceğine dair bir planınızın olması yardımcı olur. İçindekileri programın ekranları, özellikleri, kullanım yolları veya bunların bazı kombinasyonları etrafında düzenleyebilirsiniz.
- Konuları yazarken, yardım dosyasındaki kullanıcıların hızlı bir şekilde erişmek isteyecekleri diğer bilgileri göz önünde bulundurun. Bu bilgilere sahip konulara bağlanan yardım dosyası metninde atlamalar veya köprüler oluşturabilirsiniz.
Adım 6. Gerekirse ekran görüntülerini ekleyin
Birçok program özelliği en iyi şekilde metin ve grafik kombinasyonu ile açıklanır. Yardım yazma aracınızla birlikte gelen uygulamayla veya Microsoft Paint, Paint Shop Pro veya SnagIt gibi ayrı bir uygulamayla ekran görüntüleri oluşturabilirsiniz.
- Metin ve ekran görüntüleri, kullanıcıların ekran görüntüsünü ve destekleyici metnini gereksiz yere kaydırmadan görebileceği şekilde bir konu içinde birlikte düzenlenmelidir. Çoğu durumda, tüm ekran yerine program ekranının bir bölümünü göstermek veya ekran görüntüsünü orijinalinden daha küçük bir boyutta göstermek isteyeceksiniz. Ekran görüntüsü uygulamanız, bulanıklık veya ayrıntı kaybı olmadan ekran görüntüsünü yeniden boyutlandırabilmelidir.
- Programın test ve son sürümleri arasında kullanıcı arayüzünde değişiklik olmasını bekliyorsanız, üzerinde çalışacağınız programın son sürümüne sahip olana kadar ekran görüntüleri oluşturmaya devam etmek isteyebilirsiniz.
Adım 7. Gerekirse bir harita dosyası oluşturun
Bazı programlar, kullanıcının bu ekranın nasıl çalıştığını özel olarak açıklayan yardım dosyasındaki konuyu tıklayıp görüntülemesi için "Yardım" düğmeleri içerir. Bir konuyu bu şekilde görüntülemek, içeriğe duyarlı yardım olarak adlandırılır ve programcının "Yardım" düğmesini yardım dosyanızdaki belirli konuya bağlaması için bir harita dosyası oluşturmayı gerektirir. Yardım yazma aracınız sizin için bir tane oluşturabilir veya programcı bunu kodlayabilir ve yardım dosyasına eklemeniz için size verebilir.
Adım 8. Yardım dosyasını derleyin
Derleme, programa dahil edilecek gerçek yardım dosyasını oluşturur. Çoğu yardım formatı için bu, yardım dosyasını oluşturduğunuzda oluşturulan tüm bileşen dosyalarını içerecektir, ancak bazı derlenmemiş yardım formatları ayrıca programa dahil edilecek bireysel yardım konusu dosyalarını da gerektirebilir.
Adım 9. Yardım dosyasını test edin
Yardım dosyasını derledikten sonra, tüm köprülerin olması gereken konulara bağlandığından ve tüm grafiklerin doğru görüntülendiğinden emin olmak için onu test etmeniz gerekir. İçeriğin doğru, kullanıcılar için uygun ve tutarlı bir biçimde olduğundan emin olmak için yardım dosyasının da test edilmesi gerekir. Yardım dosyasını kendiniz incelemek ve uygulamayı test eden kişilerin de incelemesini sağlamak isteyeceksiniz.
Daha büyük yardım dosyası projelerinde derleme ve test etme devam eden süreçlerdir. Son sürümü oluşturmadan önce yardım dosyasını derlemek ve çalışmanızı birkaç kez kontrol etmek isteyeceksiniz
Adım 10. Yardım dosyasını programa dahil etmesi için geliştiriciye verin
Projenin doğasına ve yardım dosyası biçimine bağlı olarak, içeriğe duyarlı konular varsa bir harita dosyası da dahil olmak üzere geliştiriciye birkaç dosya sağlamanız gerekebilir.
