Колдонуучунун колдонмосун жазыңыз

Автор: John Pratt
Жаратылган Күнү: 15 Февраль 2021
Жаңыртуу Күнү: 1 Июль 2024
Anonim
Колдонуучунун колдонмосун жазыңыз - Насаат
Колдонуучунун колдонмосун жазыңыз - Насаат

Мазмун

Программалык камсыздоо, компьютерлер, оюндар жана шаймандар колдонуучунун колдонмосун талап кылат; өнүмдү кантип колдонууну түшүндүргөн колдонмолор (жана кантип колдонбоо керек). Колдонмо үчүн колдонмо белгилүү бир структурага ээ расмий документ болуп саналат жана аны продуктту сыртынан билген адам жазышы керек, мисалы техникалык жазуучу же продукт дизайнери. Натыйжалуу колдонуучунун колдонмосун жазуу өнүмдү ким колдоноорун жана ушул колдонуучуларды эске алуу менен колдонмону жазууңузду талап кылат. Колдонуучунун көйгөйсүз тажрыйбасын камсыз кылуу үчүн жазууңузду так, так жана жөнөкөй кылып жазыңыз.

Басуу

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. Стандарттарыңызды тандаңыз. Орфографияны, сөз тандоону жана текстти стандартташтыруу колдонуучунун колдонмосун ыңгайлуураак кылат. Chicago Style Manual жана Microsoft Manual of Style колдонуучунун колдонмосун жазууда да колдонмо стилдери үчүн пайдалуу болушу мүмкүн; бирөө сиздин колдонмоңузга туура келер-келбесин билип алыңыз.
    • Мисалы, колдонмодогу "кубаттуулук которгучун" жана "кубат баскычын" колдонуунун ордуна, эки терминдин бирин тандап, аны карманыңыз.
  3. Активдүү үндү колдонуңуз. Активдүү үн - бул нерсени колдонуучунун көз карашы менен түшүндүргөн жазуу жолу. Альтернатива, тема аныкталбаган пассивдүү үнгө караганда, аны түшүнүү жеңилирээк.
    • Жазууңуздагы пассивдүү жерлерди аныктоо үчүн Хемингуэй колдонмосун (www.hemmingwayapp.com) байкап көрүңүз.
    • Ушул эки сүйлөмдүн үлгүлөрүн изилдеп көрүңүз - биринчиси активдүү, экинчиси пассивдүү:
      • Топтомду жай жана кылдаттык менен ачуу керек.
      • Таңгакты жай жана кылдаттык менен ачуу керек.
  4. Номерленген көрсөтмөлөрдү жазыңыз. Сан жагынан буйрулган көрсөтмөлөр окурманга каралып жаткан өнүмдү колдонуу, туташтыруу же куруу процессине көбүрөөк көңүл бурууга жардам берет. Узун, толук абзацты же номери жок бир катар абзацтарды жазуунун ордуна, колдонуучунун көрсөтмөсүн ар бири так номерленген жөнөкөй, так кадамдар менен жазыңыз.
  5. Ар бир кадамды сөзсүз түрдө баштаңыз. Императив - аракетке багытталган этиш. Ар бир кадамды этиш менен баштоо менен, сиз окурманга кадамды аягына чыгаруу үчүн талап кылынган иш-аракет жөнүндө кеңеш берет. Мисалы, сиз жазып жаткан өнүмгө жараша, кадамдарды "Байланыш", "Ырастоо" же "Слайд" сыяктуу буйрук менен баштасаңыз болот. Бирок, кадамдарыңызды тутумдун жообу менен баштабаңыз.
    • Мисалы, экран көгөрүп, жаркылдай баштаса, кадамды: "Экран жымыңдайт жана көгөрөт" деп баштабаңыз. Аракет кылыңыз: "Үй баскычын басып, кармап туруңуз. Экран жаркылдайт жана көгөрөт. "
  6. Кайсы лексиканы колдонооруңузду аныктаңыз. Эгер сиз yo-yo колдонмосун жазып жатсаңыз, анда аудиторияңыз негизинен жаш балдар болот. Жөнөкөй сөздөрдү жана лексиканы колдонуп, yo-yo кандай иштээрин түшүндүрүп бериңиз. Сканерлөөчү электрондук микроскоп боюнча колдонмо жазып жатканыңызда, сиздин аудиторияңыз өтө кылдат маалыматты түшүнө алган жогорку квалификациялуу окумуштуулардан турат, андыктан атайын лексика же нюанстуу түшүндүрмөлөрдү колдонуудан тартынбаңыз.
    • Жалпысынан, жаргон жана техникалык тилден алыс болууга аракет кыласыз.
    • Мүмкүн болушунча кеңири колдонуучу үчүн натыйжалуу болуш үчүн, башталгыч мектептин алтынчы классынан жетинчи классына чейинки деңгээлде жазууга аракет кылыңыз.
  7. Өнүмдү чет өлкөгө жөнөтүүдө, котормолоруңуздун тактыгын текшериңиз. Колдонуучунун колдонмосун сиз жөнөтүп жаткан өлкөнүн эне тилине которуу үчүн котормочуну жалдаңыз. Ошондой эле Интернеттеги котормо программасын колдонсоңуз болот, бирок эне тилинде сүйлөгөн адамдан котормону окуп, каталарын текшерүүсүн сураныңыз.
    • Эгерде сиздин аудиторияңызда бир нече тил топтору сунушталса, колдонмо нускамасынын ар бир тиешелүү тилге котормолорун киргизиңиз.
    • Котормочу продукт менен тааныш болушу керек, анткени сөзмө-сөз котормо болбогон белгилүү бир терминдер үчүн котормо тилинде ар кандай сөздөр болушу мүмкүн.
  8. Кыска сүйлөмдөр менен жаз. Бир нече узун абзацтардын ордуна, сиз көптөгөн кыска абзацтарды колдоносуз. Ар бир бөлүмдөн логикалык тыныгууларды издеп, пайдалуу маалыматтарды бир же эки сүйлөмдөн турган бөлүктөргө бөлүп алыңыз. Сүйлөм деңгээлинде дагы ушундай. Сүйлөмдөрүңүздү кыска жана жөнөкөй сүйлө, тескерисинче, кыска жана жөнөкөй болсун.
    • Эгер кадам өтө эле узарып баратса, анда аны кичинекей кадамдарга бөлүңүз. Бул сөздөрдүн санын кыскарта албайт, бирок саптардын үзүлүшү окууну жеңилдетет.
  9. Катачылыкка байланыштуу колдонмону текшериңиз. Окуу куралы грамматикадан жана орфографиялык каталардан улам ишенимди жоготушу мүмкүн. Кесиптешиңизден же техникалык жазуучудан колдонмону оңдоп, корректировкаңыз. Корректор орфография жана грамматикадан тышкары төмөнкүлөргө көңүл бурушу керек:
    • Туюк залог
    • Түшүнүксүз же түшүнүксүз тил
    • Оролгон сүйлөмдүн түзүлүшү
    • Абдан узун абзацтар

Сунуштар

  • Адамдар ар кандай жолдор менен билим алышат; Мүмкүн болсо жана ылайыктуу болсо, визуалдык багыттагы окурмандарды жайгаштыруу үчүн колдонмого көрсөтмө куралдарын же онлайн видеолоруна шилтемелерди кошуңуз.