Мазмұны

• Басу үшін
• 4-тен 1-бөлім: Сіздің пайдаланушының нұсқаулығын жоспарлау
• 4-тен 2-бөлім: Қажетті ақпаратты енгізіңіз
• 4-тен 3-бөлім: Өнімге қызмет көрсетуді сипаттау
• 4-тен 4-бөлім: Оқылатын нұсқаулық жазыңыз
• Кеңестер

Бағдарламалық жасақтама, компьютерлер, ойындар мен құрылғылар пайдаланушы нұсқаулығын қажет етеді; өнімді қалай пайдалану керектігін түсіндіретін нұсқаулық (және қалай емес). Пайдаланушы нұсқаулығы белгілі бір құрылымы бар ресми құжат болып табылады және оны өнімді ішінен білетін адам жазуы керек, мысалы техникалық жазушы немесе дизайнер. Тиімді пайдаланушы нұсқаулығын жазу өнімді кім қолданатындығын және осы пайдаланушыларды ескере отырып, нұсқаулықты жазуды қажет етеді. Пайдаланушының қиындықсыз жұмыс істеуін қамтамасыз ету үшін жазбаңызды түсінікті, дәл және қарапайым етіп сақтаңыз.

Басу үшін

4-тен 1-бөлім: Сіздің пайдаланушының нұсқаулығын жоспарлау

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

4-тен 2-бөлім: Қажетті ақпаратты енгізіңіз

1. Нұсқаулықты логикалық түрде ұйымдастырыңыз. Нұсқаулық пайдаланушы одан көп пайда алатындай етіп құрылымдалуы керек. Нұсқаулықты өнімді пайдалану мағынасы бар тарауларға немесе бөлімдерге бөліп, әр бөлім тез табылуы үшін нұсқаулықтың алдыңғы жағына мазмұн кестесін қосыңыз.
   • Мазмұны әсіресе ұзағырақ нұсқаулық үшін қажет.
   • Глоссарий немесе индекс қажет, егер сіздің аудиторияңыз таныс емес екенін түсіндіретін көптеген терминдер болса. Алайда, глоссарий ұсынылмайды; ең жақсы таңдау - бұл нұсқаулық мәтініндегі түсініксіз терминдерді түсіндіру. Егер сіз глоссарий қосқыңыз келсе, оны нұсқаулықтың алдыңғы жағына, мазмұннан кейін орналастырыңыз.
   • Кестелер немесе суреттер тізімі нұсқаулықта бірнеше кестелер немесе суреттер болған жағдайда ғана қажет.
   • Қосымшаны түсіндіруге тура келетін, бірақ нұсқаулықтың басқа жерлерінде түсіндіруге болмайтын нәрселер қажет, өйткені ол ағым мен фокусты бұзады.
2. Қажетті ескертулерді қосыңыз. Жалпы ескертулер немесе сақтық туралы ақпарат өнімді дұрыс пайдаланбау, оның ішінде өлім немесе ауыр жарақат алу салдарынан туындауы мүмкін қауіптер туралы ақпарат беруі керек. Бұл ескертулер нұсқаулықтың алдыңғы жағында, бірінші парақтан кейін орналастырылуы керек, сонда пайдаланушы оны алдымен көреді. Ерекше ескертулер ықтимал қауіпті қадам ұсынылғаннан кейін немесе одан сәл бұрын нұсқаулық мәтініне енгізілуі керек.
   • Мысалы, электр құрылғысы үшін жаңбыр жауып тұрған кезде оны пайдаланбау туралы жалпы ескерту болуы мүмкін.
   • Құрылғыны розеткаға қоспас бұрын, сіздің қолыңыздың да, құрылғының да құрғақ екендігіне көз жеткізуге болады.
   • Ескертуді ХҚО-дағы қалған бағыттардан ажырату үшін және қолданушылардың назарын аудару үшін суреттерді (мысалы, бас сүйек пен көлденең сүйектер сияқты) немесе басқа түсті мәтінді (мысалы, қызыл мәтін) беріңіз.
3. Құрылғыны сипаттаңыз. Сіздің сипаттамаңыз құрылғының мақсатын жазбаша түсіндіруді де, құрылғының сыртқы түрінің кішігірім графикалық көрінісін де қамтуы керек. Суретте құрылғыдағы барлық қосқыштарды, түймелерді және бекітілген бөлшектерді жапсырып, оларды атауы керек.
4. Орнату нұсқауларын беріңіз. Орнату бөлімі өнімді немесе құрылғыны пайдалануға дайындық туралы негізгі ақпаратты қамтуы керек. Егер құрылғыны үйдің пайдаланушысы құрастыра немесе орната алмаса, мұны орнату бөлімінің жоғарғы жағындағы жуан тақырыпта нақты көрсетіңіз. Сізге келесілерді қосу керек:
   • Бөлшектер тізімі
   • Қаптан шығаруға арналған нұсқаулық
   • Орнатуға қатысты ескертулер
   • Қате орнатудың салдары
   • Орнату кезінде қиындықтар туындаған жағдайда кімге қоңырау шалу керек
5. Операция туралы ақпарат беріңіз. Бұл бөлім пайдаланушы нұсқаулығының маңызды бөлігі болып табылады және құрылғыны пайдалану туралы нақты, толық ақпарат беруі керек. Аспапты пайдалануға дайындықтан бастаңыз, мысалы, қуат сымын қосу немесе қолыңызды жуу. Құрылғыны қалай пайдалану керектігін сипаттайтын логикалық, нөмірленген қадамдармен, сондай-ақ құрылғыны дұрыс пайдалану кезінде пайдаланушы күтуі мүмкін кез-келген кері байланысты (мысалы, «Сіз клик» естисіз ... ») жалғастырыңыз.
   • Осы тараудың соңында тез түсіндіруге болмайтын мәселелерді шешу үшін пайдаланушыларға ақаулықтарды жою тарауына жүгіну керек.
   • Қажет жерлерге кескіндерді орналастырыңыз. Кейбір қадамдар суреттермен де, сөздермен де жақсы түсіндіріледі. Нұсқаулықтағы фотосуреттерді немесе суреттерді пайдалануды қарастырыңыз.
   • Бұл бөлімде, кез-келген бөлімдегі сияқты, дұрыс пайдаланбау немесе пайдалану туралы тиісті қауіпсіздік ескертулерін қосу керек. Мысалы, сіз аралау машиналарын қолданушыларға алкогольді ішпеуді немесе кейбір дәрі-дәрмектерді қолданған кезде моторлы араны қолданбау туралы ескерту жасай аласыз.
   • Егер сіз қолданушыларға пайда әкеледі деп ойласаңыз, құрылғының дұрыс қолданылуы мен жұмысын көрсететін онлайн бейнелерге сілтемелерді қосуды қарастырыңыз. Сіз бұл бейнелерді осы бөлімнің басында немесе (тек бір қадамды бейнелейтін бейнелер жағдайында) әр қадамның соңында жаза аласыз.
6. Соңына өнімнің қысқаша мазмұнын қосыңыз. Қысқаша нұсқаулықтың соңында, индекстің алдында пайда болып, негізгі жұмыс қадамдарын қамтамасыз етуі керек. Бұл жедел ақпараттың жеңілдетілген, шешілген нұсқасы болуы керек және бір парақтан аспауы керек. Құрылғыны немесе өнімді қалай пайдалану керектігі туралы қорытынды жасаңыз. Негізгі ескертулерді, өнімді қалай қолдану керектігін түсіндіретін нөмірленген қадамдарды және пайдаланушыларды көмекке бағыттайтын телефон нөмірлерін немесе электрондық пошта мекенжайларын қосыңыз.
   • Егер сіз пайдаланушыдан жиынтық парақты жиі алып тастайды немесе оған сілтеме жасайды деп күтсеңіз, оны алып тастауға және сілтеме жасауды жеңілдету үшін оны алынбалы ламинатталған картаға немесе қалың картонға басып шығаруға болады.
   • Сонымен қатар, пайдаланушыға тез және жеңіл сілтеме жасау үшін сіз қысқаша сипаттаманы өнімге тікелей қолдана аласыз.

4-тен 3-бөлім: Өнімге қызмет көрсетуді сипаттау

1. Құрылғыны қалай тазартуға болатындығын түсіндіріңіз. Егер құрылғыны немесе өнімді тазалау қажет болса, мұны қалай істеуге болатындығын түсіндіріңіз. Қажетті тазалағыш заттарды тізімдеңіз. Оқырманға қанша рет тазалау керектігін айтыңыз. Содан кейін, нұсқаулықтың кез-келген басқа бөлігіндегі сияқты, оны қалай тазалау керектігі туралы нөмірленген қадамдық нұсқаулықты қосыңыз.
   • Егер тазалау өнімді бөлшектеуді немесе белгілі бір бөлігін немесе бөліктерін алуды қажет етсе, өнімді қалай бөлшектеу керектігін көрсетіңіз.
   • Құрылғыны тазаламау нәтижелері туралы ескерту беріңіз. Мысалы, сіз: «Егер құрылғы тазаланбаса, өнімділік оңтайлыдан аз болады» деп айта аласыз.
2. Пайдаланушыны негізгі техникалық қызмет көрсетуді қалай орындау керектігін санаңыз. Өнім немесе құрылғы өнімділікке қатысты мәселелерді түзету үшін пайдаланушыға қызмет көрсете алса, оны қолданушыға қалай жасау керектігі туралы нөмірленген нұсқаулар беріңіз. Мысалы, батареяларды әр 300 сағат сайын қолданғаннан кейін оларды ауыстыру қажет болса, батареяларды ауыстыру керек еместігін тексеріп, сөніп қалған батареяларды алып тастау және жаңаларын орнату туралы нұсқаулар беріңіз.
   • Егер тек сертификатталған техник орындай алатын техникалық қызмет көрсетудің белгілі бір тапсырмалары болса, нұсқаулықтың техникалық қызмет көрсету бөлігін екі бөлікке бөліңіз.
3. Сақтау опцияларын талқылаңыз. Қажет болса, нұсқаулықта өнімді немесе құрылғыны қалай дұрыс сақтау керектігі түсіндірілуі керек. сонымен қатар сақтаудың не үшін қажет екендігі және дұрыс сақтамаудың салдары туралы ақпаратты қосу керек. Мысалы: сіз жаза аласыз:
   • Өнімді салқын, құрғақ жерде сақтаңыз. Дұрыс емес сақтау ылғалдың өсуіне байланысты сіздің өніміңіздің қызмет ету мерзімін қысқартуы мүмкін ».
   • «Өнімді 50 градустан жоғары температурада жылытуға немесе сақтауға қоймаңыз.Егер жасасаңыз, бұл жануға әкелуі мүмкін ».
4. Ақаулықтарды жою туралы ақпарат беріңіз. Сіз бұл бөлімді жалпы проблемалар мен оларды шешу жолдарының тізімі ретінде ұйымдастыра аласыз. Ұқсас есептерді логикалық тақырып бойынша топтастырыңыз. Осылайша, пайдаланушылар нақты мәселелерді тез таба алады.
   • Мысалы, компьютерде көгілдір экранды көрсетуге байланысты бірнеше проблемалар туындаса, оларды «Жалпы экран проблемалары» сияқты тақырыпшаның астына топтаңыз.
   • Сондай-ақ, осы бөлімге тұтынушыларға қызмет көрсету үшін телефон нөмірін және / немесе электрондық поштаны қосу керек.

4-тен 4-бөлім: Оқылатын нұсқаулық жазыңыз

1. Басқа пайдаланушы нұсқаулықтарын оқыңыз. Өз өніміңізге арналған нұсқаулық жазбас бұрын, басқа тиімді пайдаланушы нұсқаулықтарын қарап шығыңыз. Құрылымына, сөз таңдауына және сөйлем құрылымына назар аударыңыз. Apple, Google және Microsoft сияқты ірі брендтер сізге ойластырылған жазылған пайдаланушы нұсқаулығын шығаруға көмектесетін мықты, тиімді пайдаланушы нұсқаулықтарын шығарады.
   • Тек оқымаңыз барлық пайдаланушы нұсқаулықтары. Сіз сататын ұқсас өнімдерге арналған нұсқаулықтарды оқыңыз. Мысалы, сіз балаларға арналған өнімдерді сатсаңыз, техникалық емес, балаларға арналған нұсқаулықтарды оқыңыз.
2. Стандарттарыңызды таңдаңыз. Орфографияны, сөздерді таңдауды және тұжырымдауды стандарттау пайдаланушыға ыңғайлы етеді. Сондай-ақ, Чикаго стилі бойынша нұсқаулық және Microsoft нұсқаулық стилі сіздің иеңіздің нұсқаулығын жазу кезінде пайдалы нұсқаулық бола алады; нұсқаулыққа сәйкес келетіндігін тексеру үшін екеуін де тексеріңіз.
   • Мысалы, нұсқаулықтағы «қуат қосқышын» және «қуат түймесін» пайдаланудың орнына, екі шарттың бірін таңдап, оны ұстаныңыз.
3. Белсенді дауысты қолданыңыз. Белсенді дауыс - бұл қолданушы тұрғысынан нәрселерді түсіндіретін жазу тәсілі. Тақырып анықталмаған балама, пассивті дауысқа қарағанда түсіну оңай.
   • Жазбаңыздағы пассивті жерлерді анықтау үшін Хемингуэй қосымшасын (www.hemmingwayapp.com) қолданып көріңіз.
   • Осы екі сөйлемнің үлгісін зерттеңіз - біріншісі белсенді, екіншісі енжар:
     • Сіз пакетті ақырын және мұқият ашыңыз.
     • Қаптама ақырын және мұқият ашылуы керек.
4. Нөмірленген нұсқауларды жазыңыз. Сандық тәртіпте берілген нұсқаулар оқырманға қарастырылып отырған өнімді пайдалану, қосу немесе құру процесіне жақсы көңіл бөлуге көмектеседі. Ұзын, мағыналы абзацты немесе нөмірленбеген абзацтар сериясын жазудың орнына, пайдаланушы нұсқаулығын қарапайым, нақты қадамдармен жазыңыз, олардың әрқайсысы нақты нөмірленген.
5. Әрбір қадамды міндетті түрде бастаңыз. Императив - бұл іс-әрекетке бағытталған етістік. Әр қадамды етістіктен бастай отырып, сіз оқырманға қадамды аяқтауға қажетті іс-әрекет туралы кеңес бересіз. Мысалы, сіз жазып отырған өнімге байланысты қадамдарыңызды «Қосылу», «Растау» немесе «Слайд» сияқты командалармен бастауға болады. Дегенмен, қадамдарыңызды жүйенің жауабынан бастамаңыз.
   • Мысалы, егер экран көгеріп, жыпылықтай бастаса, қадамды: «Экран жыпылықтайды және көгереді» деп бастамаңыз. Әрекет жасаңыз: «Үй пернесін басып тұрыңыз. Экран жыпылықтайды және көгереді ».
6. Қай сөздік қорды қолданатыныңызды анықтаңыз. Егер сіз yo-yo нұсқаулығын жазып отырсаңыз, сіздің аудиторияңыз негізінен кішкентай балалар болады. Йо-йо қалай жұмыс істейтінін түсіндіру үшін қарапайым сөздер мен лексиканы қолданыңыз. Электронды микроскоптың сканерлеу бойынша нұсқаулығын жазып жатқанда, сіздің аудиторияңыз өте білікті ғалымдардан тұрады, олар өте егжей-тегжейлі ақпаратты түсінеді, сондықтан арнайы лексика мен түсініктемелерді қолданудан қашпаңыз.
   • Жалпы, сіз жаргон мен техникалық тілден аулақ болуға тырысасыз.
   • Мүмкіндігінше кең пайдаланушыға тиімді болу үшін бастауыш мектептің алтыншы-жетінші сыныптары деңгейінде жазуға тырысыңыз.
7. Өнімді шетелге жіберу кезінде аудармалардың дәлдігіне көз жеткізіңіз. Пайдаланушы нұсқаулығын өз өніміңізді жеткізіп жатқан елдің ана тіліне аудару үшін аудармашыны жалдаңыз. Сіз сондай-ақ Интернеттегі аударма бағдарламасын пайдалана аласыз, бірақ ана тілінен аударманы оқып, қателіктерін тексеруді сұраңыз.
   • Егер сіздің аудиторияңызда бірнеше тілдік топтар ұсынылса, пайдаланушы нұсқаулығының әр сәйкес тілдегі аудармаларын қосыңыз.
   • Аудармашы өніммен таныс болуы керек, өйткені сөзбе-сөз аударма болып табылмайтын белгілі бір терминдер үшін аударма тілінде әр түрлі сөздер болуы мүмкін.
8. Қысқа сөйлемдермен жазыңыз. Бірнеше ұзын абзацтардың орнына сіз көптеген қысқа абзацтарды қолданасыз. Әр бөлімнен логикалық үзілістерді іздеңіз және бір немесе екі сөйлемнен тұратын пайдалы ақпаратты қорытыңыз. Сөйлем деңгейінде де дәл солай. Сөйлемдеріңізді ұзақ әрі мағыналы емес, қысқа әрі қарапайым етіп қойыңыз.
   • Егер қадам тым ұзаққа созылып бара жатса, оны кішігірім қадамдарға бөліңіз. Бұл сөздердің санын азайтуға мүмкіндік бермейді, бірақ үзілістер оқуды жеңілдетеді.
9. Қателіктер үшін нұсқаулықты тексеріңіз. Нұсқаулық грамматика мен емле қателеріне байланысты сенімділікті жоғалтуы мүмкін. Әріптесіңізден немесе техникалық жазушыңыздан нұсқауды өңдеп, өңдеңіз. Корректор емле мен грамматикадан басқа келесілерге назар аударуы керек:
   • Пассивті дауыс
   • Түсініксіз немесе түсініксіз тіл
   • Оралған сөйлем құрылымы
   • Шамадан тыс абзацтар

Кеңестер

• Адамдар әртүрлі тәсілдермен білім алады; Мүмкін болса және орынды болса, көрнекі оқырмандарды орналастыру үшін нұсқаулыққа көрнекі құралдарды немесе сілтемелерді қосыңыз.