İstifadəçi təlimatı yazın

Müəllif: John Pratt
Yaradılış Tarixi: 15 Fevral 2021
YeniləMə Tarixi: 1 İyul 2024
Anonim
Xan Lənkəran vs. Füzuli FK  / Cavab oyunu / Pley-off / Region Liqası
Videonuz: Xan Lənkəran vs. Füzuli FK / Cavab oyunu / Pley-off / Region Liqası

MəZmun

Proqram, kompüterlər, oyunlar və cihazlar istifadəçi təlimatlarına ehtiyac duyur; məhsulun necə istifadə ediləcəyini izah edən təlimatlar (və necə istifadə olunmaması). İstifadəçi təlimatı müəyyən bir quruluşa malik rəsmi sənəddir və məhsulu içəridən tanıyan, məsələn texniki müəllif və ya məhsul dizayneri kimi yazılmalıdır. Effektiv bir istifadəçi təlimatı yazmaq məhsulu kimin istifadə edəcəyini bilmənizi və bu istifadəçiləri nəzərə alaraq təlimatı yazmağınızı tələb edir. Problemsiz istifadəçi təcrübəsi təmin etmək üçün yazılarınızı aydın, dəqiq və sadə tutun.

Addımlamaq

4-dən 1-ci hissə: istifadəçi kitabçanızın planlaşdırılması

  1. Bir istifadəçi təhlili edin. İstifadəçi təlimatı istifadəçilər üçün yazılmalıdır - məhsulunuzu və ya xidmətinizi alıb istifadə kitabçasını oxuyanlar. Bir istifadəçi təhlili əsas və ya hədəf auditoriyanızın kim olacağını sizə xəbər verəcək və mətnin yazılması zamanı sizə rəhbərlik edəcəkdir.
    • Cihazınızı istifadə edəcək insanlarla danışın. İdarə olunan şərtlər altında cihazın prototiplərini və istifadəçi kitabçasının sınaq istifadəçilərini təklif edin. İstifadəçi təlimatındakı anlaşılmaz və ya qarışıq olan şeylər barədə bu test istifadəçilərindən rəy istəyin və bu rəy əsasında istifadəçi təlimatınızda dəyişikliklər edin.
    • Bütün auditoriyanı heç vaxt qane edə bilməzsiniz; hədəf kitaba və ya ən böyük auditoriyaya uyğun olaraq hazırlanmış təlimatı yazın.
    • İstifadəçi təlimatını yazmaq üçün ən yaxşı yanaşmanı təyin etmək üçün yaşı, sağlamlığı (xəstəlikləri, öyrənmə qüsurları və ya əlilliyi varmı?) Və tamaşaçıların təhsil səviyyələrini nəzərə alın.
  2. İstifadəçi təlimatının dizaynını koordinasiya edin. Cihazı və ya məhsulu hazırlamağa və inkişaf etdirməyə kömək edən bir qrupun bir hissəsi olsaydınız, məhsulun necə işlədiyini izah etmək üçün obyektiv bir şəkildə baxmaq çətin ola bilər. Buna görə istifadəçi təlimatını hazırlamağınıza kömək etmək üçün bir yazıçıdan (tercihen təcrübə yazma təlimatı olan birisi) və bir qrafik dizaynerdən məsləhət almalısınız. Bu insanları xarici bir məsləhət və ya öz şirkətinizdən və ya təşkilatınızdan seçə bilərsiniz.
  3. Tapşırıq təhlili edin. İş analizi, cihazı istifadə etmək üçün tələb olunan addımların müəyyənləşdirilməsi və təşkili prosesidir. Hərtərəfli iş təhlili hər addım üçün tələb olunan materialları və avadanlıqları (batareyalar, dərmanlar və ya istifadəçi tərəfindən təmin olunan digər məhsullar kimi) hər addımın tələb edə biləcəyi hərəkətləri, səhvləri və problemi həll etmə tövsiyələrini müəyyənləşdirir.
    • Bir çox fərqli tapşırıq və ya alt tapşırıq yerinə yetirə bilən bir məhsulunuz varsa, hər tapşırıq üçün tapşırıq təhlili aparmalısınız. Məsələn: bir avtomobildə bağlaya bilərsiniz, özünüzü bağlayın və faralarınızı açıb söndürün. Lazım gələrsə bunların hər biri üçün iş təhlili aparın.
  4. Məhsulunuzun etiketləmə və marketinq icazəsi tələblərinə cavab verdiyinə əmin olun. Bu tələblər məhsulların istifadəçinin təhlükəsizliyini nəzərə alaraq istehsal olunmasını və istifadəçinin radiasiya və elektrik cərəyanı kimi təhlükəli şərtlərə məruz qalmasının məhdud olmasını təmin edir. Reklamlarda bir məhsulun məqsədi və əsas istismar qaydaları aydın şəkildə göstərilməlidir və istifadəçi təlimatını yazarkən bu mənbələrdən istifadə etməlisiniz.
    • Bir məhsulun istifadə kitabçasının təsirli olması üçün birbaşa məhsula yapışdırılmış etiketlərə uyğun yazılmalıdır.
    • İstifadəçi təlimatını yazmazdan əvvəl cihazınızın satış üçün rəsmi olaraq lisenziyalandığından əmin olun.
  5. Təlimatınızın tərtibatına qərar verin. Təlimatınızı asanlaşdırmağın bir neçə vacib yolu var. Hər hissənin əvvəlinə hər sözü böyük hərflərlə cəsarətli bir başlıq qoymalısınız. Məsələn, "Cihazınızı qurun", "Cihazınızı idarə edin" və "Giderme" nin hamısı cəsarətli bölmə başlıqları ola bilər.
    • Bələdçinizi düzəltməyin başqa bir yolu, biri sağda, digəri mətnin solunda, sütunlar, rəqəmlər və ya xəbərdaredici işarələr və ya qırmızı nida işarələri kimi kiçik nişanlarla iki sütun istifadə etməkdir.
    • Təlimat əsasən cihazı izah etmək üçün hər bir şəkilin altında bəzi mətni olan şəkillərdən ibarət ola bilər və ya əsasən yalnız bir neçə şəkli müşayiət edən şəkillərdən ibarət ola bilər. İstifadəçiyə rəhbərlik etmək üçün bir qrafik sxemindən də istifadə edə bilərsiniz. Məhsulunuzu və hər metodun təlimatı yazmağınıza necə kömək edə biləcəyini düşünün. Bununla birlikdə, bir təlimat daxilində fərqli planları qarışdırmaqdan çəkinin. Birini seçin və onunla qalın.

4-cü hissə 2: Əsas məlumatları yerləşdirin

  1. Təlimatı məntiqi şəkildə təşkil edin. Təlimat elə qurulmalıdır ki, istifadəçi ondan ən çox fayda götürsün. Təlimatı məhsulu istifadə etmək üçün mənalı olan fəsillərə və hissələrə bölün və təlimatın ön hissəsinə bir cədvəl əlavə edin ki, hər bölmə tez tapılsın.
    • Mündəricat, daha uzun təlimatlar üçün xüsusilə lazımdır.
    • Auditoriyanızın tanış ola bilməyəcəyini izah edən bir çox şərt varsa, bir lüğət və ya indeksə ehtiyac var. Bununla birlikdə, bir lüğət tövsiyə edilmir; ən yaxşı seçim təlimat mətnindəki qarışıq şərtləri izah etməkdir. Sözlük daxil etməyi seçsəniz, onu məzmundan sonra, təlimatın ön hissəsinə yerləşdirin.
    • Cədvəl və ya rəqəmlərin siyahısı yalnız təlimatda bir neçə cədvəl və ya rəqəm olduqda lazımdır.
    • İzah edilməsi lazım olan, lakin təlimatın başqa bir yerində izah edilə bilməyən şeylər üçün əlavə lazımdır, çünki axını və fokusu pozacaqdır.
  2. Lazımi xəbərdarlıqları daxil edin. Ümumi xəbərdarlıqlar və ya ehtiyat məlumatları ölüm və ya ağır yaralanma da daxil olmaqla məhsulun düzgün istifadə edilməməsi nəticəsində yarana biləcək təhlükələr barədə məlumat verməlidir. Bu xəbərdarlıqlar, istifadəçinin əvvəlcə onları görməsi üçün təlimat səhifəsinin ön hissəsində, ön səhifədən sonra yerləşdirilməlidir. Xüsusi xəbərdarlıqlar, potensial təhlükəli bir addım təklif olunandan dərhal əvvəl və ya ondan əvvəl təlimatın mətninə daxil edilməlidir.
    • Məsələn, elektrikli bir cihaz üçün ümumi bir xəbərdarlıq, yağış yağarkən onu istifadə etməmək ola bilər.
    • Xüsusi bir göstəriş cihazı elektrik prizinə bağlamadan əvvəl həm əllərinizin, həm də cihazınızın quru olduğundan əmin olmaqdır.
    • Xəbərdarlığı IFU-da qalan istiqamətlərdən ayırmaq və istifadəçilərin diqqətini ona yönəltmək üçün şəkillər (kəllə və sümük sümükləri kimi) və ya fərqli bir rəngli mətn (qırmızı mətn kimi) təqdim edin.
  3. Cihazı təsvir edin. Təsvirinizdə həm cihazın məqsədinin yazılı izahatı, həm də cihazın necə göründüyünün kiçik bir qrafik təsviri olmalıdır. Rəqəm cihazdakı bütün açarları, düymələri və əlavə edilə bilən hissələri etiketləməli və adlandırmalıdır.
  4. Quraşdırma təlimatlarını verin. Quraşdırma bölməsində məhsuldan və ya cihazdan istifadəyə necə hazırlanacağına dair əsas məlumatlar olmalıdır. Cihaz ev istifadəçisi tərəfindən tikilə və ya qurula bilmirsə, quraşdırma hissəsinin yuxarı hissəsindəki cəsarətli bir başlıqda bunu açıq şəkildə bildirin. Aşağıdakıları da əlavə etməlisiniz:
    • Bir hissə siyahısı
    • Paketdən çıxarmaq üçün təlimatlar
    • Quraşdırma xəbərdarlıqları
    • Yanlış quraşdırmanın nəticələri
    • Quraşdırma zamanı çətinlik yarandıqda kimə müraciət etmək olar
  5. Əməliyyat barədə məlumat verin. Bu bölmə istifadə kitabçasının ən vacib hissəsidir və cihazı necə istifadə edəcəyinə dair konkret, ətraflı məlumat verməlidir. Elektrik şnurunu bağlamaq və ya əllərinizi yumaq kimi cihazı istifadə etmək üçün əsas hazırlığa başlayın. Cihazdan necə istifadə ediləcəyini izah edən məntiqi, nömrələnmiş addımlarla yanaşı cihazdan düzgün istifadə edərkən istifadəçinin gözləyə biləcəyi hər hansı bir geribildirimlə (məsələn, "Bir klik eşidəcəksiniz ...") davam edin.
    • Bu fəslin sonunda, tez bir zamanda izah edilə bilməyən problemləri həll etmək üçün istifadəçilərə problem həll etmə fəslinə müraciət edilməlidir.
    • Lazım olan yerlərdə şəkillər yerləşdirin. Bəzi addımlar həm şəkillər, həm də sözlərlə yaxşı izah olunur. Təlimatınızdakı fotoşəkillərin və ya illüstrasiyaların istifadəsini düşünün.
    • Bu hissədə, hər hansı bir bölmədə olduğu kimi, düzgün istifadə edilməməsi və ya istismarı ilə əlaqədar təhlükəsizlik xəbərdarlıqlarını daxil etməlisiniz. Məsələn, motorlu testere istifadəçilərinə bəzi dərman qəbul edərkən alkoqol qəbul etməməsi və ya motorlu mişar testerəsindən istifadə etməməsi barədə xəbərdarlıq edə bilərsiniz.
    • İstifadəçilərin fayda götürəcəyini düşünürsənsə, cihazın düzgün istifadəsini və istismarını göstərən onlayn videolara keçidlər daxil etməyi düşün. Bu videoları ya bu hissənin əvvəlində, ya da hər mərhələnin sonunda (yalnız bir addımı əks etdirən videolarda) yaza bilərsiniz.
  6. Sonda məhsulun xülasəsini əlavə edin. Xülasə əsas iş addımlarını təmin etmək üçün təlimatın sonunda, indeksdən bir az əvvəl görünməlidir. Bu əməliyyat məlumatlarının sadələşdirilmiş, soyulmuş versiyası olmalıdır və bir səhifədən çox olmamalıdır. Cihazın və ya məhsulun necə istifadə ediləcəyini ümumiləşdirin. Əsas siqnalları, məhsulun necə istifadə ediləcəyini izah edən nömrələnmiş addımları və istifadəçiləri kömək etməyə yönəldən telefon nömrələrini və ya e-poçt adreslərini daxil edin.
    • İstifadəçinin xülasə vərəqini tez-tez silməsini və ya ona müraciət etməsini gözləsəniz, istifadəçinin daşımasını və müraciət etməsini asanlaşdırmaq üçün çıxarıla bilən laminat karta və ya qalın kartona yazdıra bilərsiniz.
    • Alternativ olaraq, istifadəçi tərəfindən sürətli və asan istinad üçün məhsula birbaşa bir xülasə tətbiq edə bilərsiniz.

4-dən 3-cü hissə: Məhsulun saxlanmasını təsvir etmək

  1. Cihazın necə təmizlənəcəyini izah edin. Cihazınızın və ya məhsulunuzun təmizlənməsinə ehtiyac varsa, bunu necə edəcəyinizi izah edin. Tələb olunan təmizləyici maddələrin siyahısını verin. Oxucuya nə qədər tez-tez təmizlənəcəyini söyləyin. Sonra, təlimatın digər hissələrində olduğu kimi, onu necə təmizləyəcəyiniz barədə nömrəli addım-addım təlimat daxil edin.
    • Təmizlik məhsulun sökülməsini və ya müəyyən bir hissənin və ya hissələrin çıxarılmasını tələb edirsə, məhsulun necə sökülməsini göstərin.
    • Cihazı təmizləməmənin nəticəsi barədə xəbərdarlıq edin. Məsələn, "Cihaz təmizlənməsə, performans optimaldan az olacaq" deyə bilərsiniz.
  2. Əsas baxımı necə aparacağını istifadəçini sayın. Məhsul və ya cihaz performans problemlərini düzəltmək üçün istifadəçinin xidmətindədirsə, istifadəçi üçün bunu necə etmək barədə nömrəli təlimatlar verin. Məsələn, hər 300 saatlıq istifadədən sonra batareyaları dəyişdirmək lazımdırsa, batareyaların dəyişdirilməli olub olmadığını yoxlamaq, ölü batareyaları necə çıxarmaq və yenilərini necə quraşdırmaq barədə təlimat verin.
    • Yalnız sertifikatlı bir mütəxəssis tərəfindən yerinə yetirilə bilən müəyyən texniki tapşırıqlar varsa, təlimatın texniki hissəsini iki hissəyə bölün.
  3. Saxlama seçimlərini müzakirə edin. Lazım gələrsə, təlimatda məhsulun və ya cihazın necə düzgün saxlanılacağı izah edilməlidir. saxlamanın nə üçün lazım olduğu və səhv saxlamanın nəticələri barədə məlumat daxil etməlisiniz. Məsələn: yaza bilərsən:
    • Məhsulu sərin və quru yerdə saxlayın. Yanlış saxlama məhsulunuzun nəm yığması səbəbindən ömrünü qısalda bilər. "
    • "Məhsulu istiliyinə və ya Selsi 50 dərəcədən yüksək temperaturda saxlamağa qoymayın.Bunu etsəniz, yanmağa səbəb ola bilər. "
  4. Problemlərin aradan qaldırılması barədə məlumat verin. Bu bölməni ümumi problemlərin və onların həll yollarının siyahısı kimi təşkil edə bilərsiniz. Oxşar problemləri məntiqi bir başlıq altında qruplaşdırın. Bu şəkildə istifadəçilər xüsusi problemləri tez bir zamanda tapa bilərlər.
    • Məsələn, kompüterin mavi ekran göstərməsi ilə bağlı bir neçə problem varsa, onları "Ümumi ekran problemləri" kimi alt başlıq altında qruplaşdırın.
    • Bu bölməyə müştəri xidməti üçün bir telefon nömrəsi və / və ya e-poçt daxil etməlisiniz.

4-cü hissə 4: Oxunaqlı bir təlimat yazın

  1. Digər istifadəçi təlimatlarını oxuyun. Öz məhsulunuz üçün bir təlimat yazmazdan əvvəl digər effektiv istifadəçi təlimatlarına baxın. Quruluşa, söz seçiminə və cümlə quruluşuna diqqət yetirin. Apple, Google və Microsoft kimi əsas markalar, daha düşünülmüş bir istifadəçi təlimatı hazırlamağınıza kömək edəcək güclü, təsirli istifadəçi təlimatları istehsal edir.
    • Yalnız oxumayın hamısı istifadəçi təlimatları. Satdığınız oxşar məhsullar üçün təlimatları oxuyun. Məsələn, körpə məhsulları satırsınızsa, texniki deyil, körpə təlimatlarını oxuyun.
  2. Standartlarınızı seçin. Yazı, söz seçimi və ifadələrin standartlaşdırılması istifadəçi təlimatını daha rahat istifadə edəcəkdir. Chicago Style Manual və Microsoft Manual Style Manual da istifadəçi kitabçanızı yazarkən faydalı stil bələdçiləri ola bilər; birinin təlimat üçün uyğun olub olmadığını yoxlamaq üçün hər ikisini yoxlayın.
    • Məsələn, təlimatınızdakı "güc açarı" və "güc düyməsini" istifadə etmək əvəzinə, iki şərtdən birini seçin və ona əməl edin.
  3. Aktiv səsi istifadə edin. Aktiv səs, istifadəçi nöqteyi-nəzərindən izah edən bir yazı üsuludur. Mövzunun təyin olunmadığı alternativdən, passiv səsdən daha asan başa düşülür.
    • Yazınızdakı passiv keçidləri müəyyənləşdirmək üçün Hemingway Tətbiqini (www.hemmingwayapp.com) sınayın.
    • Bu iki nümunə cümləni öyrənin - birincisi aktivdir, ikincisi passivdir:
      • Paketi yavaşca və diqqətlə açmalısınız.
      • Paket yavaş və diqqətlə açılmalıdır.
  4. Nömrəli təlimatları yazın. Sayısal sifarişli təlimatlar, oxucunun sözügedən məhsulun istifadəsi, bağlanması və ya qurulması prosesinə daha yaxşı diqqət yetirməsinə kömək edir. Uzun, açıq bir abzas və ya bir sıra nömrəsiz abzaslar yazmaq əvəzinə, istifadəçi təlimatınızı hər biri dəqiq nömrələnmiş sadə, açıq addımlarla yazın.
  5. Hər addımı bir əmrlə başlayın. İmperativ hərəkətə yönəlmiş bir feldir. Hər addımı bir fellə başlayaraq, oxucuya bu addımı tamamlamaq üçün lazım olan hərəkət barədə bir ipucu verirsiniz. Məsələn, yazdığınız məhsuldan asılı olaraq addımlarınızı "Bağlan", "Təsdiq et" və ya "Slayd" kimi bir əmrlə başlaya bilərsiniz. Bununla birlikdə, sistemdən gələn cavab ilə addımlarınızı başlamayın.
    • Məsələn, ekran mavi olur və yanıb-sönməyə başlayırsa, addımı ilə başlamayın: "Ekran yanıb-sönəcək və mavi rəngə çevriləcək." Sınayın: "Ev düyməsini basıb saxlayın. Ekran yanıb-sönəcək və mavi rəngə çevriləcək. "
  6. Hansı lüğətdən istifadə edəcəyinizi müəyyənləşdirin. Bir yo-yo təlimatı yazırsınızsa, auditoriyanız əsasən gənc uşaqlar olacaq. Yo-yo-nun necə işlədiyini izah etmək üçün sadə sözlərdən və lüğətdən istifadə edin. Tarama elektron mikroskopu təlimatı yazarkən auditoriyanız çox ətraflı məlumatı anlaya bilən yüksək bacarıqlı alimlərdən ibarətdir, buna görə ixtisaslaşdırılmış lüğət və ya nüanslı izahlardan istifadə etməkdən çəkinməyin.
    • Ümumiyyətlə, jarqon və texniki dildən yayınmağa çalışırsınız.
    • Mümkün qədər geniş istifadəçi bazası üçün təsirli olmaq üçün, ibtidai məktəbin altıncı ilə yeddinci sinifləri arasında bir səviyyədə yazmağa çalışın.
  7. Xaricə bir məhsul göndərərkən tərcümələrinizin dəqiq olduğundan əmin olun. İstifadəçi təlimatınızı məhsulunuzu göndərdiyiniz ölkənin ana dilinə tərcümə etmək üçün tərcüməçi işə götürün. Onlayn tərcümə proqramından da istifadə edə bilərsiniz, ancaq anadili birindən tərcüməni oxumasını və səhvlərin olub olmadığını yoxlamasını xahiş edin.
    • Bir çox dil qrupu auditoriyanızda təmsil olunursa, istifadə kitabçasının hər bir uyğun dildə tərcümələrini daxil edin.
    • Tərcüməçi məhsul ilə tanış olmalıdır, çünki sözdən-sözə tərcümə olmayan xüsusi terminlər üçün hədəf dildə fərqli sözlər ola bilər.
  8. Qısa cümlələrlə yazın. Bir neçə uzun abzas əvəzinə bir çox qısa abzasdan istifadə edirsiniz. Hər bölmədə məntiqi fasilələrə baxın və faydalı məlumatları bir və ya iki cümləlik hissələrə bölün. Eyni cümlə səviyyəsində də belədir. Cümlələrinizi uzun və açıq deyil, qısa və sadə saxlayın.
    • Bir addım çox uzanırsa, onu daha kiçik addımlara ayırın. Bu söz sayını azaltmayacaq, ancaq sətir araları oxumağı asanlaşdıracaq.
  9. Səhvlər üçün təlimatı yoxlayın. Bir dərslik qrammatika və yazım səhvləri səbəbindən etibarlılığını itirə bilər. Bir həmkarınızdan və ya texniki yazıçıdan təlimatı redaktə edib düzəldin. Yazı və qrammatika ilə yanaşı, korrektor aşağıdakılara da diqqət yetirməlidir:
    • Pasif səs
    • Dəqiq olmayan və ya qarışıq bir dil
    • Sarılmış cümlə quruluşu
    • Həddindən artıq paraqraflar

Göstərişlər

  • İnsanlar müxtəlif yollarla öyrənirlər; Mümkün və uyğun olarsa, vizual yönümlü oxucuları yerləşdirmək üçün dərslikdə əyani vəsaitləri və ya onlayn videoların linklərini daxil edin.