آموزش نگارش فنی: راهنماهای شروع سریع

مقدمه Introduction

• خوش آمدی Welcome

1. مؤلفه های راهنمای Quickstart 1. Components of a Quickstart Guide

• بدانید آنچه شما می خواهید راهنما باشد Know what you want the guide to accomplish

• مراحل لیست: توالی یا کارهای جداگانه؟ List steps: Sequence or separate tasks?

• تصاویری را در راهنمای سریع خود وارد کنید Incorporate visuals into your quickstart guide

2. چگونه راهنمای Quickstart خود را توسعه دهید 2. How to Develop Your Quickstart Guide

• راهنمای سریع خود را در کتابچه راهنمای کاربر خود پایه کنید Base your quickstart guide on your user manual

• راهنمای سریع استارت را در مورد ورودی کاربران قرار دهید Base your quickstart guide on input from users

3. بهترین روش های نوشتن برای راهنمای Quickstart 3. Best Writing Practices for a Quickstart Guide

• به طور مستقیم به کاربر خود آدرس دهید Address your user directly

• با توضیح نتیجه ، هدف کلی راهنمای را مشخص کنید Identify the overall purpose of the guide by explaining the outcome

• عناوین واضح را بنویسید Write clear headings

• هر مرحله را با یک فعل شروع کنید Begin each step with a verb

• زمینه یا یادداشت ها را قبل از مراحل ارائه دهید ، نه در درون آنها Provide context or notes before steps, not within them

• از زبان ساده استفاده کنید Use plain language

• از قالب بندی مداوم استفاده کنید Use consistent formatting

• چالش: یک راهنمای سریع برنامه را مرور کنید Challenge: Revise a quickstart guide

• راه حل: راهنمای سریع برنامه را مرور کنید Solution: Revise a quickstart guide

4- راهنمای دقیق Quickstart خود را برای صحت و کاربردی بودن بررسی کنید 4. Check Your Quickstart Guide for Accuracy and Usefulness

• از یک متخصص موضوع موضوع بخواهید که راهنمای سریع خود را مرور کند Ask a subject matter expert to review your quickstart guide

• از کاربران بخواهید که راهنمای سریع شما را مرور کنند Ask users to review your quickstart guide

نتیجه Conclusion

• مراحل بعدی Next steps