اكتب دليل المستخدم

مؤلف: John Pratt
تاريخ الخلق: 15 شهر فبراير 2021
تاريخ التحديث: 1 تموز 2024
Anonim
من كل سنة كتاب (2014) - الأخبار: دليل المستخدم | The News: A User’s Manual
فيديو: من كل سنة كتاب (2014) - الأخبار: دليل المستخدم | The News: A User’s Manual

المحتوى

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

لتخطو

جزء 1 من 4: تخطيط دليل المالك الخاص بك

  1. قم بتحليل المستخدم. يجب كتابة دليل المستخدم للمستخدمين - أولئك الذين سيشترون منتجك أو خدمتك ويقرؤون دليل المستخدم. سيخبرك تحليل المستخدم من سيكون جمهورك الرئيسي أو المستهدف وسيقوم بإرشادك خلال كتابة النص.
    • تحدث إلى الأشخاص الذين سيستخدمون جهازك. اعرض على المستخدمين نماذج أولية للجهاز ومسودة دليل المستخدم في ظل ظروف خاضعة للرقابة. اطلب من مستخدمي الاختبار هؤلاء الحصول على تعليقات حول الأشياء غير الواضحة أو المربكة في دليل المستخدم وقم بإجراء تغييرات على دليل المستخدم الخاص بك بناءً على هذه التعليقات.
    • لا يمكنك إرضاء جمهورك بالكامل ؛ اكتب الكتيب المصمم للجمهور المستهدف أو أكبر جمهور.
    • ضع في اعتبارك العمر أو الصحة (هل لديهم أي أمراض أو صعوبات في التعلم أو إعاقات؟) ومستوى تعليم الجمهور لتحديد أفضل نهج لكتابة دليل المستخدم.
  2. تنسيق تصميم دليل المستخدم. إذا كنت جزءًا من الفريق الذي ساعد في تصميم وتطوير الجهاز أو المنتج ، فقد يكون من الصعب إلقاء نظرة موضوعية على المنتج لشرح كيفية عمله. لذلك يجب عليك طلب مشورة كاتب (يفضل أن يكون شخصًا لديه خبرة في كتابة التعليمات) ومصمم رسومات لمساعدتك في إعداد دليل المستخدم. يمكنك اختيار هؤلاء الأشخاص من خلال استشارة خارجية أو من شركتك أو مؤسستك الخاصة.
  3. قم بتحليل المهمة. تحليل الوظيفة هو عملية تحديد وتنظيم الخطوات المطلوبة لاستخدام الجهاز. يحدد تحليل الوظيفة الشامل المواد والمعدات (مثل البطاريات أو الأدوية أو غيرها من المنتجات التي يوفرها المستخدم) المطلوبة لكل خطوة ، بالإضافة إلى الإجراءات والأخطاء ونصائح استكشاف الأخطاء وإصلاحها التي قد تتطلبها كل خطوة.
    • إذا كان لديك منتج يمكنه تنفيذ العديد من المهام أو المهام الفرعية المختلفة ، فيجب عليك إجراء تحليل مهمة لكل مهمة. على سبيل المثال: في السيارة ، يمكنك أن تزمير ، وربط نفسك وتشغيل المصابيح الأمامية الخاصة بك أو إيقاف تشغيلها. قم بإجراء تحليل وظيفي لكل من هؤلاء ، إذا لزم الأمر.
  4. تأكد من أن منتجك يفي بمتطلبات وضع العلامات وترخيص التسويق. تضمن هذه المتطلبات أن يتم تصنيع المنتجات مع مراعاة سلامة المستخدم وأن تعرض المستخدم للظروف الخطرة ، مثل الإشعاع والصعق الكهربائي ، محدود. يجب أن تنص الإعلانات بوضوح على الغرض وإرشادات التشغيل الأساسية للمنتج ، ويجب عليك استخدام هذه الموارد عند كتابة دليل المالك.
    • لكي يكون دليل المستخدم الخاص بالمنتج فعالاً ، يجب كتابته وفقًا للملصقات الملصقة مباشرةً على المنتج.
    • تأكد من أن جهازك مرخص رسميًا للبيع قبل كتابة دليل المستخدم.
  5. حدد تصميم الدليل الخاص بك. هناك عدة طرق مهمة يمكنك من خلالها تبسيط الدليل الخاص بك. يجب وضع عنوان غامق في بداية كل قسم مع كتابة كل كلمة بأحرف كبيرة. على سبيل المثال ، يمكن أن تكون عناوين "إعداد جهازك" و "تشغيل جهازك" و "استكشاف الأخطاء وإصلاحها" جميعها عناوين عريضة للأقسام.
    • هناك طريقة أخرى لتبسيط دليلك وهي استخدام عمودين ، أحدهما على اليمين مع النص والآخر على يسار النص ، مع الرموز النقطية أو الأرقام أو الرموز الصغيرة ، مثل علامات التحذير أو علامات التعجب الحمراء.
    • قد يتكون الدليل بشكل أساسي من صور مع بعض النصوص أسفل كل صورة لشرح الجهاز ، أو قد يكون بشكل أساسي نصًا يحتوي على عدد قليل من الصور المصاحبة. يمكنك أيضًا استخدام مخطط انسيابي لتوجيه المستخدم. فكر في منتجك وكيف يمكن أن تساعدك كل طريقة في كتابة دليلك. ومع ذلك ، تجنب خلط التخطيطات المختلفة في دليل واحد. اختر واحدة والتزم بها.

جزء 2 من 4: تضمين المعلومات الأساسية

  1. تنظيم الدليل منطقيا. يجب أن يكون الدليل منظمًا بطريقة تجعل المستخدم يستفيد منه بأكبر قدر ممكن. قسّم الدليل إلى فصول أو أقسام منطقية لاستخدام المنتج وقم بتضمين جدول محتويات في مقدمة الدليل بحيث يمكن العثور على كل قسم بسرعة.
    • يعد جدول المحتويات ضروريًا بشكل خاص للكتيبات الأطول.
    • المسرد أو الفهرس ضروري إذا كان هناك العديد من المصطلحات لتوضيح أن جمهورك قد لا يكون على دراية بها. ومع ذلك ، لا يوصى باستخدام مسرد ؛ الخيار الأفضل هو شرح المصطلحات المربكة في نص الدليل نفسه. إذا اخترت تضمين معجم ، فضعه في مقدمة الدليل ، بعد جدول المحتويات مباشرة.
    • قائمة الجداول أو الأشكال ضرورية فقط إذا كان هناك أكثر من عدد قليل من الجداول أو الأشكال في الدليل.
    • هناك حاجة إلى ملحق للأشياء التي تحتاج إلى شرح ولكن لا يمكن شرحها في مكان آخر في الدليل ، حيث قد تؤدي إلى تعطيل التدفق والتركيز.
  2. قم بتضمين التحذيرات الضرورية. يجب أن توفر التحذيرات العامة أو المعلومات الاحترازية معلومات عن المخاطر المحتملة الناجمة عن الاستخدام غير السليم للمنتج ، بما في ذلك الوفاة أو الإصابة الخطيرة. يجب وضع هذه التحذيرات في مقدمة الدليل ، بعد الصفحة الأولى ، بحيث يراها المستخدم أولاً. يجب أيضًا تضمين تحذيرات محددة في نص الدليل بعد اقتراح خطوة يحتمل أن تكون خطرة أو قبلها مباشرة.
    • على سبيل المثال ، قد يكون التحذير العام لجهاز كهربائي هو عدم استخدامه عندما تمطر.
    • يمكن أن تكون التعليمات المحددة هي التأكد من جفاف يديك والجهاز قبل توصيل الجهاز بمأخذ الطاقة.
    • قدِّم صورًا (مثل الجمجمة والعظمتين المتقاطعتين) أو نصًا بلون مختلف (مثل النص الأحمر) لتمييز التحذير عن بقية الاتجاهات في IFU وجذب انتباه المستخدمين إليها.
  3. وصف الجهاز. يجب أن يتضمن وصفك شرحًا مكتوبًا للغرض من الجهاز وتمثيلًا رسوميًا صغيرًا لما يبدو عليه الجهاز. يجب أن يقوم الشكل بتسمية جميع المفاتيح والأزرار والأجزاء الملحقة الموجودة في الجهاز وتسميتها.
  4. قدم تعليمات التثبيت. يجب أن يحتوي قسم التثبيت على معلومات أساسية حول كيفية الاستعداد لاستخدام المنتج أو الجهاز. إذا كان الجهاز لا يمكن تصنيعه أو إعداده بواسطة مستخدم منزلي ، فذكر ذلك بوضوح في عنوان غامق أعلى قسم التثبيت. يجب عليك أيضًا تضمين ما يلي:
    • قائمة الأجزاء
    • إرشادات التفريغ
    • تحذيرات التثبيت
    • عواقب التثبيت غير الصحيح
    • بمن تتصل في حالة وجود صعوبات أثناء التثبيت
  5. قدم معلومات حول العملية. هذا القسم هو أهم جزء في دليل المستخدم ويجب أن يوفر معلومات محددة ومفصلة حول كيفية استخدام الجهاز. ابدأ بالإعدادات الأساسية لاستخدام الوحدة ، مثل توصيل سلك الطاقة أو غسل يديك. تابع الخطوات المنطقية المرقمة التي تصف كيفية استخدام الجهاز ، بالإضافة إلى أي ملاحظات (على سبيل المثال ، "ستسمع نقرة ...") يمكن أن يتوقعها المستخدم عند استخدام الجهاز بشكل صحيح.
    • في نهاية هذا الفصل ، يجب إحالة المستخدمين إلى فصل استكشاف الأخطاء وإصلاحها لحل المشكلات التي لا يمكن شرحها بسرعة.
    • ضع الصور عند الضرورة. من الأفضل شرح بعض الخطوات بالصور والكلمات. ضع في اعتبارك استخدام الصور أو الرسوم التوضيحية في دليلك.
    • في هذا القسم ، كما هو الحال في أي قسم ، يجب عليك تضمين تحذيرات السلامة ذات الصلة بشأن الاستخدام أو التشغيل غير الصحيح. على سبيل المثال ، يمكنك تحذير مستخدمي المنشار من شرب الكحول أو استخدام المنشار أثناء تناول بعض الأدوية.
    • إذا كنت تعتقد أن المستخدمين سيستفيدون ، ففكر في تضمين روابط لمقاطع فيديو عبر الإنترنت توضح الاستخدام السليم للجهاز وتشغيله. يمكنك تسجيل مقاطع الفيديو هذه إما في بداية هذا القسم ، أو (في حالة مقاطع الفيديو التي توضح خطوة واحدة فقط) في نهاية كل خطوة.
  6. قم بتضمين ملخص للمنتج في النهاية. يجب أن يظهر الملخص في نهاية الدليل ، قبل الفهرس مباشرةً ، لتوفير خطوات التشغيل الأساسية. يجب أن تكون هذه نسخة مبسطة ومبسطة من المعلومات التشغيلية ، ويجب ألا تزيد عن صفحة واحدة. لخص كيفية استخدام الجهاز أو المنتج. قم بتضمين التنبيهات الأساسية والخطوات المرقمة التي تشرح كيفية استخدام المنتج وأرقام الهواتف أو عناوين البريد الإلكتروني التي توجه المستخدمين للمساعدة.
    • إذا كنت تتوقع أن يقوم المستخدم بإزالة أو الرجوع إلى ورقة الملخص في كثير من الأحيان ، فيمكنك طباعتها على بطاقة مغلفة قابلة للإزالة أو كرتون سميك لتسهيل حملها والرجوع إليها.
    • بدلاً من ذلك ، يمكنك تطبيق ملخص مباشرةً على المنتج للرجوع إليه بسرعة وسهولة من قبل المستخدم.

جزء 3 من 4: وصف صيانة المنتج

  1. اشرح كيفية تنظيف الجهاز. إذا كان جهازك أو منتجك بحاجة إلى التنظيف ، فشرح كيفية القيام بذلك. ضع قائمة بعوامل التنظيف المطلوبة. أخبر القارئ بعدد مرات التنظيف. بعد ذلك ، كما هو الحال في أي جزء آخر من الدليل ، قم بتضمين إرشادات مرقمة خطوة بخطوة حول كيفية تنظيفه.
    • إذا تطلب التنظيف تفكيك المنتج ، أو إزالة جزء أو أجزاء معينة ، وضح كيف ينبغي تفكيك المنتج.
    • تقديم تحذير بشأن نتائج عدم تنظيف الجهاز. على سبيل المثال ، يمكنك أن تقول ، "إذا لم يتم تنظيف الجهاز ، فسيكون الأداء أقل من المستوى الأمثل."
  2. احسب المستخدم كيفية إجراء الصيانة الأساسية. إذا كان المنتج أو الجهاز يمكن للمستخدم صيانته لتصحيح مشاكل الأداء ، فقم بتوفير إرشادات مرقمة حول كيفية القيام بذلك للمستخدم. على سبيل المثال ، إذا كانت البطاريات بحاجة إلى الاستبدال بعد كل 300 ساعة من الاستخدام ، فقدم إرشادات حول كيفية التحقق مما إذا كانت البطاريات بحاجة إلى الاستبدال ، وكيفية إزالة البطاريات الفارغة ، وكيفية تركيب البطاريات الجديدة.
    • إذا كانت هناك مهام صيانة معينة لا يمكن إجراؤها إلا بواسطة فني معتمد ، فقم بتقسيم جزء الصيانة من الدليل إلى جزأين.
  3. ناقش خيارات التخزين. إذا لزم الأمر ، يجب أن يشرح الدليل كيفية تخزين المنتج أو الجهاز بشكل صحيح. يجب عليك أيضًا تضمين معلومات حول سبب ضرورة التخزين وعواقب التخزين غير السليم. على سبيل المثال: يمكنك كتابة:
    • قم بتخزين المنتج في مكان بارد وجاف. يمكن أن يؤدي التخزين غير المناسب إلى تقصير عمر منتجك بسبب تراكم الرطوبة ".
    • "لا تعرض المنتج للحرارة أو تخزنه في درجات حرارة تزيد عن 50 درجة مئوية.إذا قمت بذلك ، فقد يؤدي ذلك إلى الاحتراق ".
  4. قم بتوفير معلومات استكشاف الأخطاء وإصلاحها. يمكنك تنظيم هذا القسم على شكل قائمة بالمشكلات الشائعة وحلولها. جمِّع المشكلات المتشابهة تحت عنوان منطقي. بهذه الطريقة ، يمكن للمستخدمين العثور بسرعة على مشاكل محددة.
    • على سبيل المثال ، إذا كانت هناك عدة مشكلات في الكمبيوتر الذي يعرض شاشة زرقاء ، فقم بتجميعها تحت عنوان فرعي ، مثل "مشاكل الشاشة الشائعة".
    • يجب عليك أيضًا تضمين رقم هاتف و / أو بريد إلكتروني لخدمة العملاء في هذا القسم.

جزء 4 من 4: اكتب دليلًا قابلاً للقراءة

  1. اقرأ أدلة المستخدم الأخرى. قبل كتابة دليل لمنتجك الخاص ، تحقق من أدلة المستخدم الفعالة الأخرى. انتبه إلى البنية واختيار الكلمات وبنية الجملة. تنتج العلامات التجارية الكبرى مثل Apple و Google و Microsoft أدلة مستخدم قوية وفعالة يمكن أن تساعدك في إنتاج دليل مستخدم مكتوب بعناية أكبر.
    • لا تقرأ فقط الكل أدلة المستخدم. اقرأ كتيبات المنتجات المماثلة التي تبيعها. على سبيل المثال ، إذا كنت تبيع منتجات أطفال ، فاقرأ كتيبات الأطفال وليس التقنية.
  2. حدد المعايير الخاصة بك. توحيد التهجئة واختيار الكلمات والصياغة سيجعل دليل المستخدم أكثر سهولة في الاستخدام. يمكن أن يكون دليل شيكاغو للأناقة ودليل Microsoft للأناقة أيضًا دليلين مفيدين للأسلوب عند كتابة دليل المالك الخاص بك ؛ تحقق من كليهما لمعرفة ما إذا كان أحدهما مناسبًا لدليلك.
    • على سبيل المثال ، بدلاً من استخدام "مفتاح الطاقة" و "زر الطاقة" في دليلك ، اختر أحد المصطلحين والتزم به.
  3. استخدم الصوت النشط. الصوت النشط هو طريقة للكتابة تشرح الأشياء من منظور المستخدم. إنه أسهل للفهم من البديل ، المبني للمجهول ، حيث يكون الموضوع غير محدد.
    • جرب تطبيق Hemingway (www.hemmingwayapp.com) لتحديد المقاطع السلبية في كتاباتك.
    • ادرس هاتين الجملتين النموذجيتين - الأولى نشطة والثانية سلبية:
      • عليك أن تفتح العبوة ببطء وبعناية.
      • يجب فتح العبوة ببطء وحذر.
  4. اكتب تعليمات مرقمة. تساعد التعليمات المرتبة عدديًا القارئ على التركيز بشكل أفضل على عملية استخدام أو توصيل أو بناء المنتج المعني. بدلاً من كتابة فقرة طويلة مطولة أو سلسلة من الفقرات غير المرقمة ، اكتب دليل المستخدم الخاص بك بخطوات بسيطة وواضحة ، كل منها مرقمة بوضوح.
  5. ابدأ كل خطوة بحتمية. الأمر الحتمي هو فعل عملي المنحى. ببدء كل خطوة بفعل ، فإنك تعطي القارئ تلميحًا حول الإجراء المطلوب لإكمال الخطوة. على سبيل المثال ، بناءً على المنتج الذي تكتب عنه ، يمكنك بدء خطواتك بأمر مثل "اتصال" أو "تأكيد" أو "شريحة". ومع ذلك ، لا تبدأ خطواتك باستجابة من النظام.
    • على سبيل المثال ، إذا تحولت الشاشة إلى اللون الأزرق وبدأت في الوميض ، فلا تبدأ الخطوة بـ: "ستومض الشاشة وتتحول إلى اللون الأزرق." جرب: "اضغط مع الاستمرار على مفتاح الصفحة الرئيسية. ستومض الشاشة وتتحول إلى اللون الأزرق. "
  6. حدد المفردات التي ستستخدمها. إذا كنت تكتب دليل اليويو ، فسيكون جمهورك في الغالب من الأطفال الصغار. استخدم كلمات ومفردات بسيطة لشرح كيفية عمل اليويو. عندما تكتب كتيبًا عن المجهر الإلكتروني ، فإن جمهورك يتكون من علماء ذوي مهارات عالية يمكنهم فهم معلومات مفصلة للغاية ، لذلك لا تتردد في استخدام المفردات المتخصصة أو التفسيرات الدقيقة.
    • بشكل عام ، تحاول تجنب المصطلحات اللغوية والتقنية.
    • لكي تكون فعالاً لأوسع قاعدة مستخدمين ممكنة ، حاول الكتابة على مستوى من الصف السادس إلى الصف السابع في المدرسة الابتدائية.
  7. عند شحن منتج إلى الخارج ، تأكد من دقة ترجماتك. استعن بمترجم لترجمة دليل المستخدم الخاص بك إلى اللغة الأصلية للبلد الذي تقوم بشحن منتجك إليه. يمكنك أيضًا استخدام برنامج ترجمة عبر الإنترنت ، ولكن اطلب من متحدث أصلي قراءة الترجمة والتحقق من الأخطاء.
    • إذا تم تمثيل مجموعات لغات متعددة في جمهورك ، فيرجى تضمين ترجمات دليل المستخدم بكل لغة ذات صلة.
    • يجب أن يكون المترجم على دراية بالمنتج حيث قد تكون هناك كلمات مختلفة في اللغة الهدف لمصطلحات معينة ليست ترجمات حرفية.
  8. اكتب جمل قصيرة. بدلاً من بضع فقرات طويلة ، يمكنك استخدام الكثير من الفقرات القصيرة. ابحث عن فواصل منطقية في كل قسم واستوعب المعلومات المفيدة في أجزاء من جملة واحدة أو جملتين. نفس الشيء صحيح على مستوى الجملة. اجعل جملك قصيرة وبسيطة ، وليست طويلة ومطولة.
    • إذا كانت إحدى الخطوات طويلة جدًا ، فقسِّمها إلى خطوات أصغر. لن يقلل هذا من عدد الكلمات ، لكن فواصل الأسطر ستجعل من السهل قراءتها.
  9. تحقق من الدليل بحثًا عن الأخطاء. يمكن أن يفقد الدليل مصداقيته بسبب الأخطاء النحوية والإملائية. اطلب من زميل أو كاتب تقني تعديل الدليل وتصحيحه أيضًا. بالإضافة إلى التدقيق الإملائي والنحوي ، يجب على المدقق الانتباه إلى ما يلي:
    • المبني للمجهول
    • لغة غير واضحة أو محيرة
    • ملفوفة هيكل الجملة
    • فقرات طويلة للغاية

نصائح

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