ПАЙДАЛАНУШЫ ҮШІН ҚҰЖАТТАМА ЖАСАУ.
БАҒДАРЛАМАЛЫҚ ӨНІМДЕРДІҢ АНЫҚТАМАЛЫҚ ЖҮЙЕСІН ҚҰРУ
11.1. «ПАЙДАЛАНУШЫНЫҢ НҰСҚАУЛЫҒЫ»
Пайдаланушыларға арналған құжаттарды ресімдеу, өз кезегінде, пайдаланушы, әдетте, бағдарламалық қамтамасыз етуді дамыту саласында кәсіби емес екеніне байланысты өз ерекшеліктеріне ие. «Пайдаланушы нұсқаулығын» әзірлеу кезінде,
«Бағдарламалық нұсқаулықтың бірыңғай жүйесі» ГОСТ 19.504-79 және «Оператордың нұсқаулығы» ГОСТ 19.505-79 бірыңғай бағдарламалық құжаттама жүйесінің жұмыс құжаттары негіз бола алады. «Пайдаланушы нұсқаулығы», бәлкім, келесі бөлімдерді қамтиды:
«Бағдарламаның мақсаты»;
«Бағдарламаны орындау шарттары»;
«Бағдарламаны орындау»;
«Пайдаланушыға хабарламалар».
Бағдарламаның ерекшеліктеріне қарай бөлек бөлімдерді біріктіруге немесе жаңа енгізуге болады.
«Бағдарламаны тағайындау» бөлімінде сіз бағдарламаның мақсаты туралы ақпаратты, оның функцияларының қысқаша сипаттамасын, енгізілген әдістерді және ықтимал қосымшаларды көрсетуіңіз керек.
«Бағдарламаны орындау шарттары» бағдарламаны орындау үшін қажетті (ең төменгі және (немесе) максималды аппараттық және бағдарламалық құрамы және т.б.) болуы тиіс.
«Бағдарламаны іске қосу» бөлімінде бағдарламаны жүктеуді, орындауды және аяқтауды, функциялардың сипаттамасын және пайдаланушы интерфейсін қамтамасыз ететін пайдаланушы әрекеттерінің дәйектілігін көрсету керек. Мысал ретінде, біз пайдаланушы нұсқаулығының кішкене фрагменті береміз.
«Пайдаланушыға арналған хабарламалар» бөлімінде
бағдарламаны орындау барысында берілген хабарламалар, олардың мазмұнын сипаттайтын және тиісті пайдаланушы әрекеттерін сипаттайтын хабарлар берілуі керек (бағдарламаның сәтсіздігі, бағдарламаны қайта іске қосу және т.б.).
Бөлімдердің мазмұны түсіндірме мысалдармен, кестелермен, диаграммалармен, графиктермен суреттелуі
мүмкін. Пайдаланушы нұсқаулығындағы қосымшаларда нұсқаулықтың бөлімдеріне орналастыруға болмайтын түрлі материалдар енгізілген.
Пайдаланушы құжаттамасын жазу бойынша ұсыныстар:
Пайдаланушылардың мүдделерін ескере отырып, нұсқаулық пайдаланушы талап ететін барлық нұсқауларды қамтуы тиіс;
нақты анықтап, қысқа сөйлемдерді қолданыңыз;
Кейбір терминдерді пайдалану қажет болса, техникалық жарнамадан және тар мамандандырылған терминологиядан аулақ болыңыз;
дәл және ұтымды, ұзақ және күрделі бағыттаушылардың әдетте ешкім оқымауы мүмкін, мысалы, ұзақ уақыт бойы сипаттаудан гөрі, пішінді бейнелеу жақсы.
Нақты және ұтымды, ұзын және күрделі нұсқаулықтарды әдетте
нысанын
ешкім оқымайды, мысалы, ұзындықты суреттеуден гөрі,
пішінін жақсарту жақсы.
Пайдаланушыны бағыттау үшін әзірленген материалдың негізінде бағдарламалық жасақтама өнімінің анықтамалық жүйесі құрылады немесе жай ғана көмек файлы. Бағдарламаны пайдаланушыны бағдарламамен жұмыс істеу және осы бағдарламалық жасақтама өнімінің қажеттілігі туралы толық және толық ақпаратпен қамтамасыз ету үшін әзірленген.
Эталондық жүйе келесі талаптарға сай болуы керек:
бағдарламаның толық сипаттамасын беруге;
графикалық материалдарды;
бағдарламаның кез келген түрінен қоңырау шалу үшін қол жетімді болуы;
контекстік сипаттама және ыңғайлы ақпарат іздеу жүйесі
бар
Мүмкіндігінше аз мөлшерде болыңыз.
АЖС «КӨТЕРМЕ САУДА ҚОЙМАСЫ»ҮШІН
«ПАЙДАЛАНУШЫ НҰСҚАУЛЫҒЫ» ҚҰЖАТЫНЫҢ ҮЛГІЛЕРІН ӘЗІРЛЕУ ҮЛГІСІ
Мысал ретінде, «Бағдарламаны іске қосу» бөлімінен
«Тауарларға тапсырыс беру» құжатымен жұмыс істеу тәртібін қарастырыңыз.
«Тауар орамы» құжаты сатып алушының тауарлық- материалдық құндылықтарды сатып алу ниеті туралы алдын-ала келісімді ресімдеуге арналған. Осы құжаттың орындалуы міндетті емес, оның негізгі мақсаты баспа түрін және оның негізінде жүк жөнелтімінің үзінді көшірмесін жасау болып табылады. Құжаттың экрандық нысаны тақырыптан және кесте бөлігінен тұрады (5.1 суретті қараңыз). Тақырып: «Клиент» - «Клиенттер» каталогының элементі;
«Шарт» - тапсырыс жасалатын шарт;
«Төлем түрі» - қолма-қол ақша немесе банк аударымы. Құжаттың кесте бөлігін толтыру құжаттың жаңа жолын әдеттегі енгізу арқылы жүзеге асырылады. Бұл «Тауарлар» каталогын ашады, онда сіз құжаттың элементтерінің ерікті санын таңдай және енгізе аласыз (таңдалған өнімдегі тінтуірдің сол жақ батырмасын екі рет басу немесе Enter пернесін басу). Барлық таңдалған тауарлар құжаттың кестесінде жазылған.
Егер қажетті «Баға» «Тауарлар» каталогында толтырылған болса, онда реквизистердің құны кесте бөліміне көшіріледі. Бұл сома автоматты түрде есептеледі. Құжатты толтыру нысаны қосымша басқару элементі - «Басып шығару» түймесіне ие. Бұл батырма басылғанда басып шығарылған тапсырыс формасы жасалады, оны принтерге шығаруға болады. Тапсырыс құжаты бухгалтерлік жазбаларды құрмайды. Экран нысанын толтырғаннан кейін OK түймешігін басыңыз.
АНЫҚТАМАЛЫҚ ЖҮЙЕНІ ДАМЫТУ
Анықтама жүйесі - Windows жүйесінің ажырамас бөлігі болып табылатын Winhelp бағдарламасы hlp-файлында көмек туралы ақпаратты көрсетеді. Көмек жүйесін құру процесі (hlp-файл) келесі екі қадамның реті ретінде ұсынылуы мүмкін:
анықтамалық ақпаратты дайындау (анықтамалық ақпараттың құжаттық файлын құру);
анықтамалық файлды анықтама файлына түрлендіру. Анықтамалық құжаттардың файлдары белгілі бір құрылымның rtf файлы болып табылады. Біз осы файлдардың тақырыбына (тақырып файлдары) қоңырау шалдық. Анықтамалық файлдардан (hlp) тақырыптық файлдардан алу үшін олар Көмекші семинар бағдарламасы (hwc.exe) арқылы өңделуі (жинақталуы) керек. Түпнұсқалық мәтіндер мен суреттерден басқа, тақырыптық файлдар Winhelp әртүрлі мүмкіндіктерін іске асыру үшін өздерінің тақырыптарымен мазмұн кестесін байланыстыратын сілтемелер арқылы сілтемелер жасау үшін қажетті ақпаратты қамтитын арнайы түзетулерді қамтуы мүмкін.Әдетте, көмек бірнеше тақырыпты қамтиды және осы тақырыптарға баруға болатын мазмұндар кестесі бар. Ең қарапайым нұсқасы: тақырып біреуі және мазмұны жоқ. Бұл жағдайда сізге не қажет екенін жазыңыз және оны .rtf кеңейтімі бар файлға сақтаңыз. Бірнеше тақырып жасау үшін, процесс біршама
күрделене түседі.
Әрбір тақырып жаңа бетке қатты көшу арқылы аяқталады. Мұны істеу үшін, тақырып аяқталғаннан кейін, мәзірде (MS Word)
«Кірістіру» ішіндегі «Break / Start a new page» тармағын таңдау керек.
Мазмұнның кестесінен көмекке дейін тақырыпты алу үшін, оның идентификаторын көрсетуіңіз керек. Мұны орындау үшін, мәтінді курсорлардан басталатын (тақырыптың басталуы немесе басқа орын) басталатын мәтінді орналастыру керек, арнайы жазбаны, атап айтқанда соңғы ескертуді енгізіңіз. Ескертудің таңбасы «#» белгісін таңдайды (11.1-сурет). Тақырып мәтіні - бұл түсіндірме мәтіні. Мысалы, «Қолдау» тақырыбын жасаңыз, оны басқа тақырыптардан бөліңіз және оны қолдау үшін орнатыңыз. Ол үшін тақырыптың тақырыбының жанындағы енгізу таспасын орналастырыңыз да, мәзірден «Кірістіру / Ескерту ...» дегенді таңдаңыз. Тілқатысу терезесіндегі «Соңы» сілтемесін таңдап, нөмірлеу «басқа», терезеде «#» (тырнақшасыз) жазу үшін терезеде. OK түймешігін басамыз, сілтеме қосылады және тасымалдау автоматты түрде сілтеме мәтініне аударылады. Қолдау жазамыз. Аяқталды. Барлық анықтамалық тақырыптар үшін бірдей қайталаңыз. Файлды сақтаңыз.
11.1. Сурет
Анықтамалық семинар бағдарламасын іске қосыңыз (файл Hcw.exe). Файлды / жаңа / анықтама мәзірінің мәзірін қолданып жаңа жоба жасаңыз. Панельдің оң жағында бірқатар файлдар бар, олардан файлдар таңдалады. Тілқатысу терезесінде тақырыптық файлды қосып, осы терезені жабыңыз. Жобаны сақтаңыз - бұл кеңейтім hpj (Help Project) бар файл болады.
Бірінші іске қосылғаннан кейін, Help Workshop hpj файлдарына, сондай-ақ көмек файлдарына (cnt) сілтеме жасайды, осылайша оларды екі рет басу арқылы ашуға болады. Анықтамалық файлды жасау үшін Сақтау және Құрастыру түймешігін басуыңызға болады. Жаңа терезе жинақтың нәтижесі туралы хабармен ашылады. Бәрін тәртіпке келтірейік делік, біз осы терезені жабамыз. Енді біздің жобамыз (. Hpj) орналасқан каталогта анықтама файлы пайда болуы керек. Алайда, егер сіз оны екі рет бассаңыз, бірінші тақырыпты ғана көре аламыз; Барлық тақырыптарды көру және олардың арасында шарлау үшін, мазмұн файлының кестесін қосу керек.
Анықтама файлы қарапайым мәтін пішіміне ие, бірақ оны көмекші семинарда жасау ыңғайлы. Бұл әрекетті орындау үшін, Help File File (Файл) / New (Жаңа) / Help Contents (Анықтама мазмұны) мәзірінің Help мәзірін таңдаңыз. Терезенің жоғарғы бөлігінде негізгі анықтама файлының атауын (әдетте бірнеше файл болуы мүмкін) және анықтама кестесінің атауын енгізу керек. Сонымен қатар, Өңдеу түймесін басқан кезде ашылатын диалогтық терезеде де болады.
Енді нақты мазмұн кестесін жасаңыз. Ол келесі екі түрдегі элементтерден тұрады: Көмек тақырыптары, олар бірнеше
тақырыпты қамтиды және көмек кітапшасының мазмұнын кестесінде және тақырыптардың өзі ұсынылады - анықтама белгісінің мазмұнын кестеде көрсетілген мәтіндер мен суреттер оған сұрақ белгісімен (сіз кез келген анықтаманың мазмұны кестесінде қараңыз).
Сондай-ақ, мазмұндар кестесінде макростарды кірістіріп, файлдарды (қоса) қосуға болады. Панельдің оң жағында мазмұн кестесінің элементтерін қосу және басқару үшін түймелер жиынтығы бар (төменге қосу - төменде қосу, жоғарыдан қосу - жоғарыдан қосу, Оңға жылжыту - Оңға жылжыту, Солға жылжыту - Солға жылжыту, Өңдеу, Жою). Олардың көмегімен біз мазмұн кестесінің қажетті құрылымын құрдық.
Тілқатысу терезесінде бөлімді қосқанда, оның атауын ғана көрсету керек; Тақырыпты қосқанда, атау, ID (соңғы кезі енгізілген кезде rtf файлында көрсетілген біз), анықтама файлының атауы және терезенің аты көрсетіледі. Егер тақырып негізгі файл ретінде көрсетілген анықтамалық файлда болса, анықтама файлының атауы көрсетілмеуі керек.Терезенің атын да көрсету мүмкін емес - тақырып әдепкі терезеде ашылады. TOC файлын (ол .cnt кеңейтімі) анықтамалық файлмен бірдей каталогта сақтау керек, ол жақсырақ анықтама файлы сияқты.
Енді қайтадан жоба файлын .hpj ашып, Параметрлер түймешігін басу қажет, Файлдар қойындысындағы ашық диалог терезесінде біздің мазмұн файлын көрсетіңіз. Тілқатысу терезесін жабыңыз, Сақтау және құрастыру түймешігін қайта басыңыз. Енді көмек файлының белгішесін екі рет бассаңыз, барлық тақырыптарға қол жеткізуге болатын мазмұнның кестесін аша аласыз.
Әдетте, көмек тақырыптары басқа бөлімдерге сілтемелерді қамтиды. ұғымдарды (сөз) анықтамалық жүйесінде, басқа Анықтама бөлімінде үшін шапшаң әкеледі, ол таңдау, негізгі мәтін анықтамалық түсті және негізгі сәттері бастап айырмашылығын атап өтті. мәтінді анықтамалық сөз-буын дайындау барысында, келесі Анықтама бөлімінде көшуді қамтамасыз ету болып табылады, ол таңдау, ол өтпелі жасалуы тиіс ID анықтамалық бөлімін, қоюға жоқ кеңістікте бар қос сызықпен, және бірден осы сөздің артында атап өткен жөн. Кірістірілген идентификатор жасырын мәтін ретінде ресімделуі керек.
Мәселен, суретке сурет салу керек. Оны MS Word бағдарламасына әдеттегі жолмен rtf құжатына қосу арқылы жасауға болады. Бір сурет бірнеше жерде пайдаланылса, сурет бір көшірмеде сақталатын етіп суретке кірістіруге арналған арнайы таңбаларды қолдануға болады.
Көмек алу үшін Delphi ортасында жазылған бағдарламада қол жетімді болу үшін бағдарламаны .hlp файлына бағыттау қажет. Анықтамалық файлды орналастырудың ең оңай жолы - оны орындалатын файл сияқты бір қалтада орналастыру.
Қолданбаның анықтамалық файлын анықтаңыз: Delphi-дегі жобаны (қосымшаларды) ашыңыз және Project / Options / Application (Бағдарлама / Параметрлер / Қолданба) мәзірін таңдап, Анықтама файлы өрісінде анықтама файлының атауын енгізіңіз.Сонымен қатар файлдың атын жолсыз көрсетуіңіз керек. WinHelp анықтамалық файлды табуға тырысқан кезде, көрсетілген каталогтардың бірі бағдарламаның орындалатын файлы орналасқан жері болып табылады. Басқа әдіс: келесі бағдарламаны негізгі бағдарлама пішінінің OnCreate оқиға өңдегішіне кірістіріңіз:
Application.HelpFile:=ExtractFilePath(Appli cation.ExeName)+ + «MyHelp.hlp»;
Мұнда MyHelp.hlp — анықтама файлының атауы.
Бағдарламадағы мәзірден мазмұн кестесін келтіру үшін функцияны пайдалануыңыз қажет
Application.HelpCommand(HELP_FINDER, 0) ;
Біз анықтаған анықтама бөлімдерінің біріне өту үшін функцияны шақыру қажет
Application.HelpJump('MyTopic'),
мұнда MyTopic - тақырып идентификаторы.
Көмек алудың бір жолы - F1 пернесін басу. F1 пернесін басу арқылы контекстке сезімтал көмек шақыруын реттеуге болады, бір немесе басқа басқару элементі белсенді болғанда. Мұны орындау үшін, көмек туралы тиісті тақырып нөмірге тағайындалады және содан кейін бұл санды басқарманың HelpContext сипатына тағайындайды. Көмек тақырыбына арналған нөмірлерді анықтау үшін, HelpWorkshop бағдарламасындағы көмек жобасын ашып, терезенің оң жағындағы Карта түймешігін басыңыз.Тілқатысу терезесіндегі Қосу түймешігін нұқып, тақырып кодын және кез келген нөмірді енгізіңіз, барлық қажетті тақырыптар үшін (әрқайсысы өз нөмірімен) қайталаңыз, терезені жабыңыз және Сақтау және құрастыруды қайтадан басыңыз. Содан кейін, нысанның инспекторы терезесіндегі Delphi-де қажетті элементтерге керекті сандарды белгілеңіз.
Достарыңызбен бөлісу: |