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