كيفية كتابة دليل مستخدم البرنامج: الدليل النهائي (بما في ذلك النموذج)

ألست متأكدًا من كيفية كتابة دليل مستخدم البرنامج لمنتجك؟

إذا كنت ترغب في مساعدة المستخدمين في الحصول على أقصى قيمة من منتجك بأكثر الطرق فعالية ، فإن إنشاء دليل مستخدم برنامج عالي الجودة يعد مكانًا رائعًا للبدء.

من خلال منح المستخدمين المحتوى الذي يحتاجون إليه للتعلم واستكشاف أخطاء منتجك وإصلاحها بأنفسهم ، يمكنك مساعدتهم على تحقيق النجاح دون الحاجة إلى الوصول إلى قنوات الدعم البشري الخاصة بك.

هذا لا يجعل الأمور أسهل للمستخدمين فحسب ، بل يمكن أيضًا أن يقلل من طلبات الدعم في عملك ، مما يوفر لك الوقت والمال.

إذن - كيف يمكنك إنشاء دليل مستخدم البرنامج المثالي لمستخدميك؟ هذا هو الغرض من هذا الدليل.

لمساعدتك في الإعداد والتشغيل ، إليك كل ما سنقوم بتغطيته في هذا المنشور:

• ما هو دليل مستخدم البرنامج
• كيفية كتابة دليل مستخدم البرنامج في أربع خطوات ، بما في ذلك قالب دليل مستخدم البرنامج
• أفضل الممارسات لإنشاء محتوى عالي الجودة لدليل المستخدم الخاص بك

دعونا نحفر!

ما هو دليل مستخدم البرنامج؟

دليل مستخدم البرنامج عبارة عن وثائق توفر معلومات حول كيفية استخدام وإدارة تطبيق أو منتج البرنامج الخاص بك.

يمكن أن يتضمن دليل مستخدم البرنامج الخاص بك أدلة البدء والإرشادات والمسارد ونصائح استكشاف الأخطاء وإصلاحها وأنواع أخرى مماثلة من المحتوى.

يتضمن بشكل أساسي جميع المعلومات التي يحتاجها المستخدمون للحصول على قيمة من برنامجك.

عادةً ، سيبدأ بخطوات التثبيت ، ثم يغطي نظرة عامة عامة على الواجهة وكيفية استخدام ميزات مختلفة ، ثم ابحث في استكشاف الأخطاء وإصلاحها والأسئلة الشائعة إذا لزم الأمر. مرة أخرى ، سنقوم بمشاركة قالب دليل مستخدم البرنامج أكثر تفصيلاً أدناه.

لمشاهدة مثال على دليل مستخدم البرنامج ، يمكنك إلقاء نظرة على دليل مستخدم Forklift 3 ، والذي ينتقل مباشرة إلى شرح الواجهة.

على سبيل المثال ، يمكنك إلقاء نظرة على محتوى Slack's Getting Started ، والذي ينتقل أيضًا مباشرة إلى شرح واجهة Slack.

لماذا من المهم إنشاء دليل مستخدم البرنامج؟

هناك سببان رئيسيان لإنشاء دليل مستخدم البرنامج لمنتجك:

1. تجربة مستخدم محسّنة - من خلال تسهيل تعلم المستخدمين كيفية استخدام برامجك وزيادة القيمة التي يتلقونها من برنامجك ، سيكون لدى المستخدمين تجارب أفضل.
2. تقليل عبء الدعم - من خلال منح المستخدمين القدرة على حل مشكلاتهم الخاصة ، يمكنك تقليل العبء على قنوات الدعم البشري الخاصة بك. هذا صحيح بشكل خاص إذا قمت بدمج دليل المستخدم الخاص بك مع أنواع أخرى من محتوى الدعم مثل قاعدة المعرفة و / أو الأسئلة المتداولة (FAQs).

كيفية كتابة دليل مستخدم البرنامج في أربع خطوات

الآن ، دعنا ندخل إلى الدليل العام خطوة بخطوة لكيفية كتابة دليل مستخدم البرنامج. في القسم التالي ، سنستعرض أيضًا بعض أفضل الممارسات للمحتوى الفعلي في دليل المستخدم الخاص بك.

إذا كنت مهتمًا بإلقاء نظرة عامة على هذه الموضوعات ، فلدينا أيضًا دليل حول كيفية إنشاء أي نوع من دليل المستخدم.

1. تخطيط هيكل دليل مستخدم البرنامج

قبل أن تبدأ في إنشاء أي محتوى للدليل الخاص بك ، ستحتاج أولاً إلى تخطيط هيكل دليلك بشكل صحيح.

لجعل دليلك شاملاً قدر الإمكان ، قد ترغب في الجمع بين العديد من أصحاب المصلحة الرئيسيين لمساعدتك في القيام بذلك.

على سبيل المثال ، يمكن أن يشمل ذلك نجاح العميل والمبيعات وما إلى ذلك - أي شخص لديه معرفة بكيفية مساعدة المستخدمين في الحصول على أكبر قيمة ممكنة من المنتج. في بعض الحالات ، قد تحتاج أيضًا إلى جلب المزيد من الموظفين الفنيين للمساعدة في مزيد من التفاصيل المتقدمة.

بالطبع ، إذا كنت تدير مشروعًا منفردًا ، فسترتدي كل هذه القبعات بنفسك. هذه هي فرحة كونك مؤسسًا منفردًا.

بمجرد أن يكون لديك أصحاب المعرفة ذات الصلة ، يمكنك بناء مخطط دليل المستخدم الخاص بك.

بالنسبة لقالب دليل مستخدم البرنامج التقريبي ، يمكنك اتباع شيء مثل هذا ...

1. جدول المحتويات - قم بسرد الأقسام المختلفة في دليل المستخدم الخاص بك حتى يعرف المستخدمون ما يمكن توقعه.
2. مقدمة - اشرح الغرض من دليل مستخدم البرنامج.
3. متطلبات النظام - حدد بالتفصيل أي متطلبات محددة يحتاجها الأشخاص لاستخدام برامجك ، مثل مواصفات الأجهزة ونظام التشغيل وما إلى ذلك.
4. تعليمات التثبيت - قم بتغطية كيف يمكن للمستخدم تثبيت البرنامج.
5. نظرة عامة على واجهة المستخدم - أعط نظرة عامة عالية المستوى عن الواجهة.
6. كيفية استخدام ميزات محددة - أنشئ قسمًا لكل ميزة أساسية توضح للمستخدمين كيفية عملها.
7. الأسئلة المتداولة - قم بتغطية بعض الأسئلة الشائعة التي قد يطرحها المستخدم.
8. استكشاف الأخطاء وإصلاحها - مشاركة نصائح استكشاف الأخطاء وإصلاحها.
9. المسرد - إذا كان برنامجك يحتوي على مصطلحات محددة ، فقد ترغب في إضافة مسرد مصطلحات بالقرب من نهاية دليل مستخدم البرنامج.
10. تفاصيل الاتصال بالدعم - اشرح كيف يمكن للمستخدمين الاتصال بالدعم إذا كانوا بحاجة إلى أي مساعدة إضافية. تريد الاحتفاظ بهذا في النهاية حتى يحاول المستخدمون مساعدة أنفسهم قبل الوصول إلى الدعم.

لا يتعين عليك اتباع نموذج دليل مستخدم البرنامج هذا تمامًا - إنها مجرد نقطة بداية لإعطائك فكرة عما قد ترغب في تضمينه.

2. إنشاء محتوى دليل مستخدم البرنامج الخاص بك

بمجرد حصولك على المخطط التفصيلي الخاص بك ، فأنت على استعداد لبدء إنشاء محتوى دليل مستخدم البرنامج الخاص بك.

سيكون الجزء الأكبر من المحتوى الخاص بك نصًا ، ولكن لا تنس تضمين الصور ذات الصلة وملفات GIF ومقاطع الفيديو أيضًا.

على الرغم من أن هذه الخطوة ستستغرق على الأرجح معظم الوقت ، فإننا نحتفظ بهذا القسم موجزًا ​​في الوقت الحالي لأنه في القسم التالي ، سنشارك بعض أفضل ممارسات دليل مستخدم البرنامج لمساعدة فريقك في إنشاء محتوى دليل مستخدم فعال.

يعتمد من يكتب المحتوى الخاص بك على حجم مؤسستك ومدى تعقيد منتجك. إذا لم يكن لديك كاتب تقني مخصص لموظفيك ، فقد تحتاج إلى تعيين المحتوى إلى فريق نجاح العميل أو الفريق الفني ، اعتمادًا على مدى تعقيد برنامجك.

أو ، إذا كنت مؤسسًا منفردًا ، فمن المحتمل أن تكون أفضل شخص لكتابة المحتوى اليدوي الخاص بك لأن لديك فهمًا أعمق للمحتوى الخاص بك. يمكنك دائمًا تعيين محرر لمساعدتك في تحسين مسودتك الأولى.

3. انشر دليل مستخدم البرنامج

بمجرد حصولك على محتوى دليل مستخدم البرنامج الخاص بك ، فإنك تحتاج إلى نشر الدليل الخاص بك بطريقة تسمح للمستخدمين باستهلاكه بسهولة.

يجب أن تعمل معظم قاعدة المعارف أو برامج التوثيق بشكل جيد مع دليل مستخدم البرنامج ، على الرغم من أنه يمكنك دائمًا ترميز الحل الخاص بك إذا كنت تشعر بأنك محدود للغاية. تنشر بعض الشركات أيضًا إصدارًا بتنسيق PDF من دليل المستخدم بالإضافة إلى إصدار الويب.

للاطلاع على بعض الخيارات الرائعة لنشر إصدار الويب من دليل مستخدم البرنامج الخاص بك ، يمكنك الاطلاع على قوائمنا الخاصة بأفضل برامج قاعدة المعارف وأفضل أدوات التوثيق.

إذا كنت تبحث عن برنامج دليل المستخدم الذي يمنحك قائمة ميزات قوية ، والملكية الكاملة للمحتوى الخاص بك ، والمرونة لتخصيص الأشياء حسب احتياجاتك ، يمكنك استخدام البرنامج الإضافي Heroic Knowledge Base WordPress.

Heroic Knowledge Base هو برنامج مفتوح المصدر يوسع نظام إدارة محتوى WordPress (CMS) مفتوح المصدر بالمثل مع جميع الوظائف التي تحتاجها لنشر دليل مستخدم البرنامج الخاص بك.

ستتمتع بالملكية الكاملة للنظام الأساسي الخاص بك ، بالإضافة إلى المرونة في ضبط كل عنصر حسب الحاجة. ولكن في الوقت نفسه ، لا تزال قاعدة المعارف البطولية تتضمن وظائف مدمجة لجميع الميزات المهمة التي يحتاجها دليل مستخدم البرنامج الخاص بك:

• تنظيم المقالة - يمكنك تنظيم المقالات في دليل البرنامج الخاص بك باستخدام الفئات. على سبيل المثال ، يمكن أن يكون لديك فئات مختلفة لكل من "التثبيت" و "الواجهة" و "استخدام الميزات" و "استكشاف الأخطاء وإصلاحها" وما إلى ذلك.
• ميزات اكتشاف المحتوى - لمساعدة المستخدمين في العثور على المحتوى ذي الصلة بأسرع ما يمكن ، تتضمن قاعدة المعارف البطولية ميزات مفيدة لاكتشاف المحتوى مثل اقتراحات البحث في الوقت الفعلي وجدول المحتويات التلقائي والمزيد.
• نظام ملاحظات المستخدم - يمكن للمستخدمين مشاركة التعليقات حول فائدة كل مقالة ، والتي تتيح لك معرفة ما تقوم به بشكل جيد (والمكان الذي تحتاج إلى تحسينه).
• التحليلات التفصيلية - يمكنك تتبع المقالات التي تحصل على أكبر عدد من المشاهدات ، وأي المقالات تؤدي إلى معظم طلبات الدعم البشري ، وما هي المصطلحات التي يبحث عنها المستخدمون ، وما هي عمليات البحث التي لا تُرجع أي نتائج ، والمزيد.

4. قم بتحديث دليل المستخدم الخاص بالبرنامج بناءً على التعليقات والتغييرات

إن إنشاء دليل مستخدم للبرامج عالية الجودة ليس أمرًا "يتم تنفيذه مرة واحدة". بمجرد نشر دليلك ، من المهم الاستمرار في تعيين أصحاب المصلحة الرئيسيين لتحديث ومراجعة دليلك حسب الحاجة.

في بعض الحالات ، قد تكون هذه التحديثات مطلوبة من خلال تغيير في برنامجك. على سبيل المثال ، إذا أضفت ميزة جديدة أو غيرت واجهة البرنامج ، فستحتاج إلى تحديث دليل المستخدم الخاص بك لحساب هذه التغييرات.

في حالات أخرى ، يمكن أن تنشأ هذه التحديثات من ملاحظات المستخدم. على سبيل المثال ، إذا رأيت أن مقالة معينة في حيرة للمستخدمين ، يمكنك تحديث هذه المقالة لجعلها أكثر إفادة.

أو ، إذا رأيت أن المستخدمين يبحثون عن موضوع غير موجود في دليل مستخدم البرنامج الخاص بك ، فقد تحتاج إلى إنشاء مقال جديد لتغطية هذا الموضوع.

يتيح لك نشر دليل المستخدم الخاص بك باستخدام أداة مثل Heroic Knowledge Base تتبع هذه الأنواع من التحليلات بسهولة حتى تتمكن من مراقبة محتوى دليل المستخدم وتحسينه.

أفضل الممارسات لكتابة دليل مستخدم البرنامج

الآن بعد أن فهمت العملية الأساسية لكيفية كتابة دليل مستخدم البرنامج ، دعنا ننتقل إلى بعض أفضل الممارسات لإنشاء محتوى دليل مستخدم فعال.

افهم من هو جمهورك

إذا كنت ترغب في إنشاء محتوى دليل مستخدم مفيد ، فمن الضروري معرفة من تكتب من أجله:

• من أين يأتي المستخدمون لديك.
• ما الذي يحاولون تحقيقه باستخدام برنامجك.
• ما هي نقاط الألم التي يعانون منها.
• مستوى معرفتهم العامة بمجال عملك و / أو أي مجالات تقنية ذات صلة.
• ما هي الشركة التي يعملون لصالحها (أو إذا كانوا مستخدمين فرديين).
• إلخ.

على سبيل المثال ، لنفترض أن برنامجك يتعامل مع Salesforce. إذا كان المستخدمون المستهدفون هم مسؤولي Salesforce ذوي الخبرة ، فسيبدو المحتوى الخاص بك مختلفًا كثيرًا عما إذا كان المستخدمون المستهدفون هم مندوبي المبيعات أنفسهم.

من المحتمل أن يكون لديك بالفعل فهم جيد للمستخدمين المستهدفين من عملك الحالي. ومع ذلك ، إذا لم تكن متأكدًا ، يمكنك استخدام شخصيات العملاء والاستطلاعات والمقابلات لاكتساب فهم أعمق.

استخدم الهيكل المنطقي والمنظمة

لقد تطرقنا إلى هذا في الخطوة الأولى من القسم السابق ، ولكن من المهم تنظيم دليل المستخدم الخاص بك بالطريقة المثلى لتسهيل حصول المستخدمين على قيمة من المحتوى الخاص بك.

هناك طرق مختلفة يمكنك من خلالها تنظيم دليل المستخدم الخاص بك ، ويمكنك استخدام أساليب متعددة في أقسام مختلفة:

• التجربة الخطية - يمكنك تنظيم دليلك بالطريقة التي سيختبر بها المستخدمون الأشياء. على سبيل المثال ، قد تبدأ بـ "التثبيت" كقسم أول ثم تنتقل إلى الإجراء الأول بعد التثبيت في القسم التالي.
• الميزة - يمكنك تنظيم المحتوى اليدوي الخاص بك بناءً على الميزات المختلفة في برنامجك.
• استكشاف الأخطاء وإصلاحها - يمكنك جمع خطوات استكشاف الأخطاء وإصلاحها الشائعة في مكان واحد.

مرة أخرى ، من الجيد تمامًا استخدام طرق متعددة في دليلك. على سبيل المثال ، قد تبدأ بتنظيم الأشياء بطريقة خطية لعملية التثبيت.

ولكن بمجرد تغطية التثبيت ويمكن للمستخدمين البدء في تطبيق برنامجك بطرق مختلفة ، يمكنك التبديل إلى نهج تنظيمي قائم على الميزات.

اجعل كتابتك بسيطة ومتسقة

لجعل دليل مستخدم البرنامج سهل الوصول إليه قدر الإمكان ، من المهم أن تبقي كتابتك بسيطة قدر الإمكان.

إليك بعض الأشياء التي يجب وضعها في الاعتبار لتحقيق ذلك:

• لا تستخدم المصطلحات أو الكلمات المربكة - لن يكون لدى جميع المستخدمين نفس المعرفة عندما يتعلق الأمر بمجال عملك و / أو لغة منتجك ، لذلك من المهم تجنب المصطلحات التقنية غير الضرورية والمفردات المربكة. يمكنك اختبار المحتوى الخاص بك باستخدام أدوات مثل اختبار Flesch Reading Ease للعثور على المشكلات.
• تجنب الصوت المبني للمجهول - قد يكون استخدام المبني للمجهول محيرًا بشكل خاص في دليل المستخدم. على سبيل المثال ، بدلاً من استخدام صوت مبني للمجهول مثل "يمكن حفظ نسخة من مسودتك بالضغط على زر حفظ المسودة " ، فمن الأفضل استخدام صوت نشط مثل "اضغط على زر حفظ المسودة لحفظ نسخة من مسودة."
• استخدم جمل قصيرة - يُسهل تقسيم المحتوى الخاص بك إلى جمل قصيرة على المستخدمين استهلاك محتوى دليل المستخدم وفحصه. كلما أمكن ، تجنب الفقرات الطويلة (المعروفة باسم "جدران النص").
• ابق متسقًا - استخدام صياغة وتنسيق متسقين سيجعل من السهل على المستخدمين فهم دليلك. على سبيل المثال ، إذا كنت تستخدم دائمًا قائمة مرتبة لسرد الخطوات الفردية في مهمة معينة ، فحاول الاحتفاظ بهذا التنسيق عبر دليل المستخدم بالكامل.
• تجنب المشكلات النحوية - تأكد من عدم وجود أي أخطاء نحوية قد تجعل من الصعب على المستخدمين فهم دليلك. يمكنك التحقق من ذلك باستخدام أدوات مثل Grammarly و Hemingway.

قم بتضمين الصور ومقاطع الفيديو حيثما تكون مفيدة

بينما سيشكل المحتوى النصي أساس دليل المستخدم الخاص بك ، من المهم أيضًا تضمين الصور ومقاطع الفيديو حيث يكون ذلك منطقيًا.

قد يكون القول بأن "الصورة تساوي ألف كلمة" مبتذلاً ، ولكن يمكن أن يكون صحيحًا بالتأكيد عندما تحاول شرح كيف يمكن للمستخدمين الحصول على قيمة من منتج البرنامج الخاص بك.

للمساعدة في شرح المفاهيم من النص الخاص بك ، يمكنك إضافة صور توضيحية أو صور GIF توضح ما تتحدث عنه.

على سبيل المثال ، يقوم Slack بعمل رائع في وضع تعليقات توضيحية على صور مقدمة الواجهة.

يمكن أن يكون محتوى الفيديو مفيدًا أيضًا لبعض المستخدمين. ومع ذلك ، يجب أن تكون حذرًا بشأن الاعتماد فقط على محتوى الفيديو ، حيث إنها ليست دائمًا الطريقة المثلى للمستخدمين لاستهلاك محتوى دليل البرنامج.

على سبيل المثال ، إذا كان المستخدم يحاول فقط استكشاف تفاصيل معينة وإصلاحها ، فعادة ما يكون العثور على هذه التفاصيل في محتوى نصي أسهل بكثير من العثور عليه في الفيديو.

قم بإنشاء دليل مستخدم البرنامج الخاص بك اليوم

يختتم هذا دليلنا حول كيفية كتابة دليل مستخدم برنامج رائع من شأنه أن يهيئ مستخدميك للنجاح.

إذا كنت تريد أسهل طريقة لنشر دليل مستخدم البرنامج الخاص بك ، فيمكنك استخدام المكون الإضافي Heroic Knowledge Base لـ WordPress.

Heroic Knowledge Base هو مكون إضافي مفتوح المصدر يتيح لك الاستفادة من WordPress CMS لإنشاء دليل مستخدم البرنامج المستضاف ذاتيًا والذي يكون تحت سيطرتك بالكامل.

في الوقت نفسه ، لا تحتاج إلى التضحية بالوظائف لأن Heroic Knowledge Base توفر جميع الميزات التي تحتاجها لإنشاء دليل مستخدم برنامج رائع. تتضمن هذه الميزات اقتراحات البحث المباشر وتنظيم الفئة وجمع تعليقات المستخدم والتحليلات والمزيد.

إذا كنت مستعدًا للبدء ، فقم بشراء Heroic Knowledge Base اليوم وستحصل على دليل مستخدم رائع المظهر في لمح البصر.