آموزش راهنمای مربی جدید برای ایجاد اسناد کاربر نهایی

سرفصل ها و درس ها

مفاهیم فنی نگارش Technical Writing Concepts

• معرفی Introduction

• کاربران شما ناامید هستند Your Users are Frustrated

• مبانی مستندسازی Documentation Fundamentals

• سطح مخاطب خود را بشناسید Know your Audience's Level

• شناسایی و جلوگیری از ریختن داده ها Recognize and Avoid Data Dumping

• پاکسازی بهم ریختگی ذهنی Clearing Mental Clutter

• مثال های درهم ریختگی ذهنی Mental Clutter Examples

اقدامات کاربر: اصطلاحات و سبک User Actions: Terminology and Style

• زبان و سبک استاندارد Standard Language and Style

• ارجاع به دستورات Referencing Commands

• ارجاع به منوها و لیست ها Referencing Menus and Lists

• ارجاع به گزینه ها و ویندوز Referencing Options and Windows

• ارجاع دادن به کلیدها و عملکردهای تلفن Referencing Keys and Phone Actions

• مرور تمرین 01 Exercise 01 Review

اقدامات کاربر: قالب بندی و ساخت User Actions: Formatting and Construction

• قالب بندی بایدها و نبایدها Formatting Do's and Don'ts

• ساخت بیانیه اقدام کاربر Constructing the User Action Statement

• اصطلاحات و کلمات اختصاری Jargon and Acronyms

• شناسایی آیکون ها Identifying Icons

• مرور تمرین 02 Exercise 02 Review

دستورالعمل های ساختمانی: رویه ها و بررسی اجمالی Building Instructions: Procedures and Overview

• از یک ساختار مشترک استفاده کنید Use a Common Structure

• با یک عنوان واضح شروع کنید Start with a Clear Title

• یک افتتاحیه عالی فراهم کنید Provide a Great Opening

• یک کار را به رویه ها تقسیم کنید Break a Task into Procedures

• عنوان رویه و نمای کلی Procedure Title and Overview

• مرور تمرین 03 Exercise 03 Review

دستورالعمل ساختمان: مراحل Building Instructions: Steps

• مراحل مستندسازی Documenting Steps

• شناسایی مراحل Identifying Steps

• مراحل فرعی SubSteps

• مرور تمرین 04 Exercise 04 Review

• مراحل مشروط Conditional Steps

• مراحل جایگزین و اختیاری Alternative and Optional Steps

• مرور تمرین 05 Exercise 05 Review

• مدیریت ورودی کاربر Handling User Input

• ورودی کاربر - مراحل ایجاد User Input - Creating Steps

• مرور تمرین 06 Exercise 06 Review

• پیوند دادن به مراحل Linking To Steps

دستورالعمل ساختمان: اضافه کردن اطلاعات Building Instructions: Adding Information

• متمایز کردن اطلاعات از دستورالعمل ها Distuinguishing Information from Instructions

• اطلاعات در مورد یک مرحله - یادداشت ها Information About a Step - Notes

• اطلاعات قبل از یک مرحله Information Before a Step

• اطلاعات از سیستم Information From the System

• اطلاعات پس از یک قدم Infomation After a Step

• اطلاعاتی برای بهبود کارایی Information to Improve Efficiency

• مرور تمرین 07 Exercise 07 Review

خلاصه Summary

• بسته شدن Closing