محتوا

• گام برداشتن
• قسمت 1 از 4: برنامه ریزی کتابچه راهنمای مالک خود
• قسمت 2 از 4: اطلاعات ضروری را وارد کنید
• قسمت 3 از 4: توصیف نگهداری محصول
• قسمت 4 از 4: یک کتابچه راهنمای قابل خواندن بنویسید
• نکات

نرم افزار ، رایانه ، بازی و دستگاه به دفترچه راهنمای کاربر احتیاج دارند. راهنماهایی در مورد چگونگی استفاده از محصول (و چگونگی عدم استفاده). کتابچه راهنمای کاربر یک سند رسمی با ساختار خاص است و باید توسط کسی که محصول را از داخل می داند مانند یک نویسنده فنی یا طراح محصول نوشته شود. نوشتن یک کتابچه راهنمای کاربر موثر مستلزم این است که شما بدانید چه کسی از این محصول استفاده می کند و این کتابچه را با در نظر داشتن این کاربران بنویسید. برای اطمینان از تجربه کاربری بدون دردسر ، نوشتار خود را واضح ، دقیق و ساده نگه دارید.

گام برداشتن

قسمت 1 از 4: برنامه ریزی کتابچه راهنمای مالک خود

1. آنالیز کاربر را انجام دهید. کتابچه راهنمای کاربر باید برای کاربران نوشته شده باشد - کسانی که محصول یا خدمات شما را خریداری می کنند و کتابچه راهنمای کاربر را می خوانند. تجزیه و تحلیل کاربر به شما می گوید که مخاطب اصلی یا هدف شما چه کسانی خواهد بود و شما را از طریق نوشتن متن راهنمایی می کند.
   • با افرادی که از دستگاه شما استفاده می کنند صحبت کنید. نمونه های اولیه دستگاه و پیش نویس کتابچه راهنمای کاربر را در شرایط کنترل شده به کاربران تست ارائه دهید. از این کاربران آزمایشی در مورد راهنمای کاربر نامشخص یا گیج کننده بازخورد بخواهید و براساس این بازخورد تغییراتی در راهنمای کاربر ایجاد کنید.
   • شما هرگز نمی توانید تمام مخاطبان خود را راضی کنید. کتابچه راهنمای متناسب با مخاطب هدف یا بیشترین مخاطب را بنویسید.
   • سن ، سلامتی (آیا آنها بیماری ، اختلالات یادگیری یا نقص دارند؟) و سطح تحصیلات مخاطبان را برای تعیین بهترین روش برای نوشتن کتابچه راهنمای کاربر در نظر بگیرید.
2. طراحی کتابچه راهنمای کاربر را هماهنگ کنید. اگر شما عضوی از تیم بودید که به طراحی و توسعه دستگاه یا محصول کمک کرده اید ، نگاهی عینی به محصول برای توضیح چگونگی عملکرد آن دشوار است. بنابراین باید از نویسندگان (ترجیحاً کسی که تجربه نوشتن مقاله را دارد) و یک طراح گرافیک برای کمک به شما در تهیه راهنمای کاربر ، مشاوره بگیرید. می توانید این افراد را از طریق مشاوره خارجی یا از طرف شرکت یا سازمان خود انتخاب کنید.
3. تجزیه و تحلیل وظیفه انجام دهید. تجزیه و تحلیل شغل فرآیند شناسایی و سازماندهی مراحل مورد نیاز برای استفاده از دستگاه است. با تجزیه و تحلیل دقیق شغل ، مواد و تجهیزات (مانند باتری ، دارو یا سایر محصولات تهیه شده توسط کاربر) مورد نیاز برای هر مرحله مشخص می شود ، همچنین اقدامات ، خطاها و مشاوره عیب یابی که ممکن است هر مرحله نیاز داشته باشد.
   • اگر محصولی دارید که می تواند کارهای مختلف یا کارهای فرعی را انجام دهد ، باید تجزیه و تحلیل وظایف را برای هر کار انجام دهید. به عنوان مثال: در اتومبیل می توانید بوق بزنید ، خود را بند بزنید و چراغهای جلو را روشن یا خاموش کنید. در صورت لزوم برای هر یک از آنها تجزیه و تحلیل شغل ایجاد کنید.
4. مطمئن شوید که محصول شما شرایط لازم برای برچسب گذاری و مجوز بازاریابی را دارد. این الزامات اطمینان می دهد که محصولات با رعایت ایمنی کاربر تولید می شوند و قرار گرفتن کاربر در معرض شرایط خطرناک مانند تابش و برق گرفتگی محدود است. در تبلیغات باید هدف و دستورالعمل های اساسی عملکرد یک محصول به وضوح ذکر شود و هنگام نوشتن کتابچه راهنمای مالک خود باید از این منابع استفاده کنید.
   • برای اینکه کتابچه راهنمای کاربر یک محصول موثر باشد ، باید مطابق با برچسب هایی که مستقیماً روی محصول چسبیده اند ، نوشته شود.
   • قبل از نوشتن کتابچه راهنمای کاربر ، اطمینان حاصل کنید که دستگاه شما به طور رسمی مجوز فروش دارد.
5. در مورد چیدمان دفترچه راهنما تصمیم بگیرید. چندین روش مهم وجود دارد که می توانید کتابچه راهنمای خود را ساده کنید. شما باید در ابتدای هر بخش یک عنوان پررنگ با هر کلمه با حروف بزرگ قرار دهید. به عنوان مثال ، "دستگاه خود را راه اندازی کنید" ، "دستگاه خود را کار کنید" و "عیب یابی" همه می توانند عنوان بخشهای پررنگ باشند.
   • روش دیگر ساده سازی راهنمای شما استفاده از دو ستون است ، یکی در سمت راست با متن و دیگری در سمت چپ متن ، با گلوله ها ، اعداد یا آیکون های کوچک ، مانند علائم هشدار دهنده یا علامت تعجب قرمز.
   • این کتابچه راهنما ممکن است به طور عمده از تصاویر با برخی متن ها در زیر هر تصویر برای توضیح دستگاه باشد ، یا ممکن است به طور عمده متن فقط با چند تصویر همراه باشد. برای راهنمایی کاربر می توانید از فلوچارت نیز استفاده کنید. به محصول خود و اینکه هر روش چگونه می تواند به شما در نوشتن کتابچه راهنما کمک کند ، فکر کنید. با این حال ، از ترکیب طرح های مختلف در یک کتابچه راهنما خودداری کنید. یکی را انتخاب کنید و با آن بچسبانید.

قسمت 2 از 4: اطلاعات ضروری را وارد کنید

1. راهنما را به صورت منطقی تنظیم کنید. ساختار این کتابچه راهنما باید به گونه ای باشد که کاربر بیشترین سود را از آن ببرد. دفترچه راهنما را به فصل یا بخشهایی تقسیم کنید که استفاده از محصول منطقی است و در قسمت جلوی کتابچه راهنما شامل یک لیست از مطالب است تا هر بخش به سرعت پیدا شود.
   • فهرست مطالب مخصوصاً برای کتابچه های راهنمای طولانی تر ضروری است.
   • اگر اصطلاحات زیادی برای توضیح وجود داشته باشد که مخاطبان شما با آنها آشنا نیستند ، به یک واژه نامه یا فهرست نیاز دارید. با این حال ، واژه نامه توصیه نمی شود. بهترین انتخاب توضیح اصطلاحات گیج کننده در متن خود کتابچه راهنما است. اگر می خواهید یک واژه نامه اضافه کنید ، آن را در جلوی کتابچه راهنما ، درست بعد از فهرست مطالب قرار دهید.
   • لیستی از جدولها یا شکلها فقط در صورت وجود بیش از چند جدول یا شکل در کتابچه راهنما لازم است.
   • برای مواردی که باید توضیح داده شوند ، اما در جای دیگر کتابچه راهنما قابل توضیح نیستند ، پیوست لازم است ، زیرا باعث اختلال در جریان و تمرکز می شود.
2. هشدارهای لازم را وارد کنید. هشدارهای عمومی یا اطلاعات احتیاطی باید اطلاعاتی در مورد خطرات احتمالی ناشی از استفاده نادرست از محصول ، از جمله مرگ یا آسیب جدی داشته باشد. این هشدارها باید در جلوی کتابچه راهنمای کاربر ، بعد از صفحه اول قرار گیرد ، تا کاربر ابتدا آنها را ببیند. هشدارهای خاص نیز باید دقیقاً پس از آن یا درست قبل از پیشنهاد یک مرحله بالقوه خطرناک در متن کتابچه راهنما موجود باشد.
   • به عنوان مثال ، یک هشدار عمومی برای یک وسیله الکتریکی می تواند عدم استفاده از آن در هنگام بارندگی باشد.
   • یک دستورالعمل خاص می تواند این باشد که قبل از اتصال دستگاه به پریز برق ، از خشک بودن دست و دستگاه اطمینان حاصل کنید.
   • تصاویری (مانند جمجمه و استخوان های ضربدری) یا متنی با رنگ متفاوت (مانند متن قرمز) تهیه کنید تا هشدار را از بقیه جهت ها در IFU متمایز کرده و توجه کاربران را به آن جلب کنید.
3. دستگاه را توصیف کنید. توضیحات شما باید شامل یک توضیح کتبی درباره هدف دستگاه و یک نمایش گرافیکی کوچک از شکل ظاهری دستگاه باشد. شکل باید تمام سوئیچ ها ، دکمه ها و قسمت های قابل اتصال موجود در دستگاه را برچسب گذاری و نامگذاری کند.
4. دستورالعمل نصب را ارائه دهید. بخش نصب باید حاوی اطلاعات اساسی در مورد نحوه آماده سازی برای استفاده از محصول یا دستگاه باشد. اگر دستگاه توسط یک کاربر خانگی ساخته یا راه اندازی نشده است ، این را به وضوح با یک عنوان پررنگ در بالای قسمت نصب بیان کنید. شما همچنین باید موارد زیر را وارد کنید:
   • لیست قطعات
   • دستورالعملهای بسته بندی
   • هشدارهای نصب
   • عواقب نصب نادرست
   • در صورت نصب هنگام نصب ، با چه کسی تماس بگیرید
5. اطلاعات مربوط به عملیات را ارائه دهید. این بخش مهمترین قسمت کتابچه راهنمای کاربر است و باید اطلاعات دقیق و دقیق در مورد نحوه استفاده از دستگاه را ارائه دهد. با آماده سازی اساسی برای استفاده از واحد ، مانند اتصال به سیم برق یا شستن دست ها ، شروع کنید. با مراحل منطقی و شماره دار نحوه استفاده از دستگاه و همچنین هر گونه بازخورد (به عنوان مثال "شما یک کلیک خواهید شنید ...") که کاربر می تواند هنگام استفاده صحیح از دستگاه انتظار داشته باشد ، ادامه دهید.
   • در پایان این فصل ، کاربران باید به بخش عیب یابی برای حل مشکلاتی که به سرعت قابل توضیح نیستند ، مراجعه کنند.
   • تصاویر را در صورت لزوم قرار دهید. برخی از مراحل به بهترین شکل با تصاویر و کلمات توضیح داده می شوند. استفاده از عکس ها یا تصاویر را در کتابچه راهنمای خود در نظر بگیرید.
   • در این بخش ، مانند هر بخش ، باید هشدارهای ایمنی مربوط به استفاده یا عملکرد نامناسب را در آن بگنجانید. به عنوان مثال ، می توانید به کاربران اره برقی هشدار دهید که در حین استفاده از داروهای خاص ، الکل مصرف نکنند و از اره برقی استفاده نکنند.
   • اگر فکر می کنید کاربران از مزایایی بهره مند می شوند ، پیوند به فیلم های آنلاین را نشان دهید که نشانگر استفاده و عملکرد صحیح دستگاه است. می توانید این فیلم ها را در ابتدای این بخش ضبط کنید ، یا (در مورد فیلم هایی که فقط یک مرحله را نشان می دهند) در انتهای هر مرحله ضبط کنید.
6. در انتها خلاصه ای از محصول را وارد کنید. خلاصه باید در انتهای کتابچه راهنمای کاربر ، درست قبل از فهرست ، برای ارائه مراحل اساسی کار وجود داشته باشد. این باید یک نسخه ساده و محروم از اطلاعات عملیاتی باشد و نباید بیش از یک صفحه باشد. خلاصه نحوه استفاده از دستگاه یا محصول را بیان کنید. هشدارهای اساسی ، مراحل شماره گذاری شده که نحوه استفاده از محصول را توضیح می دهد ، و شماره تلفن ها یا آدرس های ایمیل که کاربران را به کمک راهنمایی می کند ، شامل کنید.
   • اگر انتظار دارید کاربر مرتباً برگه خلاصه را حذف یا به آن مراجعه کند ، می توانید آن را بر روی یک کارت لمینت قابل جابجایی یا مقوای ضخیم چاپ کنید تا حمل و مراجعه به کاربر را آسان تر کند.
   • متناوباً ، می توانید خلاصه ای را مستقیماً روی محصول اعمال کنید تا کاربر سریع و آسان به آن مراجعه کند.

قسمت 3 از 4: توصیف نگهداری محصول

1. نحوه تمیز کردن دستگاه را توضیح دهید. اگر دستگاه یا محصول شما نیاز به تمیز کردن دارد ، نحوه انجام این کار را توضیح دهید. عوامل تمیز کننده مورد نیاز را لیست کنید. به خواننده بگویید که چند بار باید تمیز کند. سپس ، همانند سایر قسمت های راهنما ، دستورالعمل های گام به گام شماره ای در مورد نحوه تمیز کردن آن را وارد کنید.
   • اگر تمیز کردن مستلزم جدا شدن محصول یا جدا شدن قطعه یا قطعات خاصی است ، نحوه جدا شدن محصول را مشخص کنید.
   • در مورد نتایج عدم تمیز کردن دستگاه هشدار دهید. به عنوان مثال ، می توانید بگویید ، "اگر دستگاه تمیز نشود ، عملکرد کمتر از حد مطلوب است."
2. نحوه انجام تعمیرات اساسی کاربر را حساب کنید. اگر محصول یا دستگاه برای اصلاح مشکلات عملکرد توسط کاربر قابل استفاده است ، دستورالعمل های شماره ای در مورد چگونگی انجام این کار برای کاربر ارائه دهید. به عنوان مثال ، اگر باتری ها پس از هر 300 ساعت استفاده نیاز به تعویض دارند ، دستورالعمل هایی در مورد چگونگی بررسی نیاز به تعویض باتری ها ، نحوه حذف باتری های مرده و نحوه نصب باتری های جدید ارائه دهید.
   • اگر کارهای تعمیر و نگهداری خاصی وجود دارد که فقط توسط یک تکنسین مجاز می تواند انجام شود ، قسمت نگهداری کتابچه راهنما را به دو قسمت تقسیم کنید.
3. درباره گزینه های ذخیره سازی بحث کنید. در صورت لزوم ، کتابچه راهنما باید نحوه نگهداری صحیح محصول یا دستگاه را توضیح دهد. شما همچنین باید اطلاعاتی در مورد ضرورت ذخیره سازی و عواقب ذخیره نامناسب در آن بگنجانید. به عنوان مثال: می توانید بنویسید:
   • محصول را در جای خشک و خنک نگهداری کنید. ذخیره نامناسب می تواند باعث کاهش عمر محصول شما به دلیل تجمع رطوبت شود. "
   • "محصول را در معرض حرارت قرار ندهید و آن را در دمای بالاتر از 50 درجه سانتیگراد ذخیره نکنید.اگر این کار را انجام دهید ، می تواند منجر به احتراق شود. "
4. اطلاعات عیب یابی را ارائه دهید. می توانید این بخش را به عنوان لیستی از مشکلات رایج و راه حل های آنها سازماندهی کنید. مشکلات مشابه را تحت عنوان منطقی گروه بندی کنید. به این ترتیب ، کاربران می توانند به سرعت مشکلات خاصی را پیدا کنند.
   • به عنوان مثال ، اگر چندین رایانه در نمایش صفحه آبی با رایانه وجود دارد ، آنها را تحت عنوان زیر عنوان کنید: "مشکلات معمول صفحه".
   • همچنین باید در این بخش شماره تلفن و / یا ایمیل برای خدمات مشتری درج کنید.

قسمت 4 از 4: یک کتابچه راهنمای قابل خواندن بنویسید

1. سایر راهنماهای کاربر را بخوانید. قبل از نوشتن کتابچه راهنمای محصول خود ، سایر راهنماهای موثر کاربر را بررسی کنید. به ساختار ، انتخاب کلمه و ساختار جمله توجه کنید. مارک های بزرگی مانند اپل ، گوگل و مایکروسافت راهنماهای کاربر قوی و موثری را ارائه می دهند که می توانند به شما کمک کنند تا راهنمای کاربری متفکرانه تری داشته باشید.
   • فقط نخوان همه راهنمای کاربر کتابچه های راهنمای محصولات مشابهی را که می فروشید بخوانید. به عنوان مثال ، اگر کالاهای کودک را می فروشید ، کتابچه های راهنمای کودک را بخوانید ، نه دستورالعمل های فنی.
2. استانداردهای خود را انتخاب کنید. استاندارد سازی هجی ، انتخاب کلمه و عبارت ، کتابچه راهنمای کاربر را برای کاربر پسندتر می کند. راهنمای سبک شیکاگو و کتابچه راهنمای سبک مایکروسافت همچنین می توانند راهنمای سبک در هنگام نوشتن کتابچه راهنمای مالک شما باشند. هر دو را بررسی کنید تا ببینید آیا کتابچه راهنمای شما مناسب است یا خیر.
   • به عنوان مثال ، به جای استفاده از هر دو "کلید روشن" و "دکمه پاور" در کتابچه راهنمای خود ، یکی از این دو اصطلاح را انتخاب کنید و به آن پایبند باشید.
3. از صدای فعال استفاده کنید. صدای فعال روشی برای نوشتن است که همه چیز را از دید کاربر توضیح می دهد. درک آن از صدای جایگزین ، صدای منفعل ، که موضوع در آن تعریف نشده است ، آسان تر است.
   • برنامه Hemingway (www.hemmingwayapp.com) را امتحان کنید تا مقالات منفعل را در متن خود شناسایی کنید.
   • این دو جمله را مطالعه کنید - اولین جمله فعال است و دوم منفعل است:
     • شما باید بسته را به آرامی و با دقت باز کنید.
     • بسته باید به آرامی و با دقت باز شود.
4. دستورالعمل های شماره گذاری شده را بنویسید. دستورالعمل هایی که به صورت عددی مرتب شده اند ، به خواننده کمک می کنند تا روی فرآیند استفاده ، اتصال یا ساخت محصول مورد نظر بهتر تمرکز کند. به جای نوشتن یک پاراگراف پر حرف ، یا مجموعه ای از پاراگراف های بدون شماره ، راهنمای کاربر خود را با مراحل ساده و صریح بنویسید که هر کدام به طور واضح شماره گذاری شده اند.
5. هر مرحله را با یک ضرورت شروع کنید. امر ضروری فعل عمل محور است. با شروع هر مرحله با یک فعل ، به خواننده نکته ای در مورد عملکرد مورد نیاز برای تکمیل مرحله می دهید. به عنوان مثال ، بسته به محصولی که در مورد آن می نویسید ، می توانید مراحل خود را با دستوری مانند "اتصال" ، "تأیید" یا "اسلاید" شروع کنید. با این حال ، مراحل خود را با پاسخ سیستم شروع نکنید.
   • به عنوان مثال ، اگر صفحه آبی رنگ شد و شروع به چشمک زدن کرد ، مرحله را با این مرحله شروع نکنید: "صفحه چشمک می زند و آبی می شود." سعی کنید: "کلید خانه را فشار دهید و نگه دارید. صفحه چشمک می زند و آبی می شود. "
6. مشخص کنید از کدام واژگان استفاده می کنید. اگر در حال نوشتن یک کتابچه راهنمای یو هستید ، مخاطبان شما بیشتر کودکان خردسال خواهند بود. برای توضیح چگونگی عملکرد یویو از کلمات و واژگان ساده استفاده کنید. هنگامی که در حال نوشتن یک کتابچه راهنمای میکروسکوپ الکترونی روبشی هستید ، مخاطبان شما را دانشمندان بسیار ماهری تشکیل می دهند که می توانند اطلاعات بسیار مفصلی را درک کنند ، بنابراین از استفاده از واژگان تخصصی یا توضیحات ظریف دریغ نکنید.
   • به طور کلی ، شما سعی می کنید از اصطلاحات اصطلاحی و زبان فنی خودداری کنید.
   • برای اینکه برای گسترده ترین پایگاه کاربری موثر باشید ، سعی کنید در سطحی از کلاس ششم تا هفتم دبستان بنویسید.
7. هنگام حمل کالایی به خارج از کشور ، از صحت ترجمه های خود اطمینان حاصل کنید. مترجمی را استخدام کنید تا کتابچه راهنمای کاربر خود را به زبان مادری کشوری که محصول خود را به آنجا حمل می کنید ترجمه کند. شما همچنین می توانید از یک برنامه ترجمه آنلاین استفاده کنید ، اما از یک سخنران بومی بخواهید ترجمه را بخواند و خطاها را بررسی کند.
   • اگر چندین گروه زبان در مخاطبان شما نشان داده شده است ، لطفاً ترجمه کتابچه راهنمای کاربر را به هر زبان مربوطه وارد کنید.
   • مترجم باید با این محصول آشنا باشد زیرا ممکن است کلمات مختلفی در زبان مقصد برای اصطلاحات خاص وجود داشته باشد که ترجمه کلمه به کلمه نباشد.
8. با جملات کوتاه بنویسید. به جای چند پاراگراف طولانی ، شما از تعداد زیادی پاراگراف کوتاه استفاده می کنید. در هر بخش به دنبال وقفه های منطقی باشید و اطلاعات مفید را در تکه های یک یا دو جمله هضم کنید. در سطح جمله نیز همین طور است. جملات خود را به جای طولانی و پر حرف ، کوتاه و ساده نگه دارید.
   • اگر مرحله ای طولانی شد ، آن را به مراحل کوچکتر تقسیم کنید. این تعداد کلمات را کاهش نمی دهد ، اما خط شکسته ها خواندن را آسان تر می کند.
9. کتابچه راهنما را از نظر خطا بررسی کنید. یک کتابچه راهنما می تواند اعتبار خود را به دلیل دستور زبان و اشتباهات املایی از دست بدهد. همچنین از یک همکار یا نویسنده فنی بخواهید کتابچه راهنما را ویرایش و تصحیح کند. علاوه بر هجی و دستور زبان ، تصحیح کننده باید به موارد زیر توجه کند:
   • صدای منفعل
   • زبانی نامشخص یا گیج کننده است
   • ساختار جمله پیچیده
   • پاراگراف های بیش از حد طولانی

نکات

• مردم به روش های مختلف یاد می گیرند. در صورت امکان و مناسب ، ابزارهای دیداری یا پیوند به فیلمهای آنلاین را در کتابچه راهنما بگنجانید تا خوانندگان بصری را در خود جای دهید.