نویسندگان متخصص از روش های مختلفی برای سند گذاری مانند راهنمای دستی کاربر، سند گذاری API، راهنمای عملی و غیر استفاده می‌کنند. در این مقاله به شما می آموزیم که چگونه به بهترین شیوه یک دستورالعمل عملی بنویسید.
برنامه ریزی نوشتن یک دستورالعمل
برای نوشتن دستورالعمل اولین اقدامی که باید انجام دهید برنامه ریزی برای آن است. جهت انجام این کار نکات زیر را در نظر داشته باشید:
مخاطب هدف خود را درک کنید
هنگام نوشتن دستورالعمل باید درک درستی از مخاطب هدف خود به دست آورید. متوسط سن آن‌ها چیست؟ سابقه آن‌ها کدام است؟ و غیره. با این کار می‌توانید سبک نگارش خود را اعم از پیچیدگی زبان، تعداد اصطلاحات قابل کاربرد و ویژگی های دیگر تعیین کنید.
در مورد فرایند تحقیق کنید
توصیه ما به شما این است که در ابتدا تجربه افراد در نوشتن دستورالعمل را مطالعه کنید. این کار باعث می‌شود تصویری روشن از کار خود به دست آورید و رویکردهای دیگران را در فرایند کار خود ادغام کنید.
ابزارهای مفید را گردآوری کنید
قبل از نگارش، اطلاعات و ابزارهای لازم را جمع آوری کنید. این کار می‌تواند شامل گردآوری اطلاعات اضافی در مورد محصول و یا جستجو برای دستورالعمل محصولات مشابه و یا غیره باشد.
چگونه یک دستورالعمل بنویسیم؟
همان‌طور که در مقاله mediom آمده است، پیش از هر چیز یک برنامه طراحی کنید. تجسم سازی روش خوبی برای شروع نگارش است. بعد از این کار نوبت به نوشتن می‌رسد. در این خصوص نکات زیر را همواره به یاد داشته باشید:
• به زبان صریح و ساده فارسی صحبت کنید.
• زبان شما باید دقیق باشد. به عنوان مثال، به جای اینکه بگویید «شما باید این گزینه را انتخاب کنید»، بنویسید «این گزینه را انتخاب کنید.»
• در صورتی که دستورالعمل دارای مراحل گام به گام است، آن را به صورت فهرست شماره دار طراحی کنید.
• از محتوای بصری مانند عکس، اسکرین شات و یا نمودار استفاده کنید.
• محتوای خود را به بخش های مجزا به همراه زیر عنوان تقسیم بندی کنید و هر قسمت را واضح و روشن توضیح دهید.
• گاهی اوقات می توانید از طنز استفاده کنید. اما مراقب باشید! ممکن است برخی افراد منظور شما را متوجه نشوند.
• از فهرست مطالب برای موضوعات طولانی استفاده کنید.
مهمترین نکته در نوشتن دستورالعمل رعایت اصول و قواعد گرامری و املایی است. برای این کار می‌توانید از یک نفر بخواهید تا متن شما را از لحاظ گرامری و املایی بررسی کند و یا اینکه می‌توانید گام‌ها را به صورت برعکس خوانده تا اطمینان یابید که راهنمای شما ساده و روشن است.
نکاتی که در این مقاله بیان کردیم شاید تمام نکات مربوط به نگارش دستورالعمل نباشد، اما مطمئن هستیم که این نکات جزء ضروری‌ترین نکات نگارش راهنما هستند. امیدواریم این نکات به شما کمک کرده باشد.
