غالبًا ما تمتلئ أدلة المستخدم ، التي غالباً ما تمتلئ بالمصطلحات اللغوية ، والمختصرات ، والاتجاهات التي تتطلب شهادة الدكتوراه ، من وجهة نظر مطور بدلاً من مستخدم. وكنتيجة لذلك ، قد يقوم الدليل بعمل افتراضات حول مستوى مهارة القارئ التي غالبًا ما تكون غير صحيحة. الخطوة الأولى في كتابة دليل المستخدم الجيد هو الحصول على عملية الكتابة الفعلية بعيدا عن المهندسين قدر الإمكان.
يعرف مطور البرامج أكثر من أي شخص ما يجعل البرنامج يعمل ، ولكن هذا لا يعني أن المطور يجب أن يكتب الدليل. على العكس ، إنه عيب متميز. الأهم من الفهم العميق للعمل الداخلي للبرنامج هو فهم من سيكون المستخدم النهائي ، ومستوى تعليمه ، وكيف سيستخدم هذا المستخدم البرنامج. في معظم الحالات ، لا يحتاج المستخدمون النهائيون إلى معرفة النقاط الدقيقة للبرمجة وعمل النهاية الخلفية للبرنامج - يحتاجون فقط إلى معرفة كيفية استخدامه لتسهيل مهامهم.
اختبار المستخدم
يجب أن يكون دليل المستخدم موجهًا بشكل كبير إلى المهام ، بدلاً من وصفه بشكل كبير. ولأن الدليل مكتوب لمساعدة المستخدمين على فهم كيفية تنفيذ مهام محددة ، يحتاج الكاتب إلى فهم هذه المهام أيضًا ، ونتيجة لذلك ، فإن المرور بكل خطوة منفصلة لكل ميزة أمر ضروري للغاية. ليس من الضروري أن يعرف الكاتب بالضرورة كيف تم إنشاء البرنامج من وجهة نظر التصميم أو التطوير ، ولكن من الضروري أن يكون لديك معرفة عملية قوية بكل ميزاته. أثناء تنفيذ كل مهمة ، خذ بعض الوقت لتدوين كل خطوة ، بما في ذلك النقرات والقوائم المنسدلة والإجراءات الأخرى.
عملية المقابلة
على الرغم من أن المطور لا ينبغي أن يكون هو الشخص الذي يكتب الدليل ، إلا أنه سيظل مصدرًا قيّمًا للكاتب ، وقبل بدء الكتابة ، يخطط لعقد اجتماع بين الكاتب والمطور والمهندسين ، والمستخدمين المحتملين للمساعدة على إبلاغ عمل الكاتب من البداية. يجب تسجيل المقابلات مع خبراء ومهندسي المواضيع ، مع نصوص مصنوعة للرجوع إليها فيما بعد.
مصور
يجب ألا يكون دليل المستخدم ثقيلًا جدًا. بدلاً من ذلك ، دمج الاستخدام الليبرالي للرسوم ومقاطع الشاشة. وصف الإجراء أكثر وضوحًا بكثير مع الاتجاهات المستندة إلى النص مصحوبة بمقطع شاشة يوضح ذلك الاتجاه بوضوح. قم بتضمين كلٍّ من قبل وبعد المشاهدات ، لإظهار شكل الشاشة قبل اتخاذ كل إجراء ، وما يحدث بعد اتخاذ الإجراء. تعمل أداة التقاط الشاشة البسيطة مثل أداة Snipping Tool المضمنة في Microsoft Windows بشكل جيد لالتقاط هذه الصور. تأكد من ترقيم كل صورة ، وتضمين تسمية توضيحية تصفها باختصار. قم بتوسيطها مباشرة تحت الفقرة التي تقدم أولاً المفهوم الموضح في الصورة.
التنسيق
يتطلب التواصل بوضوح في وثيقة فنية التخطيط والتمسك الدقيق بالمعايير في جميع أنحاء الدليل. تساعد المعايير في كل من العرض واللغة والمصطلحات في تجنب الارتباك. تتوفر النماذج ويمكن أن تكون نقطة انطلاق جيدة للوحدة ، على الرغم من أنه يمكن بالتأكيد تكييفها لتتناسب مع كل حالة. إن استخدام هامش بوصة واحدة بعمود واحد يناسب الحاجة إلى إضافة الرسومات ؛ قد يبدو إعداد العمود المكون من عمودين مزدحماً للغاية ، ويمكن أن يجعل وضع الصور مربكًا.
الإصدار والتتبع
أكثر من أي نوع آخر من المستندات ، من المرجح أن يمر دليل مستخدم البرنامج بعدة تكرارات قبل اكتماله ، ومن المرجح أن يمر بعملية مراجعة من قبل العديد من أصحاب المصلحة. يعد استخدام ميزة "تعقب التغييرات" في Microsoft Word طريقة سهلة لتتبع تعليقات وتعليقات كل فرد. كما يساعد إنشاء إصدارات متعددة بعد كل دورة مراجعة ، كل منها باسم ملف مختلف ، على المساعدة في العملية والتأكد من أن جميع أصحاب المصلحة راضون عن النتيجة النهائية.
