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