Көпчүлүк компьютер колдонуучулары тарабынан көп көңүл бурулбаганы менен, жардам файлдары алар менен байланышкан программалык камсыздоону кантип колдонуу керектиги жөнүндө негизги маалыматтарды берет. "Жардам" баскычын чыкылдатуу менен, колдонуучу программанын өзгөчөлүктөрү, ал карап жаткан экрандын сүрөттөмөсү, берилген тапшырманы аткаруу үчүн программаны колдонуу боюнча көрсөтмөлөрдү же программалар жөнүндө көп берилүүчү суроолордун тизмелерин окуй алат. программа жана алардын жооптору. Жардам файлын жазуу үчүн программалык камсыздоо менен иштөө жөндөмү да, колдонуучуларга түшүнүктүү нерселерди түшүндүрө билүү да талап кылынат.
Кадамдар
Кадам 1. Сиз документтештире турган программанын көчүрмөсүн алыңыз
Мүмкүн болсо, программалык камсыздоону иштеп чыгуучулардын баары эле алар менен иштешпесе да, программанын жазылган спецификациясынын көчүрмөсүн алышыңыз керек. Кээ бир учурларда, программист кыска иштөө убактысына же белгилүү бир өзгөчөлүктү коддоого жөндөмсүздүгүнө негизделип, четтеп кетет.
Кадам 2. Жардам автордук куралын алыңыз
Жардам файлын кол менен түзүүгө мүмкүн болсо да, бай текст форматындагы (.rtf) файлды колдонуп, көпчүлүк жардам файл авторлору жардам файлдарын жазуу үчүн программалык камсыздоону колдонушат, мисалы RoboHelp, Help and Manual, Doc-To -Жардам, MadCap Flare же HelpLogix. Көпчүлүк жардам берүүчү инструменттерге текст редактору же Microsoft Word сыяктуу текст иштетүүчү программа менен иштөө кирет жана компьютер автору көшөгөнүн артында жазуу учурунда жардам файлынын кандай болорун көрүүгө жардам берүүчү колдонуучу интерфейсин камсыз кылат. жардам файлын иштетүү үчүн. Жардам берүүчү кээ бир инструменттерге жардам файлына кошуу үчүн скриншот түзүү үчүн графикалык редакторлор да кирет.
Жардам файлдарынын бир нече форматтары бар: Эң кеңири таралган HTML Жардамы, ал Windowsто иштеген тиркемелер тарабынан колдонулат. (Эски формат, WinHelp, мындан ары колдоого алынбайт.) Apple менен Unixтин ар бири JavaHelp менен Sun Microsystems сыяктуу эле өзүнүн форматтарына ээ. Бир нече операциялык системанын астында иштөө үчүн иштелип чыккан программалык колдонмолор колдонуучунун веб-браузеринде иштеген кросс-платформалык жардам системасын колдонушу мүмкүн. Жардам авторлоштуруунун кайсы куралы болбосун, жардам файлдарын түзө турган жардам форматтарын колдоого тийиш
Кадам 3. Жардам долбоорунун файлын түзүңүз
Жардам авторлоштуруу куралы сиз берген файлдын атына жана башка маалыматка негизделген сиз үчүн жардам долбоорунун файлын түзөт. Негизги долбоор файлы башка файлдар жөнүндө маалыматты камтыйт, анын ичинде мазмун файлы, индекс файлы, бир же бир нече сүрөт файлдары жана башка файлдар бар.
- Мазмун файлы жардам документинде сиз документтештирип жаткан программалык камсыздоонун кантип иштээрин түшүндүргөн текстти камтыйт. Текст көбүнчө белгилүү бир экранды, өзгөчөлүктү же процедураны камтыган темаларга бөлүнөт.
- Индекс файлы жардам файлынын темаларынын тизмеси. Бул колдонуучулар көрүү үчүн теманы, ошондой эле жардам файлынын ичинде изделүүчү индексти тандоо үчүн колдоно турган мазмунун таблицасын түзүү үчүн колдонулат.
- Сүрөт файлдары - бул колдонуучулардын жардам файлынын тексти эмнени билдирерин түшүнүү жөндөмүн жогорулатуу үчүн жардам файлында көрсөтүлгөн программанын экрандарынын графикалык файлдары же ошол экрандардын бөлүктөрү.
Кадам 4. Жардам терезесинин өлчөмүн тууралаңыз
Жардам файлын колдонуучунун Веб -браузеринде жазуу үчүн жазбасаңыз, жардам файлы өзүнүн терезесинде пайда болот. Жардам авторлоштуруучу куралыңуз терезенин горизонталдык жана вертикалдык өлчөмдөрүн тууралоого мүмкүндүк берет, ал акыркы колдонуучуга жардам файлын колдонмонун өзүнө тоскоол болбостон окууга мүмкүнчүлүк берет. Негизги жардам терезеси көбүнчө үч панелдүү форматта, сол жактагы мазмунун жана оң жагында тандалган теманы камтыйт.
Жардам файлдарында негизги терезеден тышкары, белгилүү бир өзгөчөлүктү майда-чүйдөсүнө чейин сүрөттөгөн экинчи терезелер жана өзгөчөлүктөрдүн кыска сүрөттөмөсүн берген калкып чыкма терезелердин автоматтык түрдө өлчөмү болушу мүмкүн. Жардам файлдары, ошондой эле, бөлүп көрсөтүлгөн текст же баскыч басылганда гана пайда болгон камтылган текстти камтышы мүмкүн
Step 5. Жардам темаларын жазыңыз
Бул үчүн, программанын экрандарын жана функцияларын документтештирүү үчүн темаларды түзүү үчүн өзгөчөлүктөрдү же программанын өзүн карап чыгууңуз керек болот. Сиз ар бир теманы түзүп жатканда, сиздин жардам берүүчү куралыңыз аны жардам файлынын мазмунун жана индексине кошот.
- Сиз бара жатканда мазмунун түзө аласыз, бирок аны кантип уюштуруу боюнча кандайдыр бир план түзүүгө жардам берет. Сиз программанын экрандары, анын өзгөчөлүктөрү, аны колдонуу жолдору же алардын кээ бир айкалыштарынын тегерегиндеги мазмунду түзө аласыз.
- Темаларды жазып жатканда, жардам файлындагы колдонуучулар тез кирүүнү каалаган башка маалыматты эске алыңыз. Сиз бул маалыматка ээ болгон темаларга туташкан жардам файлынын текстинде секирүүлөрдү же гиперссылкаларды түзө аласыз.
Кадам 6. Керек болсо скриншотторду кошуңуз
Программанын көптөгөн функциялары текст менен графиканын айкалышы менен эң жакшы түшүндүрүлөт. Сиз скриншотторду жардам берүүчү автордук куралыңыз менен келген тиркеме менен же Microsoft Paint, Paint Shop Pro же SnagIt сыяктуу өзүнчө тиркеме менен түзө аласыз.
- Текст менен скриншоттор колдонуучулар скриншотту жана аны колдогон текстти ашыкча жылдырбастан көрө ала турган темада чогуу жайгаштырылышы керек. Көпчүлүк учурларда, сиз экрандын ордуна программанын бир бөлүгүн көрсөтүүнү же скриншотту түпнускасынан кичине өлчөмдө көрсөтүүнү каалайсыз. Скриншотуңуздун тиркемеси скриншоттун өлчөмүн бүдөмүктөтпөстөн же жоготпой өзгөртүүгө жөндөмдүү болушу керек.
- Эгерде сиз программанын тест менен акыркы версияларынын ортосундагы колдонуучу интерфейсинде өзгөрүүлөрдү күтсөңүз, иштөө үчүн программанын акыркы версиясы болмоюнча скриншотторду түзүүнү токтотуп коюңуз.
Кадам 7. Карта файлын түзүңүз, эгер керек болсо
Кээ бир программалар колдонуучунун темасын чыкылдатып, экрандын иштөө ыкмасын атайын сүрөттөгөн жардам файлында көрсөтүү үчүн "Жардам" баскычтарын камтыйт. Теманы бул жол менен көрсөтүү контекстке сезимтал жардам деп аталат жана жардамчы файлыңыздагы белгилүү бир темага "Жардам" баскычын байланыштыруу үчүн программист үчүн карта файлын түзүүнү талап кылат. Жардам авторлоштуруу куралы сиз үчүн бирөөнү түзө алат, же программист аны кодго салып, жардам файлына кошуу үчүн сизге бере алат.
Кадам 8. Жардам файлын түзүңүз
Компиляция программага кошула турган чыныгы жардам файлын түзөт. Көпчүлүк жардам форматтары үчүн, бул жардам файлын түзгөндө түзүлгөн бардык компонент файлдарын камтыйт, бирок кээ бир компиляцияланбаган жардам форматтары программага жеке жардам темасы файлдарын кошууну талап кылат.
Кадам 9. Жардам файлын текшериңиз
Жардам файлын түзгөндөн кийин, аны бардык гипершилтемелер тийиштүү болгон темаларга туташып, бардык графиктер туура көрсөтүлүшү үчүн текшериш керек. Жардам файлы ошондой эле мазмун так жана колдонуучулар үчүн ылайыктуу экенин жана ырааттуу форматта болушун текшерүү үчүн керек. Сиз жардам файлын өзүңүз карап чыгып, колдонмону текшерип жаткан адамдар аны карап чыгууну каалайсыз.
Чоңураак жардам берүү долбоорлорунда, компиляция жана тестирлөө процесстери болуп саналат. Сиз акыркы файлды түзүүдөн мурун жардам файлын түзүп, ишиңизди бир нече жолу текшерип көргүңүз келет
Кадам 10. Программага кошуу үчүн иштеп чыгуучуга жардам файлын бериңиз
Долбоордун мүнөзүнө жана файлдын форматына жараша, контекстке тиешелүү темалар болсо, иштеп чыгуучуга бир нече файлдарды, анын ичинде карта файлын берүүгө туура келиши мүмкүн.
