Көптеген компьютер пайдаланушылары жиі елемейтініне қарамастан, анықтама файлдары олармен байланысты бағдарламалық жасақтаманы пайдалану туралы негізгі ақпаратты береді. «Анықтама» түймесін басу арқылы пайдаланушы бағдарламаның мүмкіндіктеріне шолу жасай алады, ол қарайтын экранның сипаттамасын, берілген тапсырманы орындау үшін бағдарламаны пайдалану бойынша нұсқаулықтарды немесе бағдарлама туралы жиі қойылатын сұрақтардың тізімін оқи алады. бағдарлама және олардың жауаптары. Анықтама файлын жазу үшін бағдарламалық жасақтамамен жұмыс істеу қабілеті де, пайдаланушыларға түсінікті етіп түсіндіру мүмкіндігі де қажет.
Қадамдар
Қадам 1. Құжатталатын бағдарламалық жасақтаманың көшірмесін алыңыз
Мүмкіндігінше, сіз бағдарламаның барлық техникалық сипаттамаларының көшірмесін алуыңыз керек, бірақ олармен барлық бағдарламалық жасақтама әзірлеушілері жұмыс істемейді. Кейбір жағдайларда, бағдарламашы қысқа әзірлеуге немесе белгілі бір мүмкіндікті кодтай алмауына байланысты ерекшеліктерден ауытқиды.
Қадам 2. Анықтамалық авторлық құралды алыңыз
Мәтіндік форматтағы (.rtf) файлды қолдана отырып, анықтама файлын жасау мүмкін болса да, көптеген көмекші файл авторлары көмекші файлдарды жазу үшін бағдарламалық жасақтаманы қолданады, мысалы, RoboHelp, Help and Manual, Doc-To. -Көмек, MadCap Flare немесе HelpLogix. Авторлық көмекші құралдардың көпшілігіне мәтіндік редактор немесе Microsoft Word сияқты мәтінді өңдеу бағдарламасымен жұмыс кіреді және пайдаланушы интерфейсін қамтамасыз етеді, бұл анықтама авторы компьютердің кодын сахна артында жазған кезде оның қалай көрінетінін көруге мүмкіндік береді. анықтама файлының жұмыс істеуі үшін. Кейбір анықтамалық авторлық құралдар анықтама файлына қосылатын скриншоттарды жасауға арналған графикалық редакторларды да қамтиды.
Анықтамалық файлдардың бірнеше форматтары бар: Ең кең тарағаны Windows жүйесінде жұмыс істейтін қосымшаларда қолданылатын HTML анықтамасы. (Ескі WinHelp форматына бұдан былай қолдау көрсетілмейді.) Apple мен Unix -тің әрқайсысының JavaHelp көмегімен Sun Microsystems сияқты өзіндік форматтары бар. Бірнеше операциялық жүйемен жұмыс істеуге арналған бағдарламалық қосымшалар пайдаланушының веб-шолғышында жұмыс істейтін кросс-платформалық анықтамалық жүйені қолдана алады. Сіз пайдаланатын қандай көмек авторлық құралы анықтама файлдарын жасағыңыз келетін анықтама форматтарын қолдауы керек
Қадам 3. Анықтама жобасының файлын жасаңыз
Анықтаманы авторизациялау құралы сіз берген файл атауына және басқа ақпаратқа негізделген сізге көмек жобасы файлын жасайды. Жобаның негізгі файлында мазмұнды, индексті, бір немесе бірнеше кескін файлдарын және басқа файлдарды қамтитын басқа файлдар туралы ақпарат бар.
- Мазмұн файлы анықтамалық файлдағы мәтінді қамтиды, онда сіз құжаттайтын бағдарламалық жасақтама қалай жұмыс істейтінін түсіндіреді. Мәтін әдетте белгілі бір экранды, мүмкіндікті немесе процедураны қамтитын тақырыптарға бөлінеді.
- Индекс файлы - анықтама файлының тақырыптарының тізімі. Ол пайдаланушылар көруге болатын тақырыпты таңдауға болатын мазмұн кестесін, сондай -ақ анықтама файлындағы іздеуге болатын индексті құру үшін қолданылады.
- Кескін файлдары - бұл пайдаланушылардың анықтама файлының мәтіні нені білдіретінін түсіну қабілетін жақсарту үшін анықтама файлында көрсетілетін бағдарлама экрандарының графикалық файлдары немесе сол экрандардың бөліктері.
Қадам 4. Анықтама терезесінің өлшемін реттеңіз
Егер сіз анықтамалық файлды пайдаланушының веб -шолғышында пайда болу үшін жазбасаңыз, анықтама файлы өз терезесінде пайда болады. Анықтаманы авторизациялау құралы сізге терезенің көлденең және тік өлшемдерін реттеуге мүмкіндік береді, бұл соңғы пайдаланушыға анықтамалық файлды қосымшаға кедергі келтірмей оқуға мүмкіндік береді. Негізгі анықтама терезесі көбінесе үш панельді форматта болады, мазмұны кестесі сол жақта және оң жақта таңдалған тақырып болады.
Анықтама файлдарында негізгі терезеден басқа, белгілі бір мүмкіндікті егжей-тегжейлі сипаттайтын қосалқы терезелер және мүмкіндіктердің қысқаша сипаттамасын беретін қалқымалы терезелердің өлшемі автоматты түрде болуы мүмкін. Анықтама файлдары сонымен қатар бөлектелген мәтін немесе түйме басылғанда пайда болатын ендірілген мәтінді қамтуы мүмкін
Қадам 5. Анықтамалық тақырыптарды жазыңыз
Мұны істеу үшін сізге бағдарламаның экрандары мен мүмкіндіктерін құжаттау үшін тақырыптар жасау үшін ерекшеліктерді немесе бағдарламаның өзін қарау қажет. Әр тақырыпты құрған кезде, анықтаманы авторизациялау құралы оны анықтама файлының мазмұны мен индексіне қосады.
- Мазмұндар кестесін құра алсаңыз да, оны қалай ұйымдастыруға болатынын білуге болады. Сіз бағдарламаның экрандары, оның ерекшеліктері, оны қолдану тәсілдері немесе олардың кейбір комбинациясы бойынша мазмұн кестесін ұйымдастыра аласыз.
- Тақырыптарды жазған кезде, анықтамалық файлдағы пайдаланушылар тез қол жеткізгісі келетін басқа ақпаратты қарастырыңыз. Бұл ақпарат бар тақырыптарға қосылатын анықтама файлының мәтінінде секірулерді немесе гиперсілтемелерді жасауға болады.
Қадам 6. Қажет болса, скриншоттарды қосыңыз
Бағдарламаның көптеген мүмкіндіктері мәтін мен графиканың комбинациясымен жақсы түсіндіріледі. Сіз скриншоттарды көмекші құралмен бірге келетін қосымша арқылы немесе Microsoft Paint, Paint Shop Pro немесе SnagIt сияқты бөлек қосымшамен жасай аласыз.
- Мәтін мен скриншоттарды пайдаланушылар скриншотты және оның тірек мәтінін артық айналдырусыз көре алатындай тақырыпта бірге орналастырылуы керек. Көптеген жағдайларда сіз бүкіл экранның орнына бағдарлама экранының бір бөлігін көрсеткіңіз келеді немесе скриншотты түпнұсқадан кішірек етіп көрсеткіңіз келеді. Сіздің скриншот қосымшасы скриншоттың өлшемін бұлдыратпай немесе жоғалтпай өзгертуге қабілетті болуы керек.
- Егер сіз бағдарламаның сынақ нұсқасы мен соңғы нұсқасы арасындағы пайдаланушы интерфейсінің өзгеруін болжасаңыз, сізде жұмыс істейтін бағдарламаның соңғы нұсқасы болғанша скриншоттар жасауды тоқтату қажет болуы мүмкін.
Қадам 7. Егер қажет болса, карта файлын жасаңыз
Кейбір бағдарламаларда пайдаланушыға осы экранның қалай жұмыс істейтінін нақты сипаттайтын анықтамалық файлдағы тақырыпты шертуге және көрсетуге арналған «Анықтама» түймелері кіреді. Тақырыпты осылай көрсету контекстке сезімтал көмек деп аталады және анықтамалық файлдағы белгілі бір тақырыпқа «Анықтама» түймесін байланыстыру үшін бағдарламашыға карта файлын жасауды талап етеді. Анықтаманы авторизациялау құралы сіз үшін біреуін жасай алады немесе бағдарламашы оны кодтап, оны анықтама файлына қосу үшін бере алады.
Қадам 8. Анықтама файлын құрастырыңыз
Компиляция бағдарламаға қосылатын нақты анықтама файлын жасайды. Анықтамалық форматтардың көпшілігінде бұл анықтама файлын құрған кезде жасалған барлық компонент файлдарын қамтиды, бірақ кейбір жинақталмаған анықтама форматтары бағдарламаға жеке анықтама тақырыптарының файлдарын қосуды талап етеді.
Қадам 9. Анықтама файлын тексеріңіз
Анықтама файлын құрастырғаннан кейін, сіз барлық гиперсілтемелердің тақырыптарға сәйкес келетініне және барлық графиканың дұрыс көрсетілуіне көз жеткізу үшін оны тексеруіңіз керек. Анықтамалық файл сонымен қатар мазмұнның пайдаланушылар үшін дәл және сәйкес форматта болуын тексеру үшін тексерілуі керек. Сіз анықтама файлын өзіңіз қарап шығуды және қосымшаны тексеретін адамдарға оны тексеруді қалайсыз.
Көмек файлдарының үлкен жобаларында компиляция және тестілеу үздіксіз процестер болып табылады. Сіз соңғы нұсқаны жасамас бұрын анықтама файлын жинап, жұмысыңызды бірнеше рет тексергіңіз келеді
Қадам 10. Бағдарламаға қосу үшін әзірлеушіге анықтама файлын беріңіз
Жобаның сипатына және анықтама файлының форматына байланысты, контекстке сезімтал тақырыптар болса, әзірлеушіге бірнеше файлдарды, оның ішінде карта файлын ұсынуға тура келуі мүмкін.
