يرجى النقر هنا للمساعدة ديفيد ماكموري ادفع مقابل استضافة الويب:
تبرع بأي مبلغ صغير يمكنكه
ستظل الكتابة التقنية عبر الإنترنت مجانية.
تحت الصيانة هذه الصفحة.
أ دليل المستخدم هو وثيقة تقنية تشرح كيفية تنفيذ المهام الشائعة بواسطة مستخدم منتج. شائع مهام هي تلك الإجراءات التي يحتاج المستخدم إلى القدرة على تنفيذها. الـ مستخدم يتمتع بمستوى من المعرفة والخبرة المقصود من قبل المنتج. بعض المنتجات لها مستخدمون أساسيون ومستخدمون متقدمون—يمكن أن يلبي دليل المستخدم أحد هذه الاحتياجات أو كليهما. فكر في فرن الميكروويف: يمكن أن يكون له مستخدم أساسي، وهذا كل شيء. من ناحية أخرى، يمكن أن يحتوي منتج تصميم جرافيك على كل من المستخدمين الأساسيين والمستخدمين المتقدمين.
إنفوغراف تم إنشاؤه بواسطة NotebookLLM لهذا الفصل
في هذا الفصل، تصميم الكتاب يعني المحتوى والأسلوب والتنظيم والتصميم و تسلسل المكونات النموذجية المختلفة لكتاب ما. تشير "المكونات" هنا إلى الأقسام الفعلية أو الصفحات في الكتاب مثل إشعار الطبعة، المقدمة، الفهرس، أو الغلاف الأمامي أو الخلفي. في الـ تصميم الصفحة الفصل، المصطلح عنصر تشير إلى الأشياء التي يمكن أن تحدث عدة مرات في أي مكان في الكتاب، مثل العناوين، الهوامش، الجداول، الرسوم التوضيحية، القوائم، الإشعارات، التمييز، وما إلى ذلك.
يوفر ما يلي نظرة عامة على المكونات النموذجية لكتاب تقني مطبوع والمحتوى والنمط والتنسيق وتسلسل تلك المكونات. بالتأكيد، لا توجد دليل مستخدم واحد، أو دليل مرجعي تقني، أو وثيقة مرجعية سريعة، أو أي وثيقة أخرى مماثلة تحتوي فعليًا على جميع هذه المكونات مصممة ومتسلسلة بالضبط كما ستقرأ. بدلاً من ذلك، ستقدم هذه المراجعة نظرة عامة على الاحتمالات—دعنا نقول نطاق الاحتمالات.
ملحوظة: حالياً، لدينا فقط مثال واحد. دليل المستخدم تم تطويره في FrameMaker ثم تم إخراجه إلى PDF. يفتقر إلى مسرد، ولكن جميع الأجزاء الأخرى من دليل المستخدم النموذجي موجودة. (لا أستطيع تحديد "d" في "Filepad"!) كن على علم أنه لا يستخدم بعض متطلبات الخط والهوامش المدرجة أدناه.
قبل أن تبدأ في قراءة ما يلي، احضر عددًا من كتب الأجهزة والبرامج حتى تتمكن من مقارنة محتواها وأسلوبها وتنسيقها وتسلسلها مع ما يتم مناقشته هنا.
للحصول على مزيد من التفاصيل أكثر مما تراه هنا، يرجى الرجوع إلى هذين الموردين القياسيين في الصناعة:
- منشورات Sun الفنية. اقرأني أولاً! أي إصدار حديث. برنتيس هول.
- شركة مايكروسوفت. دليل مايكروسوفت الأسلوب للنشر الفني. أي إصدار حديث. مطبعة مايكروسوفت.
يمكنك رؤية أمثلة على مكونات هذه الكتب في تصميم الوثائق التقنية.
الغطاء الأمامي والخلفي
documents المنتج للعملاء الذين يدفعون عادة ما تحتوي على أغلفة أمامية مصممة بشكل جميل حتى لو كان الكتاب من الداخل ذو جودة رديئة. على الغلاف الأمامي، سترى عادةً بعض أو كل ما يلي:
- اسم الشركة
- اسم المنتج
- منصة المنتج أو نظام التشغيل
- إصدارات المنتج وأرقام الإصدار
- عنوان الكتاب
- شعارات الشركات أو المنتجات
- رموز العلامات التجارية
- فَنّ
- رقم طلب الكتاب
- شعار الشركة أو المنتج
قد يكون من الصعب تحديد التنسيق الجيد لاسم الشركة، اسم المنتج، وعنوان الكتاب. في بعض الأحيان، يمكن أن تصل هذه إلى فقرة كاملة من النص! تتباين الشركات بشكل كبير حول ما إذا كان يجب الإشارة إلى أرقام الإصدار والإطلاق على الأغطية الأمامية—بعضها يفعل؛ والبعض الآخر لا يفعل. ولكن، في معظم الأحيان، سترى النظام الأساسي محددًا—سواء كان المنتج مخصصًا لمستخدمي الماكنتوش، الحاسوب الشخصي، يونكس، وهكذا.
مثال على صفحة الغلاف.
عادةً ما تكون الغلاف الخلفي لدليل المستخدم و الكتيبات المطبوعة بسيطة جداً. عادةً ما يحتوي على رقم طلب الكتاب، واسم الشركة مع الرموز التجارية المناسبة، ورمز حقوق الطبع والنشر وعبارة تتعلق بملكية الكتاب، وبيان عن الدولة التي تم طباعة الكتاب فيها. ستجد أيضًا رموز شريطية على الغلاف الخلفي. تحقق مما إذا كان بإمكان برنامجك توليد رمز شريطي —فقط قم بالوصول إلى أداة رمز الشريط واكتب رقم طلب الكتاب، وستقوم الأداة بتوليد رمز الشريط.
صفحة العنوان
تكون صفحة العنوان عادةً نسخة مكررة من الغلاف الأمامي، ولكن مع حذف بعض العناصر. عادةً ما يتم حذف الأعمال الفنية، وشعارات الشركات أو المنتجات، والشعارات. بعض المنشورات التقنية تحذف صفحة العنوان تمامًا بسبب التكرار الذي يبدو غير ضروري. (وفي طبعة مكونة من 20,000 نسخة، تعني صفحة واحدة الكثير!)
مثال على صفحة الغلاف.
إشعار الطبعة
يعتبر إشعار الطبعة عادةً أول حالة من النص العادي في منشور تقني، على الرغم من أنه غالبًا ما يكون بخط أصغر. ويظهر على الجهة الخلفية من صفحة العنوان. إذا كان الناشر الفني يتبع نهج التوفير والحفاظ على البيئة ويقوم بإزالة صفحة العنوان، فسيظهر إشعار الطبعة على الجهة الخلفية من الغلاف الأمامي.
لا أحد يحب قراءة النصوص الدقيقة، لكن ألقِ نظرة على البيانات المضمنة عادةً في إشعار الإصدار:
مثال على إشعار إضافة
علامات تجارية
سواء كنت تسرد العلامات التجارية وكيف تستمع إليها هو مجال محامي الشركة. في كل الأحوال، تسرد فقط أسماء المنتجات المحمية بعلامة تجارية التي تظهر في دليل المستخدم المحدد.
عادةً ما يتم الإشارة إلى العلامات التجارية:
- في إشعار الإصدار (كما توضح الصورة أعلاه)
- في قسم منفصل في مكان ما في دليل المستخدم
اذكر تلك الملاحظة
إذا أراد المحامون الشركات أن يتم الإشارة إلى كل ظهور لاسم منتج يحمل علامة تجارية بعلامة نجمية أو حاشية، حاول إقناعهم بالتخلي عن هذه الفوضى في تصميم الصفحة. إن إغراق النص بعلامات نجمية أو أرقام حاشية يصرف انتباه القراء.
الضمانات
ترافق الضمانات المنتجات المادية—وليس البرمجيات. يتحمل المحامون القانونيون المسؤولية عن لغة وشكل الضمان. إذا كنت تقوم بإنشاء دليل مستخدم أو كتاب لمعرض أعمالك، يمكنك استخدام هذا "المثال على الضمان" المجهولمنبثق لتظهر أنك على دراية بأنه يجب تضمين الضمانات.
ضمانات البرمجيات؟إشعارات السلامة
تحتوي المنتجات الجديدة عادةً على قسم من الإعلانات المتعلقة بالسلامة في مقدمة كتبها. قد تظهر هذه الإعلانات كفرع من المقدمة، على سبيل المثال، أو كقسم منفصل بذاته. تجمع هذه الأقسام عادةً جميع إشعارات الخطر والتحذير والحذر التي تظهر في جميع أنحاء الكتاب وترتبها بطريقة منطقية. لكن حتى مع هذه التنبيهات المسبقة، لا تزال كتب الأجهزة تضع الإعلانات الفردية في النقاط التي تنطبق عليها. (للمزيد من المعلومات، انظر) إشعارات خاصة.)
بيانات الاتصال
تتطلب كتب الأجهزة أيضاً بيانات اتصالات كما هو منصوص عليه من قبل حكومات الدول التي يتم شحن هذه المنتجات إليها. في الولايات المتحدة، تتطلب لجنة الاتصالات الفيدرالية بيانات اتصالات معينة اعتماداً على "فئة" منتج الأجهزة. ككاتب، يجب عليك أن تكون حذرًا في استخدام بيان الاتصالات الصحيح للمنتج الذي تقوم بتوثيقه— وألا تعدل البيان بأي شكل من الأشكال (كلمات قانونية مقدسة!).
فهرس المحتويات
جدول المحتويات (TOC) يحتوي عادة على مستوى ثانٍ على الأقل من التفاصيل (العناوين 1 في النص الفعلي) حتى يتمكن القراء من العثور على ما يحتاجون إليه بشكل أكثر دقة. يتجادل الكتاب والمحررون ومصممو الكتب عادة حول تسلسل جدول المحتويات. من حيث سهولة الاستخدام، من الأفضل بكثير أن يكون جدول المحتويات قريباً من مقدمة الكتاب، إن لم يكن في بداية الكتاب تماماً. ومع ذلك، من حيث الجوانب القانونية، يشعر الناس بالقلق من أن جميع بيانات الاتصال، والضمانات، وحقوق الطبع والنشر، والعلامات التجارية، وإشعارات السلامة يجب أن تأتي أولاً. في الأماكن التي تفوز فيها سهولة الاستخدام، تستخدم الكتب كل حيلة ممكنة لإخراج هذه المواد القانونية من المحتوى الأمامي: يتم وضع الضمانات على بطاقات منفصلة وتغليفها مع الكتاب أو المنتج؛ وقد يتم إدراج الضمانات وبيانات الاتصال والعلامات التجارية وما إلى ذلك في الملاحق.
هل تواجه مشكلة في إنشاء فهرس منسق بشكل جيد؟ انظر إلى إنشاء جدول محتويات يبدو احترافيًا
قائمة الأشكال
عادةً لا تحتوي الأدلة الفنية للمستخدمين العاديين على قوائم للرسوم. في الواقع، الرسوم نفسها عادةً لا تحتوي على عناوين كاملة. لكن هذا لا يعني أن قائمة الرسوم ليست لها أهمية في الأدلة الفنية. كل هذا يعتمد على القارئ واحتياجاته ومحتوى الكتاب كذلك. إذا كان الكتاب يحتوي على جداول أو رسومات توضيحية أو مخططات أو رسوم بيانية أو غيرها مما يرغب القراء في العثور عليه مباشرة، فإن قائمة الرسوم تكون مطلوبة.
مقدمة
وظيفة المقدمة هي تحضير القراء لقراءة الكتاب. تقوم بذلك من خلال:
- توصيف محتوى الكتاب وغرضه
- تحديد أو حتى وصف موجز للمنتج الذي يدعمه الكتاب
- توضيح نوع القارئ الذي يُعَد الكتاب له
- تحديد المحتويات الرئيسية للكتاب
- عرض أي تقاليد أو مصطلحات خاصة مستخدمة في الكتاب
- تقديم الدعم وأرقام التسويق، وأمور أخرى من هذا القبيل
في نشر الكتب التقليدي، يأتي المقدمة قبل جدول المحتويات؛ ولكن كما تم مناقشته سابقًا في فهرس المحتويات في قسم النشر الفني، يرغب الناس في وضع جدول المحتويات في وقت مبكر من الكتاب لأسباب تتعلق بإمكانية الاستخدام.
فصول الجسم
أوه نعم، وهناك نص فعلي في هذه الكتب—ليس كل شيء مادة تمهيدية! القليل مما يمكن قوله هنا هو أن معظم الكتب التقنية تحتوي على فصول أو أقسام، وفي بعض الحالات، أجزاء. انظر الفصل عن تصميم الصفحة لتنسيق، والأسلوب، وقضايا التصميم لعناصر مثل الترويسات، والتذييلات، والعناوين، والقوائم، والإشعارات، والجداول، والرسومات، والمراجع المتقاطعة، وتسليط الضوء.
الملاحق
كما تعلم، الملحقات مخصصة للمواد التي لا تبدو مناسبة في الجزء الرئيسي من الكتاب ولكن لا يمكن استبعادها أيضًا. غالبًا ما تكون الملحقات هي المكان المناسب للجداول الكبيرة غير المريحة. تحتوي بعض المنشورات الفنية على أشياء مثل الضمانات في الملحقات. من حيث الشكل، فإن الملحق يشبه الفصل—باستثناء أنه يسمى "ملحق أ" أو ما شابه، ويتطابق الرأس والتذييل مع نظام الترقيم والتسمية المختلف (أ-1، أ-2، وما إلى ذلك للصفحات في الملحق أ).
معجم المصطلحات
تتضمن بعض المنشورات التقنية قسمًا من المصطلحات المتخصصة وتعريفاتها. لاحظ أن معظم القوائم تستخدم تنسيق عمودين. عادةً ما يتكون كل مصطلح وتعريفه من فقرة منفصلة، حيث يكون المصطلح مكتوبًا بأحرف صغيرة (ما لم يكن اسمًا علميًا) ومكتوبًا بخط عريض، يتبعه نقطة، ثم التعريف بخط عادي. لاحظ أيضًا أن التعريفات عادةً ليست جملًا مكتملة. يجب أن تستخدم التعريفات الجيدة في القوائم تقنية التعريف الرسمية كما هو موصوف في فصل التعريفات من هذا النص عبر الإنترنت. عادةً ما يتم تحديد عدة تعريفات بواسطة أرقام عربية في أقواس. تحتوي فقرات المعجم أيضًا على رأى الإشارات إلى المصطلحات المفضلة و انظر أيضًا الإشارات إلى المصطلحات ذات الصلة.
فهرس
تكون الفهارس عادةً أيضًا من عمودين وتحتوي أيضًا على رؤية الإشارات إلى المصطلحات المفضلة و انظر أيضًا مراجع للمصطلحات ذات الصلة. راجع الفصل عن فهرسة للعمليات والإرشادات لإنشاء فهارس جيدة.
نموذج استجابة القارئ
قبل ظهور الإنترنت ووسائل التواصل الاجتماعي، كانت بعض المنشورات الفنية تحتوي على نموذج ورقي لتمكين القراء من إرسال تعليقاتهم وأسئلتهم وتقييمهم للكتاب. بالطبع، تبين أن هذه النماذج غالبًا ما تثير شكاوى حول الأعطال في المنتج الذي يوثقه الكتاب. مع زيادة انتشار الإنترنت، أصبحت هذه النماذج متاحة عبر الإنترنت، وأصبح الكتب تشير فقط إلى موقعها على الإنترنت.
تصميم الكتاب وتخطيطه
عادةً ما تكون الأدلة الإرشادية والكتيبات التي تنتجها الشركات المصنعة للأجهزة والبرامج مصممة بطريقة صارمة وزاوية إلى حد ما. تقوم الشركات التكنولوجية المتقدمة بتطوير إصدارات جديدة من منتجاتها أحيانًا كل تسعة أشهر. في هذا السياق، فإن التصميم المتطور ليس عمليًا. إليك بعض ميزات التخطيط والتصميم النموذجية التي سترى:
- عادةً ما يتم تحديد حجم الصفحة من خلال اعتبارات التعبئة والتغليف بالإضافة إلى أحجام الصفحات القياسية المتاحة مع شركات الطباعة. عندما لا يكون حجم الصفحة قيودًا، ستستخدم بعض الشركات حجم الصفحة 8.5 × 11 بوصة — مما يجعل الإنتاج أسهل بكثير بالنسبة للكتّاب.
- عادةً ما تُصمم الصفحات بحيث تت alternates بين الصفحات اليمنى واليسرى. يبدأ تذييل الصفحة اليسرى (الزوجية) برقم الصفحة وينتهي بعنوان الكتاب. يبدأ تذييل الصفحة اليمنى (الفردية) بعنوان الفصل وينتهي برقم الصفحة.
- الممارسة مختلطة حول ما إذا كان ترقيم الصفحات متسلسلًا طوال الكتاب أو حسب الفصل.
- ما لم تكن الصفحات صغيرة جدًا، فإن تصميم العناوين المعلقة بالنسبة للصفحات شائع جدًا في الأدلة الفنية. عادةً ما يكون المسافة المعلقة بين نصف بوصة إلى بوصة واحدة ونصف.
- تكون الخطوط غالبًا 12 نقطة من نوع تايمز نيو رومان للنصوص العادية وأريال للعناوين. يتم استخدام التباعد القياسي بين الخطوط والكلمات. انظر الفصل عن تمييز لقضايا طباعة أخرى.
- الهامش قياسي إلى حد كبير، من بوصة إلى بوصتين حول الصفحات. عادةً، يتم استخدام نصف بوصة إضافية في الهوامش الداخلية للسماح بالتجليد.
- عادةً، يكون اللون لا المستخدمة في هذه الأدلة والكتيبات، عادة بسبب اعتبارات التكلفة والكفاءة.
رسالة الإرسال إما أن تكون خطاب غلاف (أو مذكرة) أو بريد إلكتروني. الرسالة الفعلية (أو المذكرة) إما ملحقة خارج دليل المستخدم برقاقة ورقية أو مرتبطة داخل دليل المستخدم. يحتوي البريد الإلكتروني على رابط لدليل المستخدم أو دليل المستخدم مرفق. إنها تواصل من قبلك—كاتب دليل المستخدم— إلى المستلم، الشخص الذي طلب دليل المستخدم وقد يكون حتى يدفع لك مقابل استشارتك الخبيرة. أساسياً، تقول: "حسناً، ها هو دليل المستخدم الذي اتفقنا على أنني سأكمله بحلول هذا التاريخ. باختصار، يحتوي على هذا وذاك، ولكنه لا يغطي ذلك أو هذا. يرجى المراجعة وإخباري إذا كان يلبي احتياجاتك."
فهرس المحتويات
فهرس
أيًا كان تنسيق جدول المحتويات (TOC) الذي تستخدمه، فإن هذه هي المعايير الشائعة:
- رقم الصفحة المبدئية فقط. على الرغم من أن بعض مولدات جدول المحتويات التلقائية تعرض نطاق الصفحات، إلا أن المعيار هو رقم الصفحة الأولى فقط.
- مستويات العناوين التي يجب تضمينها. كما هو موضح في جدول المحتويات أعلاه، عرض المستويين العلويين من العناوين ما لم يكن دليل المستخدم يحتوي على العديد من العناوين الفرعية. يجب أن يوفر جدول المحتويات وسيلة سريعة وسهلة للعثور على المعلومات.
- التباعد وكتابة الحروف الكبيرة. لاحظ كيف أن عناصر النص في جدول المحتويات أعلاه مُدرَجة. العناوين من المستوى الأول تستخدم حروف كبيرة بالكامل؛ العناوين من المستوى الثاني تستخدم الحروف الكبيرة في الحروف الأولى لكل كلمة رئيسية؛ العناوين من المستوى الثالث تستخدم حروف عادية كما في الجمل.
- التباعد العمودي. لاحظ أن الأقسام من المستوى الأول تحتوي على مساحة إضافية أعلاه وأسفله، مما يزيد من قابلية القراءة.
اعتمادًا على متطلبات مؤسستك، لديك خياران من التنسيقات لقوائم المحتويات (TOC):
هذا الفهرس يستخدم نمط الترقيم العشري لأرقام الفصول والأقسام، وهو شائع في أدلة المستخدم. بينما تستخدم الفصول الأخرى في هذا الكتاب نمط الأرقام الرومانية الكبيرة فقط للفصول الرئيسية (انظر ).
مشكلة في إنشاء فهرس محتويات منسق بشكل جيد؟ انظر إنشاء جدول محتويات يبدو احترافيًا
الفواصل الرقمية وأرقام الصفحات. إذا لم يكن تنسيق نقطة القائد مطلوباً وترغب في تجنبه، يمكنك استخدام هذا التنسيق المتعارف عليه:
انظر إلى هذا المثال من المقدمة:
نص بسيط لفهرس مع الفواصل ورقم الصفحة.قائمة الأشكال
غالباً لا تتضمن في دلائل المستخدم...
-->مقدمة
دليل المستخدم: الفصول الرئيسية
ملحقات
فهرس
عناصر دليل المستخدم الأخرى
عناوين
قوائم منقطة ورقمية
الرموز والأرقام والاختصارات
الرسومات وعناوين الأشكال
المراجع المتقاطعة
ترقيم الصفحات
أفكار ذكاء اصطناعي لأدلة المستخدم
قوائم المراجعة، التي غالبًا ما تظل غير مقروءة، يمكن استخدامها كمصدر لتحفيزات الذكاء الاصطناعي مع بعض التعديلات. انسخ ما يلي، والصقه في نظام ذكاء اصطناعي مثل جوجل جمناي، وانظر ما قد تكون قد فاتك.
ملاحظة: يمكن العثور على جميع الإشارات إلى محتوى ودليل المستخدم أو تنسيقه أو أسلوبه أو مكوناته في الـ كتاب دليل الكتابة التقنية على الإنترنت.
عندما تريد استخدام الذكاء الاصطناعي لتقييم مشروع كتابي، قدم نفسك، وأخبر الذكاء الاصطناعي من أنت، وماذا تريد. قدم للذكاء الاصطناعي نقطة مرجعية للقيام بالتقييمات مثل كتاب إلكتروني على الإنترنت. ثم نشر ما تريد من الذكاء الاصطناعي أن يتحقق منه في تقييمه.
عدل المقدمة لتناسب هويتك.
|
أدلة مستخدم الذكاء الاصطناعي مرحبًا، AI. أطلب منك تقييم التعليمات المكتوبة بواسطة طالب في السنة الثانية في الكلية الأمريكية. أدناه ملخص لفصول الكتاب المدرسي حول تعليمات و إشعارات لاستخدامه كأساس لتقييمك. (تم إخفاء المعلومات التعريفية):
|
معلومات ذات صلة
كيفية كتابة مواضيع مساعدة سهلة الاستخدام للمبتدئين. clickhelp.com
كيفية كتابة الوثائق الخاصة بالمستخدم. تيك سكرّايب
أدلة المستخدم. تِك سكرايب
أود أن أقدر أرائكم، ردودكم، ونقدكم بخصوص هذا الفصل: استجابتك—ديفيد مك موري.
