مراحل نوشتن قسمت 1: صدا و سبک

اول از همه، بیایید ببینیم که یک رویه چیست. رویه یک متن است که توصیه های گام به گام در مورد نحوه انجام یک کار ارائه می دهد. هدف اصلی یک روش این است که به کاربر بگوید چگونه به یک نتیجه خاص دست یابد. بنابراین، یک رویه باید دارای موارد زیر باشد:

  1. وظیفه به وضوح بیان شده است.

  2. نتیجه به وضوح بیان شده (یا چندین نتیجه).

  3. مراحل واضح و قابل دستیابی

  4. سبک منسجم

رویه ها ممکن است بزرگترین بخش سند شما را تشکیل دهند. من وظیفه نوشتن یک رویه را شرح خواهم داد.

نکته مهم

بیایید فقط رویه های متن را در این مقاله مرور کنیم. در بسیاری از موارد، یک نویسنده فنی خلاق از استفاده از یک اسکرین شات یا یک ویدیوی کوتاه برای نشان دادن نحوه انجام کاری به کاربر بسیار خوشحال خواهد شد. استفاده از رسانه بعداً مورد بحث قرار خواهد گرفت.

صدا

از آنجایی که این رویه مجموعه ای از مراحل است که به کاربر دستور انجام کاری را می دهد، باید با صدایی دوستانه و حمایت کننده نوشته شود. با این حال، به انتخاب لحن صدا توجه داشته باشید: گاهی اوقات، اگر لازم است توجه کاربر را به اطلاعات مهم جلب کنید، باید لحن را به قاطعیت و قوی تر تغییر دهید. به عنوان مثال، این می تواند در هنگام دادن یادداشت یا هشدار استفاده شود.

توجه: از صدای قوی فقط برای هشدار دادن به کاربر یا توصیف عواقب آن استفاده کنید. برای جلب توجه کاربر به موارد مهم باید قابل توجه باقی بماند…

Source link