9 نصائح لتوثيق المستخدم الرائع (مع أمثلة)

تعد وثائق المستخدم جزءًا مهمًا من المنتج الإجمالي الذي يتم تسليمه إلى عميلك. يساعد المستخدمين النهائيين على أن يكونوا أكثر نجاحًا مع منتجك أو خدمتك.

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

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

هذا هو المكان الذي يأتي فيه منشور المدونة هذا! أنا

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

ابدأ بخطة

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

1. ضع في اعتبارك جمهورك

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

2. تقييم والحفاظ على هدفك النهائي في الاعتبار

الغرض الرئيسي من أي توثيق هو تعليم جمهورك شيئًا ما. بعد تحديد من سيستهلك وثائقك ، سترغب في تحديد ما تريده منه.

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

3. تأكد من سهولة العثور على وثائق المستخدم الخاصة بك

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

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

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

كتابة موجزة وقوية

الكتابة القوية ضرورية لوثائق المستخدم الرائعة. لكن الكتابة تؤثر على أكثر من كيفية قراءة وثائق المستخدم أو أصواتها. يمكن أن يؤثر على مدى سهولة التنقل في وثائق المستخدم الخاصة بك أيضًا.

4. كتابة عناوين وصفية وترجمات

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

يقوم Unbounce بعمل رائع في كتابة عناوين وترجمات فعالة من خلال وثائق المستخدم الخاصة بهم. هذا يجعل وثائقهم سهلة التنقل. لكل مقال جدول محتويات خاص به مما يجعل العثور على إجابة لسؤال معين في غاية السهولة.

5. اجعله سهل التصفح

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

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

6. اجعله قابلاً للبحث بسهولة

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

قاعدة المعرفة المتعمقة لـ Hubspot تجعل الخدمة الذاتية سهلة لعملائها.

استخدم المرئيات لتحسين الفهم

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

7. استخدم لقطات شاشة مشروحة

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

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

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

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

8. الاستفادة من الفيديو لاظهار لا اقول

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

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

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

9. اعرض الأمثلة والنتائج النهائية

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

تسهل وثائق المستخدم الرائعة على المستخدمين النهائيين العثور على إجابات لأسئلتهم ، مما يجعل المستخدمين سعداء وراضين.

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