كن منظمًا! كيفية إنشاء دليل نمط قاعدة المعرفة

كتابة قاعدة المعرفة صعبة بما فيه الكفاية بالفعل. لذلك أعتذر عما سأفعله في هذا المنشور. سأخبرك أن الأمر لا يتعلق فقط بالأفكار الموجودة في قاعدة المعرفة الخاصة بك ، بل يتعلق أيضًا بكيفية تقديمها.

انظر ، بعيدًا عن هذه الأفكار ، تحتاج إلى التأكد من أنك دائمًا:

• استخدام النغمة المناسبة
• تنسيق كل شيء باستمرار

والذي ، لأسباب سأوضحها في القسم التالي ، هو في الواقع صعب بشكل مدهش. وهنا يأتي دور دليل أسلوب قاعدة المعرفة.

لماذا قد تكون قاعدة المعرفة الخاصة بك فوضى من أنماط مختلفة

لا تقلق كثيرًا إذا كانت قاعدة معارفك عبارة عن خليط من الأساليب المختلفة. يحدث ذلك للعديد من الشركات ، عادةً لسبب من سببين (أو في بعض الأحيان كلاهما!).

أولاً ، إذا كنت جزءًا من فريق ، فقد يكون لديك أشخاص مختلفون يكتبون مستندات دعم. حتى إذا:

• جيم يكتب المادة أ
• سالي تكتب المادة ب

من المحتمل أن يكون لهذه المقالات أنماط وتنسيقات مختلفة تمامًا ... إلا إذا كان لديك دليل نمط محدد مسبقًا.

الآن ، إذا لم تكن جزءًا من فريق ، فربما تقول ، "أنا ذئب وحيد - أنا أكتب كل شيء بنفسي. لذلك لا أحتاج إلى تدوين أي شيء على الورق - فهذا كل ما عندي! "

وقد يكون هذا هو الحال ... إذا كتبت جميع مقالات قاعدة المعارف الخاصة بك في جلسة واحدة.

لكن كلانا يعرف أن هذه ليست الطريقة التي تعمل بها الأشياء عادة ، أليس كذلك؟ من المحتمل أنك كتبت كومة من مقالات قاعدة المعارف عندما أطلقت منتجك لأول مرة.

ولكن بعد ذلك ، وبعد ثلاثة أشهر ، تقوم بإصدار ميزة جديدة. الآن عليك كتابة مدخل قاعدة المعرفة لتلك الميزة الجديدة و ... الذكريات البشرية ليست جيدة . هناك فرصة جيدة أن ينتهي بك الأمر بفعل شيء مختلف ، حتى لو كنت لا تحاول ذلك.

لذا ، سواء كنت بمفردك أو جزءًا من فريق ، فمن المفيد وضع دليل أسلوب قاعدة المعرفة على الورق.

هل تقوم الشركات بهذا بالفعل؟ هل دليل أسلوب قاعدة المعرفة شيء حقيقي؟

حسنًا ، سأخبرك بكيفية إنشاء دليل أسلوبك في ثانية. لكن أولاً ، أود أن أعرض بعض الأمثلة على الشركات التي تقوم بذلك بالفعل. وهذا يحقق هدفين:

• يظهر لك أنني لا أقوم باختراع الأشياء لإنشاء المزيد من محتوى المدونة
• يمنحك مثالًا واقعيًا يمكنك الحصول عليه من أجل دليل الأسلوب الخاص بك.

لنلق نظرة على Mozilla أولاً. يحتوي Mozilla على مدخل كامل في دليل الأسلوب لقاعدة معارفهم. نظرًا لأن Mozilla مفتوحة المصدر ، فمن الضروري بشكل خاص أن يكون لديهم دليل أسلوب ، بكلماتهم الخاصة ، "جعل قاعدة معارف دعم Firefox متسقة ، مما يؤدي إلى قاعدة معرفية يسهل قراءتها والمساهمة فيها". سهل القراءة؟ هذا يبدو وكأنه هدف جيد لقاعدة المعرفة الخاصة بك ، أليس كذلك؟

يتعمق الدليل ، ويأخذك خلال كل شيء من الأحرف الكبيرة إلى المسافات البيضاء إلى الفواصل التسلسلية.

بعد ذلك ، يعد MailChimp's Voice & Tone قراءة أخرى جديرة بالاهتمام. في حين أنه لا يركز بنسبة 100 ٪ على قواعد المعرفة ، إلا أنه يحتوي على عدد من الإدخالات لكل من قاعدة المعرفة ومحتوى البرنامج التعليمي:

بينما يركز دليل أسلوب Mozilla بشكل أكبر على الأسلوب والتنسيق ، يختار MailChimp التركيز بشكل أكبر على التنسيق الدقيق والصوت والنغمة بدلاً من التنسيق الدقيق.

كيفية إنشاء دليل نمط لقاعدة المعرفة الخاصة بك

لقد رميت بعض الأمثلة عليك ، لكني لم أعطيك بعد عملية لإنشاء دليل أسلوب قاعدة المعرفة الخاص بك. لذلك دعونا نصلح ذلك!

استخدم شخصًا ثابتًا

هل سبق لك أن قرأت مقالًا يتنقل فيه المؤلف بين "أنا" و "نحن"؟ لدي ، ويمكننا أن نخبرك أنه محير للغاية.

لذا ، إذا كنت ستستخدم الشخص الأول - فاختر واحدًا وكن متسقًا بشأنه. حتى لو كنت بمفردك ، فلا يزال بإمكانك اختيار استخدام "نحن". هذا يعود إليك! فقط استخدم نفس الشيء.

بالإضافة إلى ذلك ، لا تحتاج حتى إلى استخدام الشخص الأول. يمكنك اختيار تجنب "أنا" و "نحن" تمامًا.

لا توجد إجابة صحيحة حقًا هنا - إنها تتعلق فقط بالاتساق.

توحيد التنسيق الخاص بك

إذا قرأت دليل قالب مقالة قاعدة المعرفة النهائية ، فأنت تعلم أن قواعد المعرفة الجيدة تستخدم الكثير من التعليمات بخطوات صغيرة. وستتضمن هذه التعليمات ، في مرحلة ما ، لغة مثل:

انقر فوق ملف .

فهل في هذه الحالة:

• انقر فوق ملف
• انقر فوق "ملف"
• انقر فوق ملف

وعندما تكتب قوائمك بالفعل ، فهل هي:

• الخطوة 1: انقر فوق هذا
• الخطوة 2: انقر فوق ذلك

أم هو مثل هذا:

• فوق هذا
• انقر فوق ذلك

مرة أخرى - يمكنك اختيار الشخص الذي تفضله - ولكن أيهما تختار ، استخدمه باستمرار عبر قاعدة المعرفة بأكملها.

هناك خيارات تنسيق أخرى تحتاج إلى القيام بها أيضًا - يمنحك دليل نمط Mozilla فكرة جيدة عن كل شيء يجب تغطيته ، ولكن إليك بعض الأفكار الأولية:

• كتابة العنوان بالأحرف الكبيرة - هل ستستخدم حالة حالة الجملة أم حالة أحرف العنوان؟
• الأعداد - هل هي 10 أم عشرة؟
• الاختصارات - لا تفعل أم لا؟
• الاختصارات - CDN أو شبكة توصيل المحتوى؟

إذا كنت تستخدم أحد سمات WordPress أو المكونات الإضافية لقاعدة المعرفة الخاصة بنا ، فيمكن أن تساعدك الرموز القصيرة المدمجة وخيارات التنسيق في الحفاظ على الاتساق عندما يتعلق الأمر بالتنسيق

احصل على الصوت الصحيح

أخيرًا ، تحتاج إلى تجاوز التنسيق وتوحيد صوتك.

هل أنت صديق عميلك؟ أم أنك سبوك من ستار تريك ، تستغني عن الحكمة الباردة القاسية؟

في حدود المعقول ، إما على ما يرام. طالما أنها متسقة.

بشكل عام ، يجب عليك التأكد من اتباع إرشادات دليل قاعدة المعارف الخاصة بـ MailChimp. أقترحهم ليس فقط لأن MailChimp قد نشر دليلهم بالفعل ، ولكن أيضًا لأنني أعتقد أن MailChimp لديه واحدة من أفضل قواعد المعرفة الموجودة هناك.

نصيحتهم هي:

• اجعل دائمًا أولويتك الأولى للإجابة على الأسئلة وإبلاغ القراء. النكات جيدة في بعض الأحيان ، ولكن ليس إذا كانت تصرف الانتباه عن هذا الهدف الأساسي.
• تجنب التحدث مثل المسوق - فأنت تحاول فقط المساعدة.

أين تخزن دليل الأسلوب الخاص بك؟

لا يجب عليك فقط اتخاذ هذه القرارات. تحتاج أيضًا إلى تدوينها في مكان آمن ، كما تعلم.

أنا شخصياً ، معظم أدلة الأنماط التي أعمل معها هي مستندات Google Docs. بهذه الطريقة ، يمكنك بسهولة مشاركة دليل الأسلوب الخاص بك والوصول إليه من أجهزة كمبيوتر مختلفة.

ولكن إذا كنت تفضل طريقة أخرى ، فابدأ بما تعرفه. الشيء الوحيد المهم حقًا هو هذا:

لديك نسخة من دليل نمط قاعدة المعرفة مخزنة في مكان آمن حيث يمكنك أنت أو غيرك الوصول إليه عندما تحتاج إلى تجديد معلومات حول كيفية تنسيق قاعدة المعارف الخاصة بك.

لذا ، ضعها على الورق وابدأ في إنشاء مقالات قاعدة معرفية أكثر اتساقًا!