Yordam faylini qanday yaratish kerak: 10 qadam (rasmlar bilan)

Mundarija:

Yordam faylini qanday yaratish kerak: 10 qadam (rasmlar bilan)
Yordam faylini qanday yaratish kerak: 10 qadam (rasmlar bilan)

Video: Yordam faylini qanday yaratish kerak: 10 qadam (rasmlar bilan)

Video: Yordam faylini qanday yaratish kerak: 10 qadam (rasmlar bilan)
Video: O'chib ketgan fayllarni tiklash / Восстановление файлов / How to recover deleted files / R-studio 2024, Qadam tashlamoq
Anonim

Ko'pgina kompyuter foydalanuvchilari tomonidan tez -tez e'tiborga olinmasa -da, yordam fayllari ular bilan bog'liq bo'lgan dasturiy ta'minotdan qanday foydalanish haqida asosiy ma'lumotlarni beradi. "Yordam" tugmachasini bosish orqali foydalanuvchi dasturning xususiyatlari, u ko'rib turgan ekranning tavsifi, berilgan vazifani bajarish uchun dasturdan foydalanish bo'yicha ko'rsatmalarni yoki dastur haqida tez -tez beriladigan savollar ro'yxatini o'qishi mumkin. dastur va ularning javoblari. Yordam faylini yozish uchun dasturiy ilovalar bilan ishlash qobiliyati ham, foydalanuvchilar tushunadigan tarzda tushuntirish qobiliyati ham kerak.

Qadamlar

Yordam faylini yarating 1 -qadam
Yordam faylini yarating 1 -qadam

Qadam 1. Siz hujjatlashtirmoqchi bo'lgan dasturiy ta'minot nusxasini oling

Iloji bo'lsa, dasturning yozma spetsifikatsiyalarining nusxasini ham olishingiz kerak, garchi hamma dastur ishlab chiqaruvchilari ular bilan ishlamasa. Ba'zi hollarda, dasturchi qisqa vaqtga yoki ma'lum bir funktsiyani kodlay olmasligiga asoslanib, texnik xususiyatlardan chetga chiqadi.

Yordam faylini yarating 2 -qadam
Yordam faylini yarating 2 -qadam

Qadam 2. Yordam muallifi vositasini oling

Qo'l bilan boy fayl formatidagi (.rtf) fayl yordamida qo'lda yordam faylini yaratish mumkin bo'lsa-da, ko'pchilik yordamchi mualliflar yordam fayllarini yozish uchun RoboHelp, Help and Manual, Doc-To kabi dasturiy ta'minotdan foydalanadilar. -Yordam, MadCap Flare yoki HelpLogix. Mualliflik vositalarining aksariyati matn muharriri yoki Microsoft Word kabi so'zlarni qayta ishlash dasturi bilan ishlashni o'z ichiga oladi va yordamchi muallif kompyuter kodini yozish paytida yordam fayli qanday ko'rinishini ko'rishga imkon beradigan foydalanuvchi interfeysini ta'minlaydi. yordam faylini ishga tushirish uchun. Ba'zi yordam mualliflik vositalarida, shuningdek, yordam fayliga ekran tasvirlarini yaratish uchun grafik muharrirlari ham kiradi.

Yordam fayllarining bir qancha formatlari mavjud: Eng keng tarqalgani HTML yordami bo'lib, u Windowsda ishlaydigan ilovalar tomonidan ishlatiladi. (Eski format, WinHelp, endi qo'llab -quvvatlanmaydi.) Apple va Unix -ning har biri o'z formatiga ega, shuningdek, Sun Microsystems kabi JavaHelp. Bir nechta operatsion tizimlar ostida ishlashga mo'ljallangan dasturiy ilovalar foydalanuvchining veb-brauzerida ishlaydigan platformalararo yordam tizimidan foydalanishi mumkin. Qaysi yordam mualliflik vositasi yordam fayllarini yaratmoqchi bo'lsangiz, yordam formatini qo'llab -quvvatlashi kerak

Yordam faylini yarating 3 -qadam
Yordam faylini yarating 3 -qadam

Qadam 3. Yordam loyihasi faylini yarating

Sizning yordam muallifligingiz vositasi siz ko'rsatgan fayl nomi va boshqa ma'lumotlarga asoslanib sizga yordam loyihasi faylini yaratadi. Loyihaning asosiy faylida tarkib fayllari, indeksli fayllar, bir yoki bir nechta tasvirli fayllar va boshqa fayllar mavjud bo'lgan boshqa fayllar haqidagi ma'lumotlar mavjud.

  • Tarkib fayli yordam faylidagi matnni o'z ichiga oladi, u siz hujjatlashtirayotgan dasturiy ta'minot qanday ishlashini tushuntiradi. Matn odatda ma'lum bir ekran, xususiyat yoki protsedurani qamrab oladigan mavzularga bo'linadi.
  • Indeks fayli - yordam fayli mavzularining ro'yxati. Bu foydalanuvchilar ko'rishi mumkin bo'lgan mavzuni tanlashi mumkin bo'lgan tarkib jadvalini, shuningdek yordam fayli ichida qidiriladigan indeksni yaratish uchun ishlatiladi.
  • Tasvir fayllari - bu foydalanuvchilarning yordam fayli matni nimani nazarda tutayotganini tushunish qobiliyatini oshirish uchun yordam fayli ichida ko'rsatiladigan dastur ekranlarining grafik fayllari yoki ularning bir qismi.
Yordam faylini yarating 4 -qadam
Yordam faylini yarating 4 -qadam

Qadam 4. Yordam oynasining hajmini rostlang

Agar siz yordamchi faylni foydalanuvchining veb -brauzerida paydo bo'lishi uchun yozmasangiz, yordam fayli o'z oynasida paydo bo'ladi. Sizning yordam mualliflik vositasi sizga oynaning gorizontal va vertikal o'lchamlarini moslashtirishga imkon beradi, bu esa oxirgi foydalanuvchiga yordam faylini dasturga to'sqinlik qilmasdan o'qishiga imkon beradi. Asosiy yordam oynasi ko'pincha uch panelli bo'lib, uning tarkibi chapda va tanlangan mavzu o'ng tomonda bo'ladi.

Yordam fayllarida, shuningdek, asosiy oynaga qo'shimcha ravishda, ma'lum bir xususiyatni batafsil tavsiflovchi ikkilamchi oynalar va xususiyatlarning qisqacha tavsifini beradigan qalqib chiquvchi oynalarning o'lchami avtomatik ravishda bo'lishi mumkin. Yordam fayllari faqat ajratilgan matn yoki tugma bosilganda paydo bo'ladigan ko'milgan matnni ham o'z ichiga olishi mumkin

Yordam faylini yarating 5 -qadam
Yordam faylini yarating 5 -qadam

Qadam 5. Yordam mavzularini yozing

Buni amalga oshirish uchun, dasturning ekranlari va xususiyatlarini hujjatlashtirish uchun mavzularni yaratish uchun texnik xususiyatlarni yoki dasturning o'zini ko'rib chiqish kerak bo'ladi. Har bir mavzuni yaratganingizda, yordam muallifi vositasi uni yordam fayli tarkibiga va indeksiga qo'shib qo'yadi.

  • Siz ketayotganda tarkib jadvalini tuzishingiz mumkin bo'lsa -da, uni qanday tashkil qilish bo'yicha ba'zi rejalar tuzishga yordam beradi. Siz dasturlar ekranini, uning xususiyatlarini, ulardan foydalanish usullarini yoki ularning kombinatsiyasini tashkil qilishingiz mumkin.
  • Mavzular yozilayotganda, yordam faylidagi foydalanuvchilar tez kirishni xohlaydigan boshqa ma'lumotlarni ko'rib chiqing. Bu ma'lumotga ega bo'lgan mavzularga bog'langan yordam fayli matnida siz o'tish yoki giperhavola yaratishingiz mumkin.
Yordam faylini yarating 6 -qadam
Yordam faylini yarating 6 -qadam

Qadam 6. Agar kerak bo'lsa, ekran tasvirlarini qo'shing

Ko'pgina dastur funktsiyalari matn va grafik kombinatsiyasi bilan yaxshi tushuntiriladi. Siz skrinshotlarni yordamchi mualliflik vositasi bilan kelgan ilova yordamida yoki Microsoft Paint, Paint Shop Pro yoki SnagIt kabi alohida dastur yordamida yaratishingiz mumkin.

  • Matn va skrinshotlar bir mavzuda joylashtirilishi kerak, shunda foydalanuvchilar skrinshotni va uni qo'llab -quvvatlovchi matnni keraksiz aylanmasdan ko'ra oladilar. Ko'p hollarda, siz butun ekran o'rniga dastur ekranining bir qismini ko'rsatishni yoki ekran tasvirini asl nusxadan kichikroq hajmda ko'rsatishni xohlaysiz. Sizning skrinshot ilovangiz ekran tasvirini xiralashtirmasdan va tafsilotlarni yo'qotmasdan o'zgartirishi mumkin.
  • Agar siz dasturning sinov va oxirgi versiyalari o'rtasida foydalanuvchi interfeysining o'zgarishini kutayotgan bo'lsangiz, dasturning oxirgi versiyasi bilan ishlash uchun ekran tasvirini yaratishni to'xtatib qo'yishingiz mumkin.
Yordam faylini yarating 7 -qadam
Yordam faylini yarating 7 -qadam

Qadam 7. Agar kerak bo'lsa, xarita faylini yarating

Ba'zi dasturlar foydalanuvchining yordam faylidagi mavzuni bosishi va ko'rsatishi uchun "Yordam" tugmachalarini o'z ichiga oladi. Mavzuni bu tarzda ko'rsatish kontekstga sezgir yordam deb ataladi va dasturchining yordam faylidagi "mavzu" tugmachasini bog'lash uchun xarita faylini yaratishni talab qiladi. Sizning yordam muallifligingiz vositasi siz uchun moslamani yaratishi mumkin yoki dasturchi uni yordam fayliga qo'shish uchun kodlashi va berishi mumkin.

Yordam faylini yarating 8 -qadam
Yordam faylini yarating 8 -qadam

Qadam 8. Yordam faylini kompilyatsiya qiling

Kompilyatsiya dasturga qo'shiladigan haqiqiy yordam faylini yaratadi. Ko'p yordam formatlari uchun, bu yordam faylini yaratganingizda yaratilgan barcha komponentli fayllarni o'z ichiga oladi, lekin ba'zi bir kompilyatsiya qilinmagan yordam formatlari, shuningdek, alohida yordam mavzusi fayllarini dasturga kiritishni talab qiladi.

Yordam faylini yarating 9 -qadam
Yordam faylini yarating 9 -qadam

Qadam 9. Yordam faylini sinab ko'ring

Yordam faylini kompilyatsiya qilgandan so'ng, siz barcha giperhavolalar kerakli mavzularga ulanganligini va barcha grafikalar to'g'ri ko'rsatilishini tekshirish uchun uni sinab ko'rishingiz kerak. Yordam fayli, shuningdek, kontent foydalanuvchilar uchun to'g'ri va mos formatga mos kelishini tekshirish uchun tekshirilishi kerak. Siz yordam faylini o'zingiz ko'rib chiqishni va arizani tekshirayotgan odamlarni ham ko'rib chiqishni xohlaysiz.

Kattaroq yordam fayllari loyihalarida kompilyatsiya qilish va sinovdan o'tkazish davom etayotgan jarayonlardir. Oxirgi versiyani yaratmasdan oldin yordam faylini kompilyatsiya qilishni va ishingizni bir necha marta tekshirishni xohlaysiz

Yordam faylini yarating 10 -qadam
Yordam faylini yarating 10 -qadam

10 -qadam. Dasturga qo'shish uchun yordam faylini ishlab chiquvchiga bering

Loyihaning tabiati va yordam faylining formatiga qarab, siz ishlab chiqaruvchiga bir nechta fayllarni, shu jumladan kontekstga sezgir mavzular bo'lsa, xarita faylini taqdim etishingiz kerak bo'lishi mumkin.

Tavsiya: