Өнертапқыш, бағдарламалаушы немесе рационализатор қанша тапқыр болса да, кейде оның туындыларын мақсатына сай пайдалану мүмкін емес. Мұның себебі қате ресімделген нұсқаулық немесе оның толық болмауы. Бірақ тіпті тапқыр өнертапқыштар кейде осындай нұсқаулықтарды тар мамандардан басқа ешкім оқи алмайтындай етіп жазады. Сонымен, осындай қажетті құжатты қалай дұрыс рәсімдеу керек?
Бұл қажетті
- - нұсқаулық жазылған құрылғы немесе бағдарламалық өнім туралы жүз пайыз білім;
- - лингвистика саласындағы білім;
- - жазу дағдылары.
Нұсқаулық
1-қадам
Пайдаланушы нұсқаулығы немесе басқаша айтқанда, пайдалану жөніндегі нұсқаулық - бұл белгілі бір жүйені пайдаланушыларға пайдалануға көмек көрсетуге арналған құжат. Пайдаланушы нұсқаулығын құрастыру үшін сізге сипатталған жүйені жүз пайыз білу қажет, бірақ оған білімсіз студенттің көзімен қарау керек. Пайдаланушы нұсқаулығы аналогы жоқ бағдарламалық жасақтама үшін жазылған делік. Бұл бағдарламаны бірінші рет пайдаланып отырғаныңызды елестетіп көріңіз. Сіз неден бастайсыз? Алдымен нені білу керек? Осы білімдерді маңыздылық санаттарына бөліңіз.
2-қадам
Сіздің құрылғыңызға қатысты барлық ақпаратты топтарға бөлу арқылы сіз пайдаланушы нұсқаулығын жазудың жоспарын жасадыңыз. Бағдарламадағы жұмысты нөлден сипаттай бастаңыз, ең қиын бөлшектерді қалдырыңыз, мысалы, қайта бағдарламалау мүмкіндіктері немесе қателіктермен жұмыс істеу. Осы кезеңде сізде пайдаланушы нұсқаулығының мазмұны дайын болуы керек - осы құжаттың қажетті бөліктерінің бірі.
3-қадам
Егер сіз құрып жатқан нұсқаулық ірі компанияда қолдануға арналған болса, онда сіз сол жерде қабылданған корпоративтік стандарттарға назар аударғаныңыз жөн. Мысалы, көптеген ресейлік компанияларда пайдаланушы нұсқаулықтары иллюстративті қолдаусыз қабылданбайды, басқаша айтқанда, жазылғанды түсіндіретін суреттер. Мазмұннан басқа, пайдаланушы нұсқаулығында басқа міндетті бөліктер болуы керек: - аннотация, яғни нұсқаулықтың жалпы сипаттамалары мен сипатталған өнім туралы түсініктеме; - пайдаланушы нұсқаулығына қатысты құжаттарды сипаттайтын кіріспе және нұсқаулықты пайдалану; - өнімді пайдаланудың әр түрлі кезеңдерінде өнімді пайдалануды түсіндіретін бөлімдер, мысалы, алғашқы қадамдар, жөндеу немесе техникалық қызмет көрсету; - жиі қойылатын сұрақтар мен оларға жауаптар бөлімі; - глоссарий немесе тақырыптық индекс.
4-қадам
Әдетте техникалық жазушы пайдаланушы нұсқаулығын жасауға қатысады - тілде де, сипатталатын өнімде де барлық қажетті білімдері бар адам. Тренингсіз техникалық жазушы ретінде бірнеше ережелерді ескеру қажет. Біріншіден, сіз қарапайым пайдаланушыға түсініксіз арнайы шарттарды теріс пайдаланбаңыз. Екіншіден, қолданылатын әрбір термин егжей-тегжейлі және түсіндірілуі керек. Үшіншіден, мүмкіндігінше нақты әрі нақты жазу керек. Ақырында, техникалық жазушы өз мәтінінің кемшіліктерін көру үшін өз мәтінін қарапайым қолданушының көзімен қарай білуі керек.
5-қадам
Пайдаланушы нұсқаулығының дайын мәтінін іс жүзінде оны сипатталған өніммен ешқандай байланысы жоқ адамға ұсыну арқылы тексеру жақсы. Бірлескен күш-жігермен құжаттың барлық кемшіліктері мен ақауларын жоюға болады.
