Bir çox kompüter istifadəçisi tərəfindən tez -tez göz ardı edilməsinə baxmayaraq, kömək faylları, əlaqəli olduqları proqram tətbiqinin necə istifadə ediləcəyi ilə bağlı əsas məlumatlar verir. "Kömək" düyməsini basaraq, istifadəçi proqramın xüsusiyyətlərinə ümumi baxışı, baxdığı ekranın təsvirini, verilən tapşırığı yerinə yetirmək üçün proqramdan istifadə qaydaları və ya proqramla bağlı tez -tez verilən sualların siyahısını oxuya bilər. Proqram və onların cavabları. Bir yardım faylı yazmaq üçün həm proqram tətbiqləri ilə işləmək bacarığı, həm də istifadəçilərin anlayacağı şəkildə hər şeyi izah etmə qabiliyyəti tələb olunur.
Addımlar
Addım 1. Sənədləşdirəcəyiniz proqramın bir nüsxəsini alın
Mümkünsə, bütün proqram təminatçıları onlarla işləməsə də, proqram üçün yazılı spesifikasiyaların bir nüsxəsini də almalısınız. Bəzi hallarda, proqramçı qısa inkişaf müddətinə və ya müəyyən bir xüsusiyyəti kodlaşdıra bilməməsinə əsaslanaraq xüsusiyyətlərdən yayınacaq.
Addım 2. Bir kömək yazma vasitəsi alın
Zəngin mətn formatlı (.rtf) faylını istifadə edərək əllə bir yardım faylı yaratmaq mümkün olsa da, əksər köməkçi fayl müəllifləri kömək fayllarını yazmaq üçün RoboHelp, Help and Manual, Doc-To kimi bir proqram tətbiqindən istifadə edirlər. -Yardım, MadCap Flare və ya HelpLogix. Çox kömək yazma vasitələrinə mətn redaktoru və ya Microsoft Word kimi bir söz işləmə proqramı ilə iş daxildir və kömək müəllifinə pərdə arxasında kompüter kodu yazarkən kömək sənədinin necə yazılacağını görməsini təmin edən bir istifadəçi interfeysi təmin edilir. kömək faylını işə salmaq üçün. Bəzi kömək yazma vasitələri, kömək sənədinə daxil etmək üçün ekran görüntüləri yaratmaq üçün qrafik redaktorlarını da ehtiva edir.
Bir çox yardım faylı formatı var: Ən çox yayılmışı Windows -da işləyən tətbiqlər tərəfindən istifadə olunan HTML Yardımıdır. (Köhnə WinHelp formatı artıq dəstəklənmir.) Apple və Unix -in JavaHelp ilə Sun Microsystems kimi öz formatları var. Bir neçə əməliyyat sistemi altında işləmək üçün hazırlanmış proqram tətbiqləri, istifadəçinin Veb brauzerində işləyən platformalararası yardım sistemindən istifadə edə bilər. İstifadə etdiyiniz hansı kömək yazma vasitəsi kömək faylları yaratacağınız yardım formatlarını dəstəkləməlidir
Addım 3. Yardım layihəsi faylını yaradın
Yardım yazma vasitəniz, təqdim etdiyiniz fayl adına və digər məlumatlara əsaslanaraq sizin üçün bir yardım layihəsi faylı yaradacaq. Əsas layihə faylı, məzmun faylı, indeks faylı, bir və ya daha çox şəkil faylı və digər faylları ehtiva edən digər fayllar haqqında məlumatları ehtiva edir.
- Məzmun faylı sənəd sənədləşdirdiyiniz proqram tətbiqinin necə işlədiyini izah edən yardım sənədindəki mətni ehtiva edir. Mətn ümumiyyətlə müəyyən bir ekranı, xüsusiyyəti və ya proseduru əhatə edən mövzulara bölünür.
- İndeks faylı, yardım faylının mövzularının siyahısıdır. İstifadəçilərin baxmaq üçün bir mövzu seçmək üçün istifadə edə biləcəyi bir məzmun cədvəli yaratmaq üçün istifadə olunur, həmçinin kömək sənədindəki axtarış indeksi.
- Şəkil faylları, istifadəçilərin yardım faylı mətninin nəyə istinad etdiyini başa düşmə qabiliyyətini artırmaq üçün kömək sənədində göstərilən proqram ekranlarının qrafik faylları və ya bu ekranların bir hissəsidir.
Addım 4. Yardım pəncərəsinin ölçüsünü tənzimləyin
İstifadəçinin veb brauzerində görünmək üçün kömək faylını yazmadığınız halda, kömək faylı öz pəncərəsində görünəcək. Kömək yazma vasitəniz, pəncərənin üfüqi və şaquli ölçülərini, son istifadəçiyə kömək faylını tətbiqin özünə mane olmadan oxumasına imkan verən bir ölçüyə uyğunlaşdırmağa imkan verəcək. Əsas yardım pəncərəsi tez-tez üç panelli, məzmun cədvəli solda və seçilmiş mövzu sağda olur.
Yardım sənədlərində, əsas pəncərəyə əlavə olaraq, müəyyən bir xüsusiyyəti ətraflı təsvir edən ikincil pəncərələr və xüsusiyyətlərin qısa təsvirini verən açılan pəncərələrin ölçüsü avtomatik olaraq ola bilər. Yardım faylları, yalnız vurğulanan mətn və ya bir düymə tıklandığında görünən gömülü mətni də daxil edə bilər
Addım 5. Yardım mövzularını yazın
Bunu etmək üçün, proqramın ekranlarını və xüsusiyyətlərini sənədləşdirmək üçün mövzular yaratmaq üçün spesifikasiyaları və ya proqramın özünü nəzərdən keçirməlisiniz. Hər bir mövzunu yaratdığınız zaman, kömək yazma vasitəniz onu kömək faylının məzmun cədvəlinə və indeksinə əlavə edəcək.
- Gedərkən məzmun cədvəlini qura bilsəniz də, bunu necə təşkil etmək üçün bir plan hazırlamağa kömək edir. Proqramın ekranları, xüsusiyyətləri, istifadə üsulları və ya bəzi birləşmələri ətrafında məzmun cədvəli təşkil edə bilərsiniz.
- Mövzular yazarkən istifadəçilərin tez bir zamanda əldə etmək istədikləri yardım sənədindəki digər məlumatları nəzərdən keçirin. Bu məlumatı olan mövzuları birləşdirən yardım faylı mətnində atlamalar və ya hiperlinklər yarada bilərsiniz.
Addım 6. Gerekirse ekran görüntüləri əlavə edin
Bir çox proqram xüsusiyyətləri mətn və qrafik birləşməsi ilə ən yaxşı şəkildə izah olunur. Kömək yazma vasitənizlə gələn proqramla və ya Microsoft Paint, Paint Shop Pro və ya SnagIt kimi ayrı bir tətbiqlə ekran görüntüləri yarada bilərsiniz.
- Mətn və ekran görüntüləri, istifadəçilərin ekran görüntüsünü və onu dəstəkləyən mətni yersiz sürüşdürmədən görə biləcəyi bir mövzuda birlikdə yerləşdirilməlidir. Əksər hallarda, bütün ekranın yerinə bir proqram ekranının bir hissəsini göstərmək və ya ekran görüntüsünü orijinaldan daha kiçik ölçüdə göstərmək istəyəcəksiniz. Ekran görüntüsü tətbiqiniz, ekran görüntüsünü ləkələmədən və ya detal itirmədən ölçüsünü dəyişə bilməlidir.
- Proqramın test və son versiyaları arasında istifadəçi interfeysində dəyişikliklər olacağını düşünürsünüzsə, işləmək üçün proqramın son versiyasına sahib olana qədər ekran görüntüləri yaratmağı dayandırmaq istəyə bilərsiniz.
Addım 7. Lazım gələrsə, bir xəritə faylı yaradın
Bəzi proqramlar, istifadəçinin ekranın necə işlədiyini xüsusi olaraq izah edən yardım sənədindəki mövzunu tıklayaraq göstərməsi üçün "Yardım" düymələrini ehtiva edir. Mövzunun bu şəkildə göstərilməsi kontekstə həssas kömək adlanır və proqramçının "Yardım" düyməsini yardım sənədinizdəki xüsusi mövzu ilə əlaqələndirməsi üçün bir xəritə faylı yaratmağı tələb edir. Kömək yazma vasitəniz sizin üçün birini yarada bilər və ya proqramçı onu kodlaşdıra və yardım sənədinə daxil etmək üçün sizə verə bilər.
Addım 8. Yardım faylını tərtib edin
Kompilyasiya proqrama daxil olacaq həqiqi kömək faylını yaradır. Əksər kömək formatları üçün, bu kömək faylını yaratdığınız zaman yaradılan bütün komponent fayllarını özündə birləşdirəcək, baxmayaraq ki, bəzi tərtib edilməmiş yardım formatları da fərdi yardım mövzusu fayllarının proqrama daxil edilməsini tələb edir.
Addım 9. Yardım faylını sınayın
Yardım faylını tərtib etdikdən sonra, bütün hiperlinklərin ehtimal etdikləri mövzulara qoşulduğundan və bütün qrafiklərin düzgün göstərildiyini yoxlamaq üçün test etməlisiniz. Məzmunun istifadəçilər üçün uyğun və uyğun bir formatda olmasını təmin etmək üçün yardım faylının da sınanması lazımdır. Kömək faylını özünüz nəzərdən keçirmək və tətbiqi sınayan insanların da bunu nəzərdən keçirməsini istəyəcəksiniz.
Daha böyük yardım faylı layihələrində, tərtib və sınaq davam edən proseslərdir. Son versiyanı yaratmadan əvvəl kömək faylını tərtib etmək və işinizi bir neçə dəfə yoxlamaq istəyəcəksiniz
Addım 10. Proqrama daxil etmək üçün kömək faylını geliştiriciyə verin
Layihənin təbiətindən və kömək faylının formatından asılı olaraq, kontekstə həssas mövzular varsa, geliştiriciyə bir xəritə faylı da daxil olmaqla bir neçə fayl verməlisiniz.
