عادة ما تكون هناك مشكلة في قاعدة المعرفة المؤسسية للمطورين - إما أن تتحول إلى فراغ ، لأنه لا يوجد دافع لملئها إما مع شخص مسؤول ، أو إلى شرفة مليئة بأشياء من شقة سوفيتية ، يساهم الجميع ، لكنهم يكتبون بشكل عشوائي ، وتصبح المعلومات قديمة بسرعة ، و ليس لديها الوقت للتحديث دائما.
كيفية تجنب ذلك ، أو على الأقل تقليل التكاليف المحتملة؟ كيف تجعل قاعدة شركتك دافئة ومصباح؟ سأحاول الإجابة.
توثيق نمط التعاون
هناك مثل هذا النهج ، التوثيق التعاوني ، ظهر أصلاً في مجال الطب ، عندما يتم اتخاذ قرار التشخيص بشكل جماعي من قبل المريض والعديد من الأطباء.
من الأمثلة البارزة في مجال تكنولوجيا المعلومات Google Docs و Wiki و Github ، أي نظام له اصطلاحات داخلية والقدرة على العمل معًا في مشروع.
والفكرة هي تضمين المطورين والخبراء والنقاد في العمل على التوثيق في أقرب وقت ممكن لتحديد الثغرات معًا.
لماذا هذا ضروري؟
أولاً ، يعد تقليل عامل الحافلة عنق الزجاجة في المعرفة المؤسسية ، حيث يميل عدد أصحاب المعرفة إلى الوحدة. أنت بحاجة إلى نقل هذه المعرفة من رئيس المطور ، من السبورات البيضاء والتذاكر والمحادثات في المطبخ إلى مساحة واحدة بحيث يمكن للجميع العمل معهم والمساهمة.
ثانيًا ، لتبسيط دخول الوافدين الجدد إلى المشاريع ، وهو أمر مهم بشكل خاص للفرق الموزعة والفرق مع عدد معين من مطوري الاستعانة بمصادر خارجية ، وكذلك للشركات التي لديها مجال عمل محدد للغاية ، فإن فرصة العثور على متخصص جاهز هي صفر.
ثالثا ، من أجل تكوين ثقافة مؤسسية سليمة ، الشفافية "لا بالكلمات". يفهم المطور في مثل هذه البيئة بوضوح نقاط النمو المهني ، وما التقنيات الأخرى التي يمكنه تجربتها في الشركة ، وما يجب تعلمه.
ماذا تفعل؟
يمكن كتابة الوثائق داخل قاعدة المعرفة المؤسسية من قبل أي عضو في الفريق ، ويجب تبسيط هذه الفرصة لهم ، ثم سيشعرون أنهم أصحاب النتيجة - المشاركة.
ومع ذلك ، فأنت بالتأكيد بحاجة إلى شخص يتولى مهام مهندس المعلومات - وضع قواعد موحدة ، هيكل ، منطق ، نمط ، وضع المستندات في المساحات بشكل صحيح.
فتح إمكانية تحرير وإنشاء المستندات لأعضاء الفريق ، بعد أن وافقوا مسبقًا على قواعد اللعبة. أتمتة هذه القواعد إلى أقصى حد - لا تعتمد على الفريق ، أنشئ قوالب ، ضع علامة على محتوى تلقائيًا باستخدام العلامات ، قم بتكوين التحميل من المستودع إلى قاعدة المعرفة (أريد أن أقوم بمقال منفصل حول هذا ، بالمناسبة).
من المهم أن يرى المطورون أن المستندات لا تموت في ويكي الشركة.
مبدأ مهم: تعريف عمل مستند داخلي ، هذه هي اللحظة التي أدخلت عليها تعديلات أو تعليقات ، أي في الحقيقة لحظة التعاون. هذه هي قيمتها ، يريدون قضاء الوقت عليها. لا تكمل - فهذا يعني أن عملية التسليم أو تنفيذ البحث غير منظم بشكل جيد أو أن الأداة غير ملائمة.
المشاكل المحتملة لهذا النهج هي تراكم التعديلات والتعليقات ككرة الثلج ، من الصعب تتبعها ، غالبًا ما يتم إنشاء المستندات المكررة.
لمنع حدوث ذلك ، يمكنك ويجب عليك: أ. تعيين الفريق على ناقل ومجموعة من القواعد وتعقيد عملية عدم متابعتها (على سبيل المثال ، قمنا بإخفاء الزر إنشاء في Confluence ونجعل اختيار النموذج إلزاميًا). ب- تحديد الحقوق بحكمة وتكوين عمليات التحرير بشكل ملائم للمسؤولين عن هندسة المعلومات.
ومن ثم سيأتي العالم المثالي
لن يتوقف المطورون عن طرح أسئلة على بعضهم البعض ، بما في ذلك الأسئلة الغبية والمتكررة . لن يتعلموا إيجاد جميع الإجابات في قاعدة المعرفة بمفردهم. لدينا روح الدعابة الداخلية عندما يتعذر على المطورين العثور على شيء ما ، نظرًا لقيود فهرس بحث Confluence ، يسألونني كمهندس معلومات. نسميها البحث القائم على Sveta.
على الرغم من هذه القيود ، فإن البنية الأساسية لقاعدة المعرفة ، والتسمية الموحدة للصفحات ، واستخدام العلامات سوف يحفزها على البحث وخلق المعرفة بحيث ، على سبيل المثال ، لا يجيبون باستمرار على الأسئلة المتكررة.
اختراق آخر للحياة قمنا بتطبيقه هو تضمين سياق عمل دائمًا في المستندات ، حتى لو كان وصفًا لمكتبة أو فئة أو قائمة تحقق لمهمة ، فمن المهم فهم ما يعنيه هذا للعميل.
الآن لممارسة
سيتمحور الجزء التالي حول "كيف" ، ما هي السمات الداخلية للكونفلوانس (نعم ، نستخدم مكدس أتلاسيان) التي يمكن استخدامها لتنفيذ هذه المبادئ.
أنماط
لقد أنشأنا قوالب جاهزة لأنواع مختلفة من المستندات التي نكتبها في أغلب الأحيان - المواصفات الفنية ، والكيفية ، والقائمة المرجعية. يمكن تكوينها في لوحة مساحة المشرف. هناك حاجة إلى النماذج بحيث أنه عند إنشاء مستند لا يرى المطور صفحة فارغة أمامه ، لديه بالفعل تعليمات حول ما يكتب في هذا القسم أو ذاك. إذا كنت تريد أن تقع مستندات من نوع معين في قسم واحد ويتم عرض المعلومات الوصفية عليها (وهذا مناسب ، على سبيل المثال ، لوصف مكونات منتج معقد أو مجموعة من الخدمات الدقيقة وفقًا لمخطط واحد) ، ثم قم بإنشاء مخطط ، وهذا يشبه النموذج بأقصى سرعة.
قمنا فيها بإعداد تخطيط الصفحة والعناوين ، حيث يبقى فقط لاستبدال بضع كلمات ، ورأس بالحالة ، والصور ، والجداول ، وكتل الشفرة ، وحتى المتغيرات.
المتغيرات هي عناصر محتوى تم تكوينها مسبقًا والتي يجب أن يوليها محرر مستندات آخر أهمية ، على سبيل المثال ، أدخل نصًا أو حدد من قائمة.
يمكنك أيضًا إضافة علامات إلى القالب مقدمًا ، إذا كان نوعًا ضيقًا من المستند ، يمكنك ذكر المستخدمين كمراجعين ، على سبيل المثال ، إذا كان هناك سير عمل واضح بالاسم ، ماكرو Jira ، وإرفاق تذكرة من Jira. تُظهر تجربتنا أن ما يصل إلى 80 بالمائة من المهام يمكن تغطيتها بالقوالب.
تخطيط الصفحة
عنصر آخر مهم هو إنشاء صفحة هبوط مفهومة وجميلة في مساحة الفريق. للقيام بذلك ، نستخدم تخطيط الصفحة ولوحة وحدات الماكرو والعمود والقسم.
فيما يلي مثال على أحد مساحات فريق التطوير لدينا.
استخدم أسماء صفحات ودية. كما تعلم ، لا يدعم Confluence أسماء الصفحات المتطابقة داخل نفس المساحة. الحفاظ على أسماء صفحات واضحة ، مثل
اسم سيء بايثون
اسم جيد Python Styleguide لفريق الخدمات الداخلية
التصنيفات
التقاء بعض القيود على خوارزمية البحث المتعلقة بفهرسة المحتوى. وبالنسبة لقاعدة المعرفة المؤسسية ، فإن البحث والترابط على وجه التحديد هما أكثر القضايا إلحاحًا. لدينا مقالة كاملة في قاعدة المعرفة تسمى كيفية التغلب على Confluence Search ، إذا كنت ترغب في ذلك ، فسأشاركها في التعليقات.
للتغلب على هذه القيود ، نستخدم نظام تسمية. في الواقع ، هذه علامات تحدد موضوع المحتوى ، ولماذا تسمح لك بتجميع محتوى موضوع معين في مكان واحد على شكل نوع من موجز RSS (محتوى ماكرو حسب التصنيف). لذلك قمنا بتكوين فهارس الموضوعات.
إذا كان لديك بالفعل مئات الصفحات في قاعدة البيانات ، أنصحك بالبدء بالتمارين التالية:
- شاهد قائمة بجميع التصنيفات على عنوان URL التالي https: // <my-host-name> /labels/listlabels-alphaview.action.
- البحث عن كافة المحتويات التي لم يتم وضع علامة عليها بأي تصنيفات في سلسلة البحث المتقدم: النوع: الصفحة NOT labelText: [a TO z] NOT labelText: [0 TO 9].
ماذا يمكنك أن تفعل وتفعل الآن؟
- امنح المطورين الحق في التعديل ، ولكن بحكمة.
- فكر في بنية مساحة القيادة ، وقم بعمل صفحة هبوط ملائمة.
- تخصيص القوالب.
- استخدم الملصقات.
- اذهب وقم بتحرير مستند شخص آخر أو اكتب تعليقًا ، اجعل هذا المستند يعمل.