نحوه ایجاد یک فایل راهنما: 10 مرحله (همراه با تصاویر)

فهرست مطالب:

نحوه ایجاد یک فایل راهنما: 10 مرحله (همراه با تصاویر)
نحوه ایجاد یک فایل راهنما: 10 مرحله (همراه با تصاویر)

تصویری: نحوه ایجاد یک فایل راهنما: 10 مرحله (همراه با تصاویر)

تصویری: نحوه ایجاد یک فایل راهنما: 10 مرحله (همراه با تصاویر)
تصویری: آموزش اسکن کردن سند یا عکس در ویندوز ۱۰ . Learn how to scan a document or photo in Windows 10 . 2024, مارس
Anonim

اگرچه اغلب توسط بسیاری از کاربران رایانه نادیده گرفته می شود ، فایل های راهنما اطلاعات کلیدی در مورد نحوه استفاده از نرم افزار مرتبط با آنها را ارائه می دهند. با کلیک روی "راهنما" ، یک کاربر می تواند نمای کلی از ویژگی های برنامه ، شرح صفحه ای را که در آن نگاه می کند ، دستورالعمل هایی در مورد نحوه استفاده از برنامه برای انجام یک کار مشخص یا خواندن لیست سوالات متداول در مورد برنامه دریافت کند. برنامه و پاسخ های آنها نوشتن یک فایل راهنما هم به توانایی کار با برنامه های نرم افزاری نیاز دارد و هم به توانایی توضیح موارد به نحوی که کاربران بتوانند درک کنند نیاز دارد.

مراحل

ایجاد یک فایل راهنما مرحله 1
ایجاد یک فایل راهنما مرحله 1

مرحله 1. یک کپی از نرم افزاری که قرار است مستند کنید دریافت کنید

در صورت امکان ، باید یک نسخه از مشخصات نوشته شده برنامه را نیز دریافت کنید ، اگرچه همه توسعه دهندگان نرم افزار با آنها کار نمی کنند. در برخی موارد ، برنامه نویس بر اساس زمان کوتاه توسعه یا عدم امکان کدگذاری یک ویژگی خاص ، از مشخصات منحرف می شود.

ایجاد یک فایل راهنما مرحله 2
ایجاد یک فایل راهنما مرحله 2

مرحله 2. یک ابزار نگارش راهنما دریافت کنید

در حالی که امکان ایجاد یک فایل راهنما با دست ، با استفاده از یک فایل با فرمت متنی غنی (.rtf) وجود دارد ، اکثر نویسندگان فایل راهنما از یک برنامه نرم افزاری برای نوشتن فایل های کمک خود مانند RoboHelp ، Help and Manual ، Doc-To استفاده می کنند. -Help ، MadCap Flare یا HelpLogix. اکثر ابزارهای نوشتن راهنما شامل ویرایشگر متن یا کار با برنامه پردازش کلمه مانند Microsoft Word و ارائه یک رابط کاربری است که به نویسنده کمک می کند تا هنگام نوشتن کد رایانه در پشت صحنه ، چگونه ظاهر می شود. تا فایل راهنما کار کند. برخی از ابزارهای نگارش راهنما همچنین شامل ویرایشگرهای گرافیکی برای ایجاد عکس از صفحه می شوند تا در فایل راهنما گنجانده شوند.

تعدادی فرمت فایل Help وجود دارد: رایج ترین آنها HTML Help است که توسط برنامه هایی که در ویندوز اجرا می شوند استفاده می شود. (قالب قدیمی تر ، WinHelp ، دیگر پشتیبانی نمی شود.) اپل و یونیکس هرکدام ، مانند Sun Microsystems ، با JavaHelp خود دارای فرمت های خاص خود هستند. برنامه های کاربردی نرم افزاری که برای اجرا در چندین سیستم عامل طراحی شده اند ممکن است از یک سیستم کمک چند پلتفرمی استفاده کنند که در مرورگر وب کاربر اجرا می شود. هر کدام از ابزارهای نویسندگی راهنمایی که استفاده می کنید باید از قالب (های) راهنمایی که قصد ایجاد فایل های راهنما را دارید پشتیبانی کند

ایجاد یک فایل راهنما مرحله 3
ایجاد یک فایل راهنما مرحله 3

مرحله 3. فایل پروژه راهنما را ایجاد کنید

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

  • فایل محتویات شامل متن موجود در فایل راهنما است که نحوه عملکرد نرم افزار موردنظر شما را توضیح می دهد. متن معمولاً به موضوعاتی تقسیم می شود که صفحه ، ویژگی یا روال خاصی را پوشش می دهد.
  • فایل فهرست فهرستی از موضوعات فایل راهنما است. از آن برای ایجاد یک فهرست مطالب استفاده می شود که کاربران می توانند برای انتخاب موضوع مورد نظر و همچنین فهرست قابل جستجو در فایل راهنما استفاده کنند.
  • فایل های تصویری فایل های گرافیکی از صفحه نمایش برنامه ها یا بخشی از آن صفحه هایی هستند که درون فایل راهنما نمایش داده می شوند تا توانایی کاربران را در درک آنچه که فایل فایل راهنما به آن اشاره می کند ، افزایش دهند.
ایجاد یک فایل راهنما مرحله 4
ایجاد یک فایل راهنما مرحله 4

مرحله 4. اندازه پنجره راهنما را تنظیم کنید

مگر اینکه فایل راهنما را بنویسید تا در مرورگر وب کاربر ظاهر شود ، فایل راهنما در پنجره خود ظاهر می شود. ابزار نوشتن راهنمای شما به شما امکان می دهد تا ابعاد افقی و عمودی پنجره را به اندازه ای تنظیم کنید که به کاربر نهایی اجازه دهد فایل راهنما را بخواند بدون اینکه مانعی از خود برنامه باشد. پنجره اصلی راهنما غالباً در قالب سه صفحه است ، با فهرست مطالب در سمت چپ و موضوع انتخاب شده در سمت راست.

فایل های راهنما همچنین می توانند علاوه بر پنجره اصلی ، پنجره های ثانویه ای نیز داشته باشند که ویژگی خاصی را با جزئیات شرح داده و اندازه پنجره های بازشو را به طور خودکار اندازه گیری کرده و توضیحات کوتاهی از ویژگی ها ارائه دهند. فایلهای راهنما همچنین می توانند شامل متن جاسازی شده ای باشند که تنها زمانی روی متن برجسته یا روی دکمه ای کلیک می شود

ایجاد یک فایل راهنما مرحله 5
ایجاد یک فایل راهنما مرحله 5

مرحله 5. موضوعات راهنما را بنویسید

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

  • در حالی که می توانید فهرست مطالب را پیش بروید ، برنامه ریزی برای نحوه سازماندهی آن کمک می کند. می توانید فهرست مطالب را در اطراف صفحه نمایش برنامه ، ویژگی های آن ، راه های استفاده از آن یا ترکیبی از آنها سازماندهی کنید.
  • هنگام نوشتن موضوعات ، سایر اطلاعات موجود در فایل راهنما را در نظر بگیرید که کاربران می خواهند به آنها سریع دسترسی داشته باشند. می توانید جهش یا پیوندهای متنی را در متن فایل راهنما ایجاد کنید که به موضوعاتی که دارای این اطلاعات هستند متصل می شود.
ایجاد یک فایل راهنما مرحله 6
ایجاد یک فایل راهنما مرحله 6

مرحله 6. در صورت نیاز ، اسکرین شات ها را اضافه کنید

بسیاری از ویژگی های برنامه با ترکیبی از متن و گرافیک بهتر توضیح داده می شود. شما می توانید با برنامه ای که به همراه ابزار نوشتن راهنمای شما ارائه شده است یا با یک برنامه جداگانه ، مانند Microsoft Paint ، Paint Shop Pro یا SnagIt ، اسکرین شات ایجاد کنید.

  • متن و اسکرین شات باید در موضوعی به گونه ای کنار هم قرار داده شوند که کاربران بتوانند بدون پیمایش بی جا ، تصویر صفحه و متن حمایتی آن را مشاهده کنند. در بسیاری از موارد ، شما می خواهید قسمتی از صفحه برنامه را به جای کل صفحه نمایش دهید ، یا تصویر صفحه را در اندازه کوچکتر از نسخه اصلی نشان دهید. برنامه اسکرین شات شما باید بتواند اندازه تصویر را بدون تار شدن یا از دست دادن جزئیات تغییر اندازه دهد.
  • اگر پیش بینی می کنید که در رابط کاربری بین نسخه آزمایشی و نهایی برنامه تغییراتی ایجاد شود ، ممکن است بخواهید تا ایجاد نسخه نهایی برنامه برای کار ، از ایجاد اسکرین شات خودداری کنید.
ایجاد یک فایل راهنما مرحله 7
ایجاد یک فایل راهنما مرحله 7

مرحله 7. در صورت نیاز ، یک فایل نقشه ایجاد کنید

برخی از برنامه ها شامل دکمه های "راهنما" هستند تا کاربر روی موضوع راهنما کلیک کرده و موضوع را نشان دهد که به طور خاص نحوه عملکرد آن صفحه را توضیح می دهد. نمایش موضوعی از این طریق ، کمک حساس به زمینه نامیده می شود و مستلزم ایجاد یک فایل نقشه برای برنامه نویس است تا دکمه "راهنما" را به موضوع خاصی در فایل راهنمای شما پیوند دهد. ابزار نوشتن راهنمای شما می تواند یکی را برای شما ایجاد کند ، یا برنامه نویس می تواند آن را کدگذاری کرده و به شما بدهد تا در فایل راهنما قرار دهید.

ایجاد یک فایل راهنما مرحله 8
ایجاد یک فایل راهنما مرحله 8

مرحله 8. فایل راهنما را کامپایل کنید

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

ایجاد یک فایل راهنما مرحله 9
ایجاد یک فایل راهنما مرحله 9

مرحله 9. فایل راهنما را امتحان کنید

هنگامی که فایل راهنما را کامپایل می کنید ، باید آن را آزمایش کنید تا مطمئن شوید که همه پیوندها به موضوعاتی که قرار است به آنها متصل شوند و همه گرافیک ها به درستی نمایش داده می شوند ، متصل شوند. فایل راهنما همچنین باید مورد آزمایش قرار گیرد تا از صحت و مناسب بودن محتوا برای کاربران و در قالب سازگار اطمینان حاصل شود. شما باید فایل راهنما را خودتان مرور کنید و از افرادی که برنامه را آزمایش می کنند بخواهید آن را نیز بررسی کنند.

در پروژه های پرونده راهنمای بزرگتر ، تدوین و آزمایش مراحل در حال انجام است. قبل از ایجاد نسخه نهایی ، باید فایل راهنما را کامپایل کرده و چندین بار کار خود را بررسی کنید

ایجاد یک فایل راهنما مرحله 10
ایجاد یک فایل راهنما مرحله 10

مرحله 10. فایل راهنما را در اختیار برنامه نویس قرار دهید تا با برنامه همراه شود

بسته به ماهیت پروژه و فرمت فایل راهنما ، ممکن است مجبور شوید در صورت وجود موضوعات حساس به زمینه ، چندین فایل از جمله فایل نقشه را در اختیار برنامه نویس قرار دهید.

توصیه شده: