استخدم هذا القالب
يحوّل دليل المستخدم البرمجي الرائع المستخدمين المربكين إلى مستخدمين واثقين. باستخدام Trupeer، يمكنك توفير ساعات في كتابة توثيق البرامج من خلال البدء بقالب مجاني لدليل المستخدم للبرامج، وتخصيصه باستخدام إرشادات العلامة التجارية الخاصة بك، واستخدام منشئ الدليل بالذكاء الاصطناعي لتحويل جولات المنتج إلى أدلة فيديو مصقولة.
ما هو قالب دليل المستخدم البرمجي المجاني؟
قالب دليل المستخدم البرمجي المجاني هو بنية قابلة لإعادة الاستخدام لوثيقة كاملة ومُرقّمة بالإصدارات تصف كيفية استخدام أحد البرامج، ويتم تقديمها كمنتج نهائي بدلًا من كونها موقعًا حيًا.
هذا الفرق هو سبب استمرار وجود هذه الوثيقة في عالم مواقع المساعدة. تُنتَج الأدلة عندما يتطلب التوثيق أن يكون كاملًا وثابتًا وشاملًا بذاته: برنامج يتم تسليمه على الخادم المحلي، ومنتجات تُباع في بيئات خاضعة للتنظيم، وأنظمة تعمل على شبكات دون وصول خارجي، وعقود يكون فيها الدليل بندًا مُسمّى كمنتج تسليم.
إذا كان برنامجك منتجًا مستضافًا ووصل مستخدموك إلى التوثيق عبر محرك بحث أو رابط مساعدة داخل المنتج، فأنت تريد موقع مساعدة وليس دليلًا، وتغطي صفحة دليل المستخدم البرمجي كيفية تنظيم ذلك.
القالب ليس الدليل. قوائم الأقسام في الأدلة منشورة على نطاق واسع وقابلة للتبديل إلى حد كبير. ما يحدد ما إذا كان الدليل يعمل فعليًا هو كيفية تعامله مع المشكلة أدناه، والتي لا تواجهها مواقع المساعدة تقريبًا ولا يتناولها أي قالب تقريبًا.
يتبع التنسيق طريقة التسليم. ملف Word لقالب دليل المستخدم البرمجي المجاني هو المكان الذي تُكتب فيه هذه الأمور وتُراجع. ملف PDF لقالب دليل المستخدم البرمجي المجاني هو ما يتم إرساله، لأن الدليل سجل ثابت وPDF هو التنسيق الشائع الوحيد الذي يتصرف مثل سجل ثابت. يناسب تخطيط PPT لقالب دليل المستخدم البرمجي المجاني التدريب المستمد من الدليل، ويُناسب ملف Excel لقالب دليل المستخدم البرمجي المجاني جرد المحتوى الموجود خلفه بدلًا من الوثيقة نفسها.
الدليل لقطة، وموقع المساعدة بثّ
لموقع المساعدة إصدار واحد: الإصدار الحالي. عندما يتغير البرنامج، تتغير الصفحة، ويرى كل قارئ الصفحة الجديدة. لا تبقى الإصدارات القديمة لأن هناك نسخة واحدة فقط دائمًا.
يتصرف الدليل بطريقة عكسية. أنت تُنتجه، وتُرسله، ومن تلك اللحظة تصبح النسخ موجودة بشكل مستقل عنك. تُخزّن على خوادم ملفات العملاء، وفي مجلدات مطبوعة، ومرفقة برسائل بريد إلكتروني قديمة، وداخل سجلات المشتريات. لا يمكنك تحديثها وغالبًا لا يمكنك معرفة من يملك أي نسخة.
وفي الوقت نفسه، يتقدم البرنامج. خلال بضع سنوات، يصبح لديك قاعدة عملاء موزعة عبر إصدارات متعددة، وكلهم يقرأون وثائق تم إنتاجها في أوقات مختلفة، ولا توجد طريقة موثوقة لمعرفة أي وثيقة يحملها أي قارئ بعينه.
هذه هي المشكلة الحاسمة في دليل المستخدم البرمجي، وهي غائبة تمامًا عن موقع المساعدة. كل قرار تصميم أدناه نابع منها.
كيفية تخصيص هذا القالب في Trupeer
الخطوة 1: افتح قسم القوالب
انتقل إلى قسم القوالب من التنقل الرئيسي.
الخطوة 2: اختر قالبًا وافتحه
انقر على أي قالب تريد العمل عليه لفتحه.
الخطوة 3: وسّع عرض القالب
إذا لزم الأمر، وسّع عرض القالب لرؤية التخطيط الكامل والتفاصيل بوضوح.
الخطوة 4: عدّل القالب
انقر على تحرير لبدء تعديل القالب المحدد.
داخل المحرر، يمكنك:
إضافة أقسام جديدة
تحديد أو تحديث قواعد التنسيق
إضافة شعار وضبط موضعه والإعدادات ذات الصلة
الخطوة 5: احفظ قالبك المخصص
بعد إجراء جميع التغييرات اللازمة، انقر على حفظ لتخزين القالب المحدث كقالبك الخاص.
الخطوة 6: المعاينة والضبط الدقيق للقالب
عندما تريد معرفة كيف يبدو قالبك المخصص، افتح المعاينة.
من شاشة المعاينة، يمكنك الاستمرار في إجراء تعديلات مباشرة إذا لزم الأمر، لضمان ظهور القالب تمامًا كما تريد.
باستخدام قالب دليل مستخدم برمجي يمكنك:
توفير ساعات في الكتابة: تخطَّ الصفحة الفارغة ببنية مصممة لتوثيق البرامج.
تقليل تذاكر الدعم: تساعد الأدلة الواضحة المستخدمين على حل المشكلات ذاتيًا - مما يقلل التذاكر بشكل كبير.
الالتزام بالهوية: طبّق شعارك وخطوطك وألوانك باستخدام حزمة العلامة التجارية من Trupeer.
تحسين التبنّي: المستخدمون الذين يفهمون كيفية استخدام برنامجك يستخدمونه أكثر - ويبقون لفترة أطول.
إضافة جولات فيديو: تضمين فيديو للخطوات التي يصعب شرحها بالنص.
الوصول إلى مستخدمين عالميين: ترجمة أدلة المستخدم إلى 65+ لغة بنقرة واحدة.
مشكلة الإصدارات، وما الذي يمكنك فعله حيالها
تتكرر ثلاث حالات فشل، وكل واحدة منها سهلة المنع عند مرحلة الكتابة.
لا يعرف القارئ أي إصدار يصفه دليله. تحمل معظم الأدلة رقم الإصدار على الغلاف ولا يوجد في أي مكان آخر. قارئ يفتح ملف PDF ويبحث داخله، وهو ما يفعله الناس، يصل إلى الصفحة الرابعة والتسعين ولا يرى الغلاف أبدًا. ضع رقم إصدار البرنامج في تذييل كل صفحة. يكلف هذا خانة واحدة في القالب ويزيل أكثر شكل شائع للمشكلة.
لا يعرف القارئ أي إصدار يشغّله. اذكر كيفية التحقق، في الصفحات الأولى، في سطر واحد. تفترض معظم الأدلة أن القارئ يعرف، وكثير من المستخدمين لا يعرفون.
لا يذكر الدليل متى ظهرت ميزة. يتبع قارئ على إصدار أقدم تعليمات لشيء لم يكن موجودًا بعد، ويستنتج أن البرنامج معطّل، ثم يتواصل مع الدعم. علّم الميزات بالإصدار الذي ظهرت فيه، وعلّم أي شيء تغيّر سلوكه بالإصدار الذي حدث فيه التغيير. هذا يتطلب عملًا أكثر من الحالتين الأخريين، لكنه يمنع حالات الفشل المكلفة.
أضف شيئًا آخر واحدًا، ليس عن القارئ بل عنك أنت. احتفظ بكل إصدار منشور من الدليل متاحًا على موقع الدعم بدلًا من أحدث إصدار فقط. يحتاج عميل على إصدار أقدم إلى الدليل الخاص بذلك الإصدار، واستضافة أحدث إصدار فقط تضمن أنهم سيستخدمون الوثيقة الخاطئة.
ما الذي يجب أن يحتويه دليل المستخدم البرمجي
عشرة مكونات. أول اثنين وآخر اثنين هما ما يميز الدليل عن موقع المساعدة.
المكوّن | ما الذي يفعله |
|---|---|
الإصدار وقابلية التطبيق | إصدار البرنامج، ومراجعة الدليل، وتاريخ النشر. على الغلاف وفي تذييل كل صفحة. |
كيفية التحقق من إصدارك | فقرة واحدة، بالقرب من البداية، حتى يتمكن القارئ من التأكد أنه يملك الدليل الصحيح. |
ما الذي تغيّر في هذه المراجعة | قائمة قصيرة، حتى يتمكن القارئ العائد من العثور على الاختلافات دون إعادة القراءة. |
الجمهور المستهدف والمعرفة المفترضة | مذكور بوضوح، لأن الدليل يُقرأ من قِبل أشخاص لا توجد لديهم طريقة لطرح سؤال عليك. |
البدء | أقصر طريق للوصول إلى نتيجة واحدة تعمل. |
فصول المهام | مرتبة حسب ما يفعله المستخدمون بدلًا من بنية قائمة المنتج. |
أقسام المراجع | الإعدادات، الحقول، رسائل الخطأ، اختصارات لوحة المفاتيح. يتم الرجوع إليها بدلًا من قراءتها. |
استكشاف الأخطاء وإصلاحها | مشكلات حقيقية من تذاكر الدعم، مع حلولها. |
المحتويات الكاملة والفهرس | يُستخدم الدليل عبر البحث والفهرس، لذا يجب أن يكون كلاهما حقيقيًا وليس مجرد زينة. |
مسارات الدعم والتواصل | كيفية الحصول على المساعدة، لأن الدليل المُرسل غالبًا هو الشيء الوحيد الذي يمتلكه المستخدم. |
تجدر الإشارة صراحةً إلى شرط الاكتمال. لا يمكن للدليل أن يرتبط بمحتوى حي لأي شيء يحتاجه القارئ فعليًا، لأن الدليل قد يُقرأ في بيئة دون وصول إلى الشبكة أو بعد انتقال الصفحة المرتبطة. كل ما هو ضروري موجود داخل الوثيقة.
قالب دليل المستخدم البرمجي المجاني: البنية التي تنسخها
مملوء بمثال حقيقي بدلًا من العناصر النائبة. البرنامج هو نظام معلومات مختبر يتم تسليمه على الخادم المحلي.
انسخ من هنا.
الغلاف. اسم المنتج. إصدار البرنامج 11.2. مراجعة الدليل C. نُشر في 14 مارس. ينطبق على الإصدارات 11.0 حتى 11.2 فقط.
تذييل الصفحة، في كل صفحة. اسم المنتج، إصدار البرنامج 11.2، المراجعة C، رقم الصفحة. هذا هو السطر الأكثر فائدة في الوثيقة.
كيفية التحقق من إصدارك. اختر مساعدة، ثم حول. يظهر الإصدار كرقم مثل 11.2.4. إذا لم تكن أول رقمين 11.2، فهذا الدليل لا يصف نظامك، والدليل الصحيح لإصدارك موجود على موقع الدعم ضمن Documentation Archive.
ما الذي تغيّر في المراجعة C. أصبح الأرشفة قابلة للعكس في الإصدار 11.0. في الإصدارات الأقدم، تكون الأرشفة دائمة ولا يمكن التراجع عنها من داخل التطبيق. راجع الفصل التاسع. اكتسبت إعادة تسمية العينات خطوة تأكيد ثانية في 10.4.
الجمهور المستهدف. موظفو المختبر الذين يقومون بالتعامل الروتيني مع العينات وإعداد التقارير. يفترض أنك تم تزويدك بحساب مستخدم وأنك أكملت التهيئة المحلية. لا يغطي إدارة النظام، والتي موجودة في دليل المسؤول.
البدء. تسجيل الدخول، الشاشة الرئيسية، وإكمال تسجيل عينة واحدة من البداية إلى النهاية.
فصول المهام. مرتبة حسب ما يفعله الأشخاص. تسجيل العينات. تسجيل النتائج. إعداد التقارير. البحث في السجلات التاريخية. الأرشفة. توضح كل صفحة مهمة ما تفترضه وتحمل قابلية التطبيق للإصدار في التذييل.
مؤشرات توفر الميزات. تُستخدم في كل مكان، بالشكل: متاح من الإصدار 10.4. تغيّر السلوك في الإصدار 11.0. تظهر هذه بجانب التعليمات ذات الصلة بدلًا من أن تكون في ملحق.
المرجع. تعريفات الحقول، رموز الحالة، رسائل الخطأ مع معانيها، اختصارات لوحة المفاتيح.
استكشاف الأخطاء وإصلاحها. اثنا عشر إدخالًا مأخوذة من قائمة انتظار الدعم، لكل منها عرض للأعراض، والسبب المحتمل، والحل.
الفهرس. حقيقي ويغطي المصطلحات التي يستخدمها المستخدمون بالإضافة إلى المصطلحات التي يستخدمها الواجهة، بحيث يجد القارئ الذي يبحث عن استرداد المبلغ صفحة ملاحظة الائتمان.
الدعم. الهاتف، البوابة، ساعات العمل، وما المعلومات التي يجب تجهيزها. تم تضمينه لأن المستخدم الذي يقرأ هذا قد لا يكون لديه مسار آخر.
انسخ إلى هنا.
مثال دليل مستخدم برمجي: واحد وستون بالمئة على إصدار مختلف
Denholm Clinical Systems، وهي شركة تضم حوالي مئة وعشرين شخصًا، توفر نظام معلومات مختبر للمستشفيات والمعامل الخاصة. يتم تثبيت البرنامج في مقر العملاء ويقوم العملاء بالترقية وفق جداولهم الخاصة.
امتد الدليل إلى مئتين وأربعين صفحة، وتم إنتاجه كملف PDF وإصداره مع كل نسخة. كان مكتوبًا بشكل جيد وكاملًا.
استضاف موقع الدعم دليلًا واحدًا: الأحدث.
كان واحد وستون بالمئة من قاعدة التثبيت يعمل على إصدار أقدم من الإصدار الذي يصفه الدليل الحالي. كانت عدة مواقع متأخرة بإصدارين رئيسيين، وهو أمر غير مميز في هذا القطاع، حيث تتطلب الترقيات التحقق.
احتاج مختبر يعمل على الإصدار 8.4 إلى أرشفة أربعة عشر شهرًا من السجلات التاريخية. فتحوا الدليل الحالي، مراجعة إصدار 11.2، وقرأوا فصل الأرشفة. ذكر أن السجلات المؤرشفة يمكن استعادتها من تبويب Archive في أي وقت.
كان ذلك صحيحًا من الإصدار 11.0 وما بعده. على 8.4، كانت الأرشفة دائمة.
قاموا بأرشفة أربعة عشر شهرًا من السجلات. لم تكن هناك استعادة. تطلبت عملية الاسترداد الاستعادة من النسخ الاحتياطي، ما استغرق ثلاثة أيام من توقف المختبر عن العمل ومهندسًا من المورد في الموقع، وتكلف حوالي ستة وأربعين ألف جنيه إسترليني بين أعمال الاسترداد وتعطّل الخدمة. تلت ذلك شكوى رسمية، وتم تبريرها.
لم يكن في الدليل أي شيء غير دقيق. كانت كل عبارة فيه صحيحة بالنسبة للإصدار 11.2. قال الغلاف 11.2. بحث القارئ في ملف PDF، ووصل إلى الصفحة المئة وواحد وأربعين، وقرأ تعليمات صحيحة لبرنامج لم يكن يشغّله.
تلت ذلك ثلاث تغييرات ولم يكن أي منها مكلفًا.
تم وضع رقم الإصدار في تذييل كل صفحة. وُضعت تعليمات من سطر واحد حول كيفية التحقق من إصدارك في مقدمة الدليل. اكتسبت الميزات والسلوكيات مؤشرات توفر، لذا أصبح فصل الأرشفة الآن يذكر أن الاستعادة متاحة من الإصدار 11.0 وأن الأرشفة دائمة في الإصدارات الأقدم.
كان التغيير الرابع هو الاستضافة. تم وضع كل مراجعة دليل منشورة على موقع الدعم ضمن أرشيف التوثيق، بحيث يمكن لعميل على 8.4 العثور على دليل 8.4.
انخفضت تذاكر الدعم الناتجة عن الالتباس حول الإصدار من حوالي ثلاثة وعشرين تذكرة شهريًا إلى أربع تذاكر.
لم يكن القارئ قد فعل شيئًا خاطئًا. لقد استخدم الدليل الوحيد الذي أتاحه المورد.
كيفية كتابة دليل مستخدم برمجي في ست خطوات
قرر ما إذا كنت تحتاج دليلًا فعلًا. إذا كان لدى مستخدميك وصول إلى الشبكة ويصلون إلى التوثيق عبر البحث، فإن موقع المساعدة يخدمهم بشكل أفضل. الأدلة مخصصة لوثائق يتم إرسالها وتكون ثابتة وكاملة.
صلح مخطط الإصدارات أولًا. ما هي إصدارات البرامج التي يغطيها هذا الدليل، وما هو ترقيم مراجعة الدليل نفسه. كلاهما يوضع في التذييل.
هيكل حسب المهمة وليس حسب القائمة. بنية قائمة المنتج تصف كيفية بنائه. يصل المستخدمون وهم يحاولون القيام بشيء ما.
علّم التوفر أثناء الكتابة. ملاحظة أن ميزة وصلت في إصدار محدد أمر بسيط أثناء الكتابة، ويكاد يكون مستحيلًا إعادة بنائه لاحقًا.
خذ قسم استكشاف الأخطاء وإصلاحها من قائمة انتظار الدعم. أكثر تذاكرَك شيوعًا هي الفصل، وقد تم ترتيبها مسبقًا بالأولوية.
أنشئ فهرسًا حقيقيًا. يشمل الكلمات التي يقولها المستخدمون بدلًا من الكلمات التي يستخدمها الواجهة فقط. في وثيقة يتم إرسالها، يكون الفهرس هو وظيفة البحث.
الخطوة الرابعة هي التي يتم تأجيلها غالبًا، وهي التي تمنع حالات الفشل التي تكلف المال.
متى تحتاج دليلًا بدلًا من موقع مساعدة
خمسة حالات يكون فيها الدليل هو الإجابة الصحيحة، وخارجها غالبًا يفوز موقع المساعدة.
يتم تسليم البرامج على الخادم المحلي، ويتم ترقيتها وفق جدول العميل. يتم توزيع مستخدميك عبر إصدارات مختلفة ولا يمكن خدمتهم جميعًا بصفحة واحدة حالية.
بيئات دون وصول إلى شبكة خارجية. مرافق آمنة، أنظمة تحكم صناعية، أجهزة طبية، الدفاع. يجب أن يكون التوثيق موجودًا محليًا وكاملًا.
منتجات خاضعة للتنظيم. عندما يكون التوثيق جزءًا مما تم تقييمه أو اعتماده، يجب أن يكون ثابتًا ومُرقّمًا بالإصدارات وقابلًا للاسترجاع. غالبًا ما تتطلب البيئات المُعتمدة الدليل الخاص بالإصدار المُعتمد تحديدًا. يجب مراجعة أي دليل يشكل جزءًا من تقديم تنظيمي أو منتج مُعتمد مقابل المعيار المعمول به بواسطة شخص مؤهل، ولا شيء في هذه الصفحة يُغني عن ذلك.
مخرجات تعاقدية. عندما يكون الدليل عنصرًا مُسمّى في عقد أو جدول مشتريات، فإن متطلبات العقد تحكم تنسيق المحتوى ومضمونه.
منتجات لا يوجد لدى المستخدم فيها مسار دعم. التوزيع المادي، مبيعات لمرة واحدة، معدات طويلة العمر. الدليل هو كل ما سيحصلون عليه إلى الأبد.
أفضل قالب مجاني لدليل المستخدم البرمجي لأي من هذه الحالات هو أي قالب ينجو من إعادة إصداره أربع مرات في السنة. إذا لم ينطبق أي منها، فالإجابة الصادقة هي أنك تنتج دليلًا عادةً، وسيخدم موقع المساعدة مستخدميك بشكل أفضل ويكلفك أقل في الصيانة.
دليل مستخدم برمجي أم دليل مستخدم أم دليل تعليمات؟
ثلاث مصطلحات تتداخل في الاستخدام، والاختلافات التي تستحق معرفتها عند اختيار البنية.
يُعد دليل المستخدم البرمجي وثيقة كاملة ومُرقّمة بالإصدارات ويتم تسليمها. يفترض أن القارئ قد لا يكون لديه أي مورد آخر ولا توجد لديه طريقة لطرح سؤال.
يُعد دليل المستخدم البرمجي نفس المحتوى في تقليد الويب عبر الإنترنت مع تحديث مستمر، ويتم الوصول إليه عبر البحث ويتم الحفاظ عليه صفحة بصفحة. تنطبق قواعد هيكل مختلفة، موضحة في صفحة دليل المستخدم البرمجي.
عادةً ما يرافق دليل التعليمات معدات مادية، حيث تنطبق محتويات السلامة، ومكان وضع التحذيرات، والالتزامات النظامية التي لا يحملها توثيق البرامج. تغطي صفحة دليل التعليمات هذا التقليد.
في الواقع، تحتاج الفرق غالبًا إلى كليهما: دليل وموقع مساعدة، حيث يتم توليد الدليل من نفس محتوى المصدر عند الإصدار. هذا هو الترتيب الذي يستحق السعي إليه، لأن الحفاظ على مجموعتين مستقلتين من التوثيق ينتج عنه مجموعتان تتعارضان.
ما الذي لا يمكن لقالب دليل المستخدم البرمجي المجاني إصلاحه
دليل واحد لعدة إصدارات. لا تحل أي بنية هذه المشكلة. الحل الوحيد هو نشر دليل لكل إصدار والاحتفاظ بالأرشيف.
دليل لا يستطيع أحد العثور عليه. إن استضافة أحدث مراجعة فقط تضمن أن العملاء على الإصدارات الأقدم سيقرؤون الوثيقة الخاطئة.
لقطات شاشة من إصدار سابق. كل صورة في دليل مثبتة على إصدار، وهذا حجة لتمييزها ولنهج الإنتاج أدناه.
معلومات الإصدار التي لم يطلبها القالب أبدًا. لا يوجد تنزيل مجاني لقالب دليل المستخدم البرمجي المجاني ولا يوجد تنزيل مجاني لقالب دليل المستخدم يحمل حقل قابلية التطبيق للإصدار، لأن قوالب الأدلة صُممت لمنتجات لا تتغير.
وثيقة تم تجميعها من موقع مساعدة دون تعديل. تفترض الصفحات على الإنترنت أن الروابط تعمل وأن المحتوى حديث. عند تصديرها إلى وثيقة ثابتة، تفشل كلتا الافتراضين، ويظهر الناتج كأنه موقع ويب مطبوع لأنه كذلك.
أظهر البرنامج بدلًا من وصفه
تحمل الأدلة عبئًا بصريًا أكبر من أي تنسيق توثيق آخر، وذلك لسبب محدد يتعلق بكيفية تسليمها.
يمكن لصفحة مساعدة أن ترتبط بفيديو. غالبًا لا يمكن للدليل ذلك، لأنه قد يُقرأ دون اتصال بالإنترنت، في بيئة آمنة، أو بعد سنوات من توقف عمل الرابط. لذلك يجب أن يكون كل ما يحتاجه القارئ داخل الوثيقة، وهذا يعني صورًا بدلًا من روابط، ويمكن لدليل من مئتي صفحة أن يحمل عدة مئات منها.
ثم تتضاعف مشكلة الإصدارات. كل صورة مثبتة على الإصدار الذي تم التقاطها عليه، لذا يعني الإصدار الرئيسي الجديد إعادة التقاط المجموعة. لهذا السبب غالبًا ما تُرسل الأدلة بصور متأخرة بإصدارين، ولهذا السبب يتوقف القراء عن الوثوق بها.
يغيّر Trupeer AI الحسابات. يقوم شخص بتنفيذ المهمة مرة واحدة على الإصدار الذي يتم توثيقه، أثناء التسجيل، ويكون الناتج عبارة عن جولة مكتوبة خطوة بخطوة مع صور تم التقاطها مسبقًا بالفعل، ومُعلّمة ومُوضوعة، إلى جانب فيديو، ضمن علامتك التجارية الخاصة. يعني إنتاج مجموعة الصور لإصدار جديد إعادة التسجيل بدلًا من إعادة تصوير عدة مئات من الشاشات.
سجّلها. اجعلها بعلامتك. ترجمها. اجعلها Trupeer.
هناك نقطتان إضافيتان تهمان الأدلة تحديدًا. يمكن أن يرافق إصدار الفيديو الدليل على موقع الدعم للعملاء الذين لديهم وصول إلى الشبكة، لذا يخدم نفس الإنتاج مساري التسليم دون مضاعفة العمل. وعندما يتم تسليم المنتج دوليًا، ينتج نفس التسجيل محتوى الدليل نفسه بكل لغة، وهذا أهم هنا منه في موقع المساعدة، لأن الدليل المُرسل بلغة خاطئة لا يمكن تصحيحه بهدوء لاحقًا.
توجد المواد في قاعدة المعرفة لديك، وتعمل أيضًا كـ تدريب لموظفي الدعم وفِرق التنفيذ. تنتمي إجراءات التشغيل الخاصة بمن يشغّل البرنامج إلى runbook. إن الاتساق عبر وثائقك مسألة ضبط حزمة العلامة التجارية مرة واحدة، ويتم تغطية إعدادها في دليل إعداد قالب الوثيقة.
الأسئلة الشائعة
هل يوجد إصدار Word لقالب دليل مستخدم برمجي مجاني؟
يُكتب في Word أدلة المستخدم، ويتم مراجعتها وتحديثها، وهو يتعامل مع الأشياء التي تحتاجها الأدلة: جدول محتويات حقيقي، وفهرس، وإحالات مرجعية متقاطعة، وترقيم الصفحات، وتذييلات الصفحات.
يُعد التذييل الإعداد الذي يستحق أن تجعله صحيحًا. ضع رقم إصدار البرنامج ومراجعة الدليل فيه قبل أن تكتب أي شيء، بحيث تحمل كل صفحة هذه المعلومات. ملف Word لقالب دليل المستخدم البرمجي المجاني بدون معلومات الإصدار في التذييل سيُنتج المشكلة الموضحة في هذه الصفحة.
هل يوجد إصدار Word لقالب دليل مستخدم للاستخدام العام؟
نعم، وتتوفر قوالب للاستخدام العام على نطاق واسع. عادةً ما يوفر ملف Word لقالب دليل المستخدم غلافًا، ومحتويات، وفصولًا، واستكشاف أخطاء وإصلاحها، وفهرسًا، وهي بنية هيكلية معقولة.
تحتاج إلى إضافتين تحديدًا للبرامج. قابلية التطبيق للإصدار في تذييل الصفحة، وطريقة لتحديد متى ظهرت ميزة. لا تتوفر أي منهما في القوالب العامة لأن أيًا منهما لا يهم في وثيقة تصف شيئًا لا يتغير.
هل يوجد إصدار PDF لقالب دليل مستخدم برمجي مجاني؟
يُرسل PDF. اكتب في وثيقة، ثم صدّر ملف PDF لقالب دليل المستخدم البرمجي المجاني للتسليم، مع ظهور رقم الإصدار والمراجعة في كل صفحة بدلًا من الغلاف فقط.
تفصيلان إنتاجيان. أنشئ إشارات مرجعية حقيقية من العناوين، لأن القراء يتنقلون في ملفات PDF الطويلة بهذه الطريقة. وتأكد أن النص قابل للبحث وليس صورة، وهو ما يحدث أحيانًا عندما يتم تجميع الأدلة من أدوات التصميم.
من أين يمكنني الحصول على تنزيل مجاني لقالب دليل المستخدم؟
متاح على نطاق واسع، بما في ذلك من الهيئات المعتمدة وجهات عامة، وغالبًا ما تكون إصداراتها مُنظمة بشكل أفضل من مواقع القوالب التجارية لأنها كُتبت لتُستخدم.
أيًا كان تنزيل قالب دليل المستخدم المجاني الذي تبدأ منه، فإن أول تعديل هو التذييل. والثاني هو إضافة قسم قصير بالقرب من البداية يوضح للقارئ كيفية التحقق من إصدار البرنامج الذي يشغّله، وهو ما لا يتضمنه تقريبًا أي قالب، وما يمنع الفئة الأكثر شيوعًا من تواصل الدعم المرتبط بالأدلة.
هل يوجد إصدار PPT لقالب دليل مستخدم برمجي مجاني؟
تصلح الشرائح للتدريب المبني من دليل وليس للعرض نفسه. يعمل ملف PPT لقالب دليل المستخدم البرمجي المجاني كجلسة تعريفية أو يوم تدريب للعميل.
لا يُعد بديلًا عن الوثيقة. يوجد الدليل ليكون كاملًا وقابلًا للبحث لشخص لا يملك أي مورد آخر، بينما لا تكون مجموعة الشرائح كذلك.
هل يوجد إصدار Excel لقالب دليل مستخدم برمجي مجاني؟
يناسب Excel جرد المحتوى خلف الدليل أكثر من الدليل نفسه. يعمل ملف Excel لقالب دليل المستخدم البرمجي المجاني بشكل جيد كسجل للمحتوى: صف واحد لكل قسم، مع مالكه، والإصدار الذي تم التحقق منه آخر مرة، وما إذا كانت صوره حديثة، وإلى أي إصدارات المنتج ينطبق.
هذا السجل هو ما يجعل تحديث الإصدار قابلاً للإدارة. وبدونه، يعني تحديث دليل من مئتي صفحة لإصدار جديد إعادة قراءة كل شيء.
هل يوجد تنزيل مجاني لقالب دليل مستخدم برمجي يستحق الاستخدام؟
تستغرق قائمة الأقسام نصف ساعة لبنائها، ومعظم القوالب المنشورة متشابهة جدًا، لذا فإن تنزيل قالب دليل المستخدم البرمجي المجاني لا يوفر الكثير.
قيّم أيًا منها على سؤال واحد. هل يحتوي على مكان لقابلية تطبيق الإصدار في الصفحة وليس على الغلاف فقط؟ عمليًا لا يوجد أي منها، لأن معظم قوالب الأدلة صُممت لمنتجات لا تتغير، والبرامج تتغير.
ما هو أفضل قالب مجاني لدليل مستخدم برمجي؟
أفضل قالب مجاني لدليل مستخدم برمجي هو أي قالب يمكنك إدخال تذييل الإصدار فيه والحفاظ عليه عبر الإصدارات، وهذا عمليًا يعني وثيقة بسيطة وليست مصممة بشكل كبير.
تبدو القوالب المصممة بشكل كبير أفضل، لكنها أصعب بكثير في التحديث، ودليل يصعب تحديثه هو دليل يتم إرساله وهو يصف الإصدار السابق. بالنسبة لوثيقة يتم إصدارها عدة مرات في السنة، تتفوق قابلية الصيانة على المظهر.
