على الرغم من تجاهل العديد من مستخدمي الكمبيوتر بشكل متكرر ، فإن ملفات التعليمات توفر معلومات أساسية حول كيفية استخدام تطبيق البرنامج المرتبطون بها. من خلال النقر على "تعليمات" ، يمكن للمستخدم الحصول على نظرة عامة على ميزات البرنامج ، ووصف الشاشة التي يراها ، وإرشادات حول كيفية استخدام البرنامج لأداء مهمة معينة أو قراءة قوائم الأسئلة المتداولة حول البرنامج وإجاباتهم. تتطلب كتابة ملف تعليمات القدرة على العمل مع تطبيقات البرامج والقدرة على شرح الأشياء بطريقة يمكن للمستخدمين فهمها.
خطوات
الخطوة الأولى. احصل على نسخة من البرنامج الذي تريد توثيقه
إذا أمكن ، يجب أن تحصل أيضًا على نسخة من المواصفات المكتوبة للبرنامج ، على الرغم من عدم عمل جميع مطوري البرامج معهم. في بعض الحالات ، ينحرف المبرمج عن المواصفات ، بناءً على وقت التطوير القصير أو عدم قدرته على ترميز ميزة معينة.
الخطوة الثانية. احصل على أداة مساعدة في التأليف
في حين أنه من الممكن إنشاء ملف تعليمات يدويًا ، باستخدام ملف بتنسيق rich-text (.rtf) ، يستخدم معظم مؤلفي ملفات التعليمات تطبيقًا برمجيًا لكتابة ملفات المساعدة الخاصة بهم ، مثل RoboHelp و Help and Manual و Doc-To -مساعدة ، MadCap Flare أو HelpLogix. تتضمن معظم أدوات التأليف المساعدة محرر نصوص أو تعمل مع برنامج معالجة كلمات مثل Microsoft Word وتوفر واجهة مستخدم تتيح للمؤلف المساعد رؤية كيف سيبدو ملف المساعدة أثناء كتابته أو كتابتها أثناء كتابة رمز الكمبيوتر خلف الكواليس لجعل ملف المساعدة يعمل. تتضمن بعض أدوات التأليف المساعدة أيضًا برامج تحرير الرسومات لإنشاء لقطات شاشة لتضمينها في ملف التعليمات.
يوجد عدد من تنسيقات ملفات التعليمات: أكثرها شيوعًا هي تعليمات HTML ، والتي تستخدمها التطبيقات التي تعمل في Windows. (تنسيق أقدم ، WinHelp ، لم يعد مدعومًا.) لكل من Apple و Unix تنسيقاتهما الخاصة ، وكذلك Sun Microsystems ، مع JavaHelp الخاص بها. قد تستخدم التطبيقات البرمجية المصممة للعمل في ظل العديد من أنظمة التشغيل نظام مساعدة عبر الأنظمة الأساسية يتم تشغيله في متصفح الويب الخاص بالمستخدم. يجب أن تدعم أداة التأليف المساعدة التي تستخدمها تنسيق (تنسيقات) المساعدة التي ستنشئ ملفات المساعدة بها
الخطوة الثالثة. قم بإنشاء ملف مشروع المساعدة
ستعمل أداة المساعدة في التأليف على إنشاء ملف مشروع مساعدة لك ، بناءً على اسم الملف الذي تقدمه ومعلومات أخرى. يحتوي ملف المشروع الرئيسي على معلومات حول الملفات الأخرى ، والتي تتضمن ملف محتويات وملف فهرس وملف صورة أو أكثر وملفات أخرى.
- يتضمن ملف المحتويات النص الموجود في ملف التعليمات الذي يشرح كيفية عمل تطبيق البرنامج الذي تقوم بتوثيقه. عادةً ما يتم تقسيم النص إلى موضوعات تغطي شاشة أو ميزة أو إجراءً معينًا.
- ملف الفهرس هو قائمة بموضوعات ملف المساعدة. يتم استخدامه لإنشاء جدول محتويات يمكن للمستخدمين استخدامه لتحديد موضوع لعرضه ، بالإضافة إلى فهرس يمكن البحث فيه داخل ملف التعليمات.
- ملفات الصور هي ملفات رسومية لشاشات البرنامج أو أجزاء من تلك الشاشات معروضة داخل ملف التعليمات لتعزيز قدرة المستخدمين على فهم ما يشير إليه نص ملف التعليمات.
الخطوة 4. ضبط حجم نافذة المساعدة
ما لم تكن تكتب ملف التعليمات ليظهر في متصفح الويب الخاص بالمستخدم ، سيظهر ملف التعليمات في نافذته الخاصة. ستتيح لك أداة المساعدة في التأليف ضبط أبعاد النافذة الأفقية والرأسية إلى حجم يسمح للمستخدم النهائي بقراءة ملف المساعدة دون أن يعيق التطبيق نفسه. غالبًا ما تكون نافذة التعليمات الرئيسية بتنسيق ثلاثي الأجزاء ، مع وجود جدول المحتويات على اليسار والموضوع المحدد على اليمين.
يمكن أن تحتوي ملفات التعليمات أيضًا ، بالإضافة إلى النافذة الرئيسية ، على نوافذ ثانوية تصف ميزة معينة بالتفصيل وتحجيم النوافذ المنبثقة تلقائيًا والتي تقدم أوصافًا قصيرة للميزات. يمكن أن تتضمن ملفات التعليمات أيضًا نصًا مضمنًا يظهر فقط عند النقر على النص المميز أو النقر فوق الزر
الخطوة 5. اكتب مواضيع المساعدة
للقيام بذلك ، ستحتاج إلى مراجعة المواصفات أو البرنامج نفسه لإنشاء موضوعات لتوثيق شاشات البرنامج وميزاته. أثناء إنشاء كل موضوع ، ستضيفه أداة المساعدة في التأليف إلى جدول محتويات ملف المساعدة والفهرس.
- بينما يمكنك إنشاء جدول المحتويات أثناء التنقل ، إلا أنه من المفيد أن يكون لديك بعض الخطط لكيفية تنظيمه. يمكنك تنظيم جدول المحتويات حول شاشات البرنامج ومميزاته وطرق استخدامه أو مزيج منها.
- أثناء كتابة الموضوعات ، ضع في اعتبارك المعلومات الأخرى الموجودة في ملف التعليمات والتي سيرغب المستخدمون في الوصول إليها بسرعة. يمكنك إنشاء قفزات ، أو ارتباطات تشعبية ، في نص ملف التعليمات الذي يتصل بالموضوعات التي تحتوي على تلك المعلومات.
الخطوة 6. قم بتضمين لقطات الشاشة ، إذا لزم الأمر
من الأفضل شرح العديد من ميزات البرنامج بمزيج من النص والرسومات. يمكنك إنشاء لقطات شاشة إما بالتطبيق الذي يأتي مع أداة المساعدة في التأليف أو مع تطبيق منفصل ، مثل Microsoft Paint أو Paint Shop Pro أو SnagIt.
- يجب وضع النص ولقطات الشاشة معًا في موضوع بحيث يمكن للمستخدمين رؤية لقطة الشاشة والنص الداعم لها دون تمرير لا داعي له. في كثير من الحالات ، سترغب في إظهار جزء من شاشة البرنامج بدلاً من الشاشة بأكملها ، أو إظهار لقطة الشاشة بحجم أصغر من الحجم الأصلي. يجب أن يكون تطبيق لقطة الشاشة الخاص بك قادرًا على تغيير حجم لقطة الشاشة دون التعتيم أو فقدان التفاصيل.
- إذا كنت تتوقع تغييرات في واجهة المستخدم بين الإصدار الاختباري والأخير من البرنامج ، فقد ترغب في التوقف عن إنشاء لقطات شاشة حتى يكون لديك الإصدار النهائي من البرنامج للعمل به.
الخطوة 7. قم بإنشاء ملف خريطة ، إذا لزم الأمر
تتضمن بعض البرامج أزرار "تعليمات" للمستخدم للنقر فوق الموضوع وعرضه في ملف التعليمات الذي يصف بشكل خاص كيفية عمل هذه الشاشة. يُطلق على عرض موضوع بهذه الطريقة تعليمات حساسة للسياق ويتطلب إنشاء ملف خريطة للمبرمج لربط زر "تعليمات" بالموضوع المحدد في ملف المساعدة الخاص بك. يمكن لأداة المساعدة في التأليف إنشاء واحدة لك ، أو يمكن للمبرمج ترميزها وإعطائها لك لتضمينها في ملف المساعدة.
الخطوة 8. تجميع ملف التعليمات
يؤدي التحويل البرمجي إلى إنشاء ملف التعليمات الفعلي الذي سيتم تضمينه مع البرنامج. بالنسبة لمعظم تنسيقات المساعدة ، سوف يتضمن ذلك جميع ملفات المكونات التي تم إنشاؤها عند إنشاء ملف التعليمات ، على الرغم من أن بعض تنسيقات التعليمات غير المجمعة تتطلب أيضًا تضمين ملفات موضوع التعليمات الفردية في البرنامج.
الخطوة 9. اختبر ملف التعليمات
بمجرد تجميع ملف التعليمات ، ستحتاج إلى اختباره للتأكد من أن جميع الارتباطات التشعبية تتصل بالموضوعات التي من المفترض أن يتم عرضها وجميع الرسومات بشكل صحيح. يحتاج ملف المساعدة أيضًا إلى الاختبار للتأكد من أن المحتوى دقيق ومناسب للمستخدمين وبتنسيق متسق. سترغب في مراجعة ملف المساعدة بنفسك وجعل الأشخاص الذين يختبرون التطبيق يراجعونه أيضًا.
في مشاريع ملفات المساعدة الكبيرة ، يعتبر التجميع والاختبار عمليتين جاريتين. ستحتاج إلى تجميع ملف التعليمات والتحقق من عملك عدة مرات قبل إنشاء الإصدار النهائي
الخطوة 10. أعط ملف المساعدة للمطور لتضمينه مع البرنامج
اعتمادًا على طبيعة المشروع وتنسيق ملف التعليمات ، قد تضطر إلى تزويد المطور بالعديد من الملفات ، بما في ذلك ملف الخريطة إذا كانت هناك موضوعات حساسة للسياق.
