يرجى النقر هنا لمساعدة ديفيد مكْمُرّي في تغطية تكاليف استضافة الموقع:
تبرّع بأي مبلغ بسيط تستطيع تقديمه
ستبقى الكتابة التقنية عبر الإنترنت مجانية.
هذه الصفحة قيد الصيانة.
تتخذ الوثائق التقنية (بما في ذلك الكتيبات، والأوراق البيضاء، والأدلة) تصاميم مختلفة تبعًا للصناعة أو المهنة أو المؤسسة. يعرض لك هذا الفصل أحد التصاميم التقليدية. إذا كنت تدرس مقررًا في الكتابة التقنية، فتأكد من أن التصميم المعروض في هذا الفصل مقبول. وينطبق الأمر نفسه إذا كنت تكتب وثيقة تقنية في سياق علمي أو تجاري أو حكومي.
رسم معلوماتي أُنشئ بواسطة NotebookLLM لهذا الفصل
ملاحظة: لسنوات عديدة، كان هذا الكتاب الإلكتروني في الكتابة التقنية يستخدم مصطلح «تقرير» بشكل عام للإشارة إلى أي محتوى يتضمن معلومات تقنية تقريبًا. ولكن لأن «التقرير» يشير إلى نوع محدد من الوثائق التقنية، كان لا بد من التحول إلى المصطلح العام «دليل المستخدم»، وهو اختصار لعبارة «وثيقة تقنية».
تخضع أدلة المستخدم (وهو الاسم العام للوثائق التقنية) لمواصفات كما هو الحال في أي نوع آخر من المشاريع. وتشمل هذه المواصفات تخطيط الصفحة، والتنظيم والمحتوى، وتنسيق العناوين والقوائم، وتصميم الرسومات، وغير ذلك. وتكمن ميزة وجود بنية وتنسيق مطلوبين لأدلة المستخدم في أنك — أو أي شخص آخر — يمكنه توقع تصميم مألوف؛ فأنت تعرف ما الذي تبحث عنه وأين تجده. وغالبًا ما تُقرأ أدلة المستخدم على عجل — إذ يسعى الناس بسرعة إلى الوصول إلى المعلومات التي يحتاجونها، والحقائق الأساسية، والاستنتاجات، وغيرها من الأمور الجوهرية. إن تنسيق دليل المستخدم القياسي يشبه حيًا مألوفًا.
عند تحليل تصميم دليل المستخدم، لاحظ مدى تكرار بعض الأقسام. ويرتبط هذا التكرار بطريقة قراءة الناس لأدلة المستخدم. فهم لا يقرؤون الدليل من البداية إلى النهاية؛ بل قد يبدؤون بالملخص التنفيذي، ويتنقلون بين الأقسام، وربما لا يقرؤون كل صفحة. ويتمثل التحدي أمامك في تصميم أدلة المستخدم بحيث يصادف هؤلاء القرّاء الحقائق والاستنتاجات الأساسية لديك، مهما كان مقدار ما يقرؤونه من الدليل أو ترتيب قراءتهم له.
احرص على الاطلاع على أمثلة لأدلة المستخدم.
يناقش هذا الفصل المكونات القياسية للتقرير التقني النموذجي. وترشدك الأقسام التالية إلى كل واحد من هذه المكونات، مع توضيح خصائصه الأساسية. وأثناء قراءتك لهذه الإرشادات واستخدامك لها، تذكّر أنها إرشادات وليست أوامر. فالشركات والمهن والمؤسسات المختلفة لديها إرشاداتها المتنوعة الخاصة بأدلة المستخدم — وستحتاج إلى تكييف ممارستك وفقًا لها، إضافة إلى الإرشادات المعروضة هنا.
رسالة الإحالة
تكون رسالة الإحالة إما خطاب تغطية (أو مذكرة) أو رسالة بريد إلكتروني. ويُرفق الخطاب المطبوع (أو المذكرة) إما على الغلاف الخارجي لدليل المستخدم بواسطة مشبك ورق، أو يُجلّد داخل الدليل. أما البريد الإلكتروني فيتضمن رابطًا إلى دليل المستخدم أو يكون الدليل مرفقًا به. وتمثل رسالة الإحالة تواصلاً منك — بصفتك كاتب دليل المستخدم — إلى المستلم، وهو الشخص الذي طلب دليل المستخدم وربما يدفع لك مقابل استشارتك المتخصصة. وبعبارة أخرى، فهي تقول: «حسنًا، هذا هو دليل المستخدم الذي اتفقنا على أن أُنجزه بحلول تاريخ كذا. وباختصار، يتضمن كذا وكذا، لكنه لا يغطي كذا وكذا. أخبرني إن كان يلبي احتياجاتك». وتشرح رسالة الإحالة السياق — أي الأحداث التي أدت إلى إعداد دليل المستخدم — كما تتضمن معلومات عن دليل المستخدم لا ينبغي إدراجها داخله.
أمثلة على خطاب إحالة ورسالة إحالة. أمثلة على خطاب إحالة ورسالة إحالة.
في مثال خطاب الإحالة، لاحظ تنسيق خطاب الأعمال القياسي. وإذا كنت تكتب دليل مستخدم داخليًا، فاستخدم تنسيق المذكرة بدلًا من ذلك؛ وفي كلتا الحالتين، يظل المحتوى والتنظيم متماثلين:
الفقرة الأولى. تذكر اسم دليل المستخدم، مع وضعه بخط مائل، كما تشير إلى تاريخ الاتفاق على كتابة دليل المستخدم.
الفقرة الوسطى. تركز على الغرض من دليل المستخدم وتقدم عرضًا موجزًا لمحتوياته.
الفقرة الأخيرة. تشجع القارئ على التواصل في حال وجود أسئلة أو ملاحظات أو مخاوف. وتُختتم بلفتة حسن نية، مع التعبير عن الأمل في أن يجد القارئ دليل المستخدم مُرضيًا.
وكما هو الحال مع أي عنصر آخر في دليل المستخدم، قد تحتاج إلى تعديل محتوى هذه الرسالة (أو المذكرة) لتناسب مواقف معينة. فعلى سبيل المثال، قد ترغب في إضافة فقرة أخرى تسرد فيها أسئلة تود من القرّاء التفكير فيها أثناء مراجعتهم لدليل المستخدم.
الأغلفة الأمامية والخلفية، صفحة العنوان
إذا كان دليل المستخدم يتجاوز عشر صفحات، فقم بتجليده بطريقة ما وأنشئ بطاقة للغلاف.
الأغلفة الأمامية والخلفية
الغلاف الأمامي (يسارًا) الغلاف الخلفي (يمينًا)
صفحة العنوان، إشعار الإصدار، حقوق النشر، العلامات التجارية
الفصول الرئيسية لدليل المستخدم
الملاحق
الفهرس
في أبسط صورة، يكون عنوان دليل المستخدم نسخةً مما هو موجود على الغلاف الأمامي — وربما مع إضافة بعض التفاصيل.
إشعار الإصدار
جدول المحتويات
جدول المحتويات
أيًّا كان تنسيق جدول المحتويات الذي تستخدمه، فهذه هي المعايير الشائعة:
- رقم صفحة البداية فقط. على الرغم من أن بعض مولدات جداول المحتويات الآلية تعرض نطاق الصفحات، فإن المعيار هو إظهار رقم الصفحة الأولى فقط.
- مستويات العناوين التي يجب تضمينها. كما هو موضح في جدول المحتويات أعلاه، اعرض المستويين الأولين من العناوين ما لم يكن دليل المستخدم يحتوي على عدد كبير من العناوين الفرعية. ينبغي أن يوفر جدول المحتويات وسيلة سريعة للعثور على المعلومات.
- المسافات وحالة الأحرف. لاحظ كيفية إزاحة عناصر النص في جدول المحتويات أعلاه. تستخدم عناوين المستوى الأول أحرفًا كبيرة بالكامل؛ وتستخدم عناوين المستوى الثاني أحرفًا كبيرة في بداية كل كلمة رئيسية؛ وتستخدم عناوين المستوى الثالث أسلوب الجملة في الأحرف.
- التباعد الرأسي. لاحظ أن أقسام المستوى الأول تحتوي على مسافة إضافية أعلى وأسفل، مما يزيد من سهولة القراءة.
اعتمادًا على متطلبات مؤسستك، لديك خياران لتنسيق جداول المحتويات (TOC):
يستخدم جدول المحتويات هذا أسلوب الترقيم العشري لأرقام الفصول والأقسام، وهو شائع في أدلة المستخدم. وتستخدم مواضع أخرى في هذا الكتاب أسلوب الأرقام الرومانية الكبيرة للفصول ذات المستوى الأعلى فقط (انظر ).
هل تواجه صعوبة في إنشاء جدول محتويات منسق بشكل جيد؟ راجع إنشاء جدول محتويات بمظهر احترافي
الفواصل وأرقام الصفحات. إذا لم يكن تنسيق النقاط القائدة مطلوبًا وكنت تفضل تجنبه، يمكنك استخدام هذا التنسيق المقبول على نطاق واسع:
نص جدول محتويات بسيط باستخدام الفواصل وأرقام الصفحات.المقدمة التمهيدية
اطلع على هذا المثال لمقدمة تمهيدية:
إذا لم تكن هناك جداول، فاجعل العنوان «قائمة الأشكال». في مقرر الكتابة التقنية، اسأل مدرسك عما إذا كان أسلوب الترقيم العشري للعناوين مطلوبًا.
الفصول الرئيسية لدليل المستخدم
يتكوّن متن دليل المستخدم، بطبيعة الحال، من النص الرئيسي للدليل، أي الأقسام الواقعة بين المقدمة والخاتمة. وتُعرض أدناه صفحات نموذجية.
الملاحق
الملاحق هي الأقسام الإضافية التي تلي الخاتمة. ماذا تضع في الملاحق؟ — أي شيء لا ينسجم بشكل مريح مع الجزء الرئيسي من دليل المستخدم، ولكنه لا يمكن حذفه من الدليل كليًا. تُستخدم الملاحق عادةً للجداول الكبيرة من البيانات، وأجزاء كبيرة من أمثلة الشيفرة، والخرائط القابلة للطي، والخلفيات التي تكون أساسية جدًا أو متقدمة جدًا بالنسبة لمتن دليل المستخدم، أو الرسومات الكبيرة التي لا تتناسب مع المتن. وأي محتوى تشعر أنه كبير الحجم بالنسبة للجزء الرئيسي من دليل المستخدم، أو قد يشتت القارئ ويقطع تدفق الدليل، يُعد مرشحًا مناسبًا للإدراج في ملحق. لاحظ أن كل ملحق يُعطى حرفًا (A وB وC وما إلى ذلك).
الفهرس
إن توثيق مصادر المعلومات يدور كله حول ترسيخ مصداقيتك المهنية والحفاظ عليها وحمايتها. يجب عليك توثيق («إسناد») المعلومات المستعارة بغض النظر عن الشكل أو الصيغة التي تعرضها بها. سواء اقتبستها حرفيًا، أو أعدت صياغتها، أو لخصتها — فهي تظل معلومات مستعارة. وسواء جاءت من كتاب أو مقال أو مخطط أو جدول أو صفحة ويب أو كتيّب منتج أو خبير قابلته شخصيًا — فهي تظل معلومات مستعارة.
تختلف أنظمة التوثيق باختلاف المهن والتخصصات. يستخدم المهندسون نظام IEEE، وتُعرض أمثلة عليه في هذا الفصل. وهناك نظام توثيق شائع آخر تقدمه الجمعية الأمريكية لعلم النفس (APA). راجع التوثيق للتفاصيل.
عناصر أخرى في دليل المستخدم
ترقيم الصفحات
يختلف أسلوب ترقيم الصفحات المستخدم في التصميم التقليدي لأدلة المستخدم عن التصميم المعاصر، ويكمن الاختلاف الأساسي في استخدام الأرقام الرومانية الصغيرة في المواد التمهيدية (كل ما يسبق المقدمة) في التصميم التقليدي.
العناوين
في جميع أدلة المستخدم باستثناء الأقصر جدًا (صفحتان أو أقل)، استخدم العناوين لتمييز الموضوعات والموضوعات الفرعية المختلفة. تمكّن العناوين القرّاء من تصفح دليل المستخدم بسرعة والانتقال مباشرة إلى المواضع التي تقدم فيها المعلومات التي يبحثون عنها. راجع العناوين للحصول على إرشادات حول العناوين.
القوائم ذات التعداد النقطي والرقمي
في متن دليل المستخدم، استخدم أيضًا القوائم ذات التعداد النقطي والرقمي والقوائم ذات العمودين عند الاقتضاء. تساعد القوائم على إبراز النقاط الأساسية، وتسهل متابعة المعلومات، وتكسر الكتل النصية الطويلة. راجع القوائم للحصول على إرشادات حول القوائم.
الرموز والأرقام والاختصارات
تحتوي المناقشات التقنية عادةً على العديد من الرموز والأرقام والاختصارات. تذكّر أن قواعد استخدام الأرقام بدل الكلمات تختلف في العالم التقني. فالقاعدة القديمة التي تقضي بكتابة جميع الأرقام التي تقل عن 10 بالكلمات لا تنطبق دائمًا في أدلة المستخدم التقنية. (راجع الأرقام مقابل الكلمات للإرشادات.)
في مقرر الكتابة التقنية، اسأل مدرسك عما إذا كان أسلوب الترقيم العشري للعناوين مطلوبًا. كذلك، قد يُطلب نظام توثيق مختلف — وليس IEEE، المخصص للمهندسين.
الرسومات وعناوين الأشكال
في المستندات التقنية، من المرجح أن تحتاج إلى رسومات وتخطيطات وجداول ومخططات بيانية. فهذه لا تنقل أنواعًا معينة من المعلومات بكفاءة أكبر فحسب، بل تمنح دليل المستخدم أيضًا مظهرًا إضافيًا من الاحترافية والموثوقية. وإذا لم يسبق لك إدراج هذا النوع من الرسومات في دليل مستخدم، فهناك طرق سهلة نسبيًا للقيام بذلك — ولا تحتاج إلى أن تكون مصمم رسوميات محترفًا. لاستراتيجيات إضافة الرسومات إلى أدلة المستخدم، راجع الرسومات. ولاستراتيجيات إضافة الجداول إلى أدلة المستخدم، راجع الجداول.
الإحالات المتقاطعة
قد تحتاج إلى توجيه القرّاء إلى معلومات وثيقة الصلة داخل مستنداتك التقنية، أو إلى مصادر معلومات أخرى ذات صلة. وتُسمى هذه الإحالات المتقاطعة. فعلى سبيل المثال، يمكن أن تُحيل القرّاء من مناقشة آلية ما إلى رسم توضيحي لها. ويمكن أن تُحيلهم إلى ملحق يقدّم خلفية عن موضوع ما (خلفية لا تتناسب مع متن النص). كما يمكن أن تُحيل القرّاء خارج دليل المستخدم إلى معلومات أخرى — مثل المقالات وأدلة المستخدم والكتب التي تتناول موضوعات ذات صلة بموضوعك. وعند إنشاء الإحالات المتقاطعة، اتبع الإرشادات الواردة في الإحالات المتقاطعة.
- تُرقّم جميع الصفحات في دليل المستخدم (ضمن الغلافين الأمامي والخلفي، مع استثنائهما)، ولكن لا تُعرض الأرقام في بعض الصفحات.
- في التصميم المعاصر، تُستخدم الأرقام العربية في جميع صفحات المستند؛ أما في التصميم التقليدي، فتُستخدم الأرقام الرومانية الصغيرة في جميع الصفحات التي تسبق المقدمة (الصفحة الأولى من متن دليل المستخدم).
- في الصفحات الخاصة، مثل صفحة العنوان والصفحة الأولى من المقدمة، لا تُعرض أرقام الصفحات.
- يمكن وضع أرقام الصفحات في أحد المواضع المتعددة على الصفحة. وغالبًا ما يكون الخيار الأفضل والأسهل هو وضع أرقام الصفحات في منتصف أسفل الصفحة (مع تذكّر إخفائها في الصفحات الخاصة).
- إذا وضعت أرقام الصفحات في أعلى الصفحة، فيجب إخفاؤها في الصفحات الافتتاحية للفصول أو الأقسام التي يظهر فيها عنوان أو رأس في أعلى الصفحة.
ملاحظة: غالبًا ما تستخدم أدلة المستخدم الطويلة أسلوب ترقيم الصفحات المعروف باسم الترقيم المزدوج أو الترقيم حسب الفصل (على سبيل المثال، تُرقّم صفحات الفصل 2 على النحو 2-1 و2-2 و2-3، وهكذا). وبالمثل، تستخدم الجداول والأشكال هذا الأسلوب في الترقيم. ويسهّل هذا الأسلوب عملية إضافة الصفحات وحذفها.
مطالبات الذكاء الاصطناعي لأدلة المستخدم
يمكن استخدام قوائم التحقق، التي غالبًا ما لا تُقرأ، كمصدر لمطالبات الذكاء الاصطناعي مع بعض التعديل. انسخ ما يلي، والصقه في نظام ذكاء اصطناعي مثل Google Gemini، وانظر ما الذي قد تكون قد أغفلته.
ملاحظة: يمكن العثور على جميع الإشارات إلى محتوى تقارير البيانات وتنسيقها وأسلوبها أو مكوناتها في الكتاب الإلكتروني للكتابة التقنية.
| مطالبات الذكاء الاصطناعي لأدلة المستخدم |
|
معلومات ذات صلة
كيفية كتابة موضوعات مساعدة سهلة الاستخدام للمبتدئين. clickhelp.com
سأكون ممتنًا لآرائك وردود فعلك وملاحظاتك النقدية حول هذا الفصل: إرسالك—David McMurrey.
