مرحبا بالجميع!
اسمي ماشا ، أعمل مهندسًا لضمان الجودة في مجموعة شركات Tinkoff. يتضمن عمل ضمان الجودة الكثير من التواصل مع أشخاص مختلفين من فرق مختلفة ، وكنت أيضًا مديرًا ومحاضرًا للبرامج التعليمية ، لذلك كانت خريطة الاتصال الخاصة بي واسعة قدر الإمكان. وفي مرحلة ما انفجرت: أدركت أنني لم أعد أستطيع ، لا أستطيع ، لا أستطيع ملء أطنان من الجداول والمستندات غير القابلة للقراءة.
من المؤكد أن كل واحد منكم تخيل الآن ما أتحدث عنه ، وانطلق في حالة من التعرق البارد: قوائم الألقاب بدون ترتيب أبجدي ، جداول بها مئات الأعمدة ذات التخطيط غير المتقلب ، والجداول التي تحتوي على آلاف الأسطر التي تحتاج إلى محو إصبعك فيها على عجلة الفأرة للنظر في العنوان ، أطنان من الصفحات من التعليمات غير المرقمة ، مئات الرسائل المرسلة لبعضها البعض مع البيانات التي تحتاج إلى تحليل وتنظيم وحشوها في نفس الجداول غير القابلة للقراءة.
وهكذا ، عندما هدأت قليلاً ، قررت كتابة هذا المقال. سأتحدث عن كيف يمكنك عادة (حتى في بعض الأحيان بشكل ملائم) الاحتفاظ بمجموعة متنوعة من الوثائق غير المتعلقة بالمنتج. آمل أن ينتشر المقال عبر الشبكة وأن ينخفض مستوى الجحيم في الأقسام المجاورة للتطوير قليلاً على الأقل ، وسيصبح الناس (بمن فيهم أنا) أكثر سعادة قليلاً.
أدوات
غالبًا ما يتم الاحتفاظ بوثائق المنتج جنبًا إلى جنب مع الكود ، وهو أمر جيد. وعادة ما يتم تخزين الوثائق غير المتعلقة بالمنتج في أي مكان. كثيرًا ما يحاول الناس إحضار المعلومات من أماكن مختلفة إلى نقطة التقاء ، ونحن لسنا استثناءً. لذا فإن بقية القصة تدور حوله.
بشكل عام ، يعد Confluence محركًا متقدمًا لـ wiki. يسمح لك بالعمل مع البيانات في أنواع مختلفة من العرض: نص مع تنسيق ، وجداول ، ومخططات مختلفة. هذه أداة مثيرة للاهتمام وقوية للغاية ، ولكن إذا كنت لا تعرف كيفية طهيها ، فستحصل على تفريغ آخر للمستندات غير القابلة للقراءة. سأعلمك كيف تطبخ!
وحدات الماكرو
تقريبًا كل سحر Confluence مبني على وحدات الماكرو. هناك الكثير من وحدات الماكرو ، ويمكن دمجها مع بعضها البعض. يتم دفعها ومجانيًا ، علاوة على ذلك ، ستكون هناك أمثلة متنوعة لوحدات الماكرو مع روابط لوثائق لها.
واجهة العمل مع وحدات الماكرو بسيطة بقدر الإمكان. لإضافة ماكرو ، تحتاج إلى النقر فوق علامة الجمع وتحديد العنصر المطلوب من القائمة.
إذا كان الماكرو مكتفيًا ذاتيًا ، أي أنه لا يتطلب إدخال شيء آخر داخل نفسه ، فإنه يبدو وكأنه كتلة.
إذا احتاج الماكرو إلى شيء بداخله للعمل ، فسيبدو مثل المربع.
في نفس الوقت ، يمكنك وضع أكبر عدد تريده من الآخرين داخل إطار واحد ، طالما أن هناك منطقًا في هرمك.
يحتوي كل ماكرو على معاينة: فهو يظهر على الفور ما إذا كنت قد قمت بملء الماكرو وتكوينه بشكل صحيح.
قوالب
بالإضافة إلى وحدات الماكرو ، هناك أداة ملائمة لملء المحتوى مسبقًا - هذا قالب.
يمكن استخدام القوالب عند إنشاء أي صفحة: فقط انقر على النقاط الثلاث بجوار الزر "إنشاء" وحدد النموذج المطلوب.
ثم ستتم إضافة كل المحتوى الموجود في النموذج إلى الصفحة التي تم إنشاؤها.
يمكن لأي شخص إنشاء صفحات من القوالب ، ولكن فقط أولئك الذين لديهم حقوق إنشاء القوالب أو تحريرها بأنفسهم يمكنهم إنشاء الصفحات. يمكنك إضافة إرشادات إضافية إلى النموذج حول كيفية صيانة الصفحة.
سحر الطاولة
في الواقع ، بصفتي خبيرًا تقنيًا ، أحب بشدة الجداول ويمكنني تغليف أي معلومات فيها تقريبًا (على الرغم من أن هذا ليس فعالًا دائمًا). الجداول نفسها واضحة ومنظمة وقابلة للتطوير وساحرة!
ولكن حتى هذا الكيان الرائع مثل الطاولة يمكن أن يفسد. ويمكن استخدامه بنجاح وتحسينه. المزيد عن ذلك أدناه.
التصفية (مكون إضافي مدفوع)
يمكن جعل أي طاولة ضخمة غير قابلة للقراءة أصغر قليلاً وقابلة للقراءة باستخدام التصفية. للقيام بذلك ، يمكنك استخدام ماكرو مدفوع .
داخل هذا الماكرو ، تحتاج إلى دفع جدول (حتى أبشع جدول ممكن ، والشيء الرئيسي هو دفعه بالكامل). في الماكرو ، يمكنك تحديد أعمدة لعامل التصفية المنسدل وفلتر النص والتصفية الرقمية والتاريخ.
فقط تخيل أن جميع المعلومات المتعلقة بالمرشحين لجميع الوظائف الشاغرة مسجلة في قائمة جدولية. بطبيعة الحال ، لم يتم فرزهم - فالناس لا يأتون إلى المقابلات بالترتيب الأبجدي. وتحتاج إلى فهم ما إذا كنت قد أجريت مقابلة مع مقدم طلب معين من قبل. تحتاج فقط إلى وضع هذا الجحيم في مرشح ماكرو ، وإضافة مرشح نص بالاسم الأخير - وفويلا ، المعلومات موجودة على شاشتك.
تجدر الإشارة إلى أن تصفية الجداول الضخمة يمكن أن تؤثر على أداء النظام ووقت تحميل الصفحة ، لذا فإن وضع جدول ضخم في الفلتر هو عكاز مؤقت ، فمن الأفضل بناء عملية لا يضطر فيها الأشخاص إلى إنشاء جداول ضخمة غير قابلة للقراءة ( مثال على العملية سيكون في نهاية المقال).
الفرز (مكوّن إضافي مدفوع)
مع ماجيك ماكرو يمكنك أيضًا تعيين الترتيب الافتراضي في أي عمود وترقيم الصفوف. أو انقر فوق أي عمود بالجدول يتم وضعه في ماكرو عامل التصفية ، وسيحدث الفرز حسب هذا العمود.
على سبيل المثال ، لديك نفس الجدول مع المتقدمين وتحتاج إلى معرفة عدد المقابلات التي أجريت في شهر معين - قم بالفرز حسب التاريخ وابتهج.
الجداول المحورية (مكون إضافي مدفوع)
الآن دعنا ننتقل إلى حالة أكثر إثارة للاهتمام. تخيل أن طاولتك ضخمة وتحتاج إلى حساب شيء ما عليها. بالطبع ، يمكنك نسخه إلى Excel ، وحساب ما تحتاجه وتحميل البيانات مرة أخرى إلى Confluence. هل يمكنك تطبيق ماكرو مرة واحدة؟ والحصول على نفس النتيجة ، محدث فقط.
على سبيل المثال: لديك جدول يحتوي على بيانات جميع الموظفين - أين يتواجدون جغرافيًا وما هي المناصب التي يشغلونها. لحساب عدد الأشخاص الموجودين في كل مدينة ، يجب أن تحدد في ماكرو "الجدول المحوري" الصف الذي يتم من خلاله تجميع البيانات (الموقع) ونوع العملية (الإضافة).
بطبيعة الحال ، يمكنك التجميع وفقًا لعدة معايير في وقت واحد ، ويمكنك رؤية كل الاحتمالات .
الرسوم البيانية (مكوّن إضافي مدفوع)
كما قلت ، لا يحب الجميع الطاولات بقدر ما أحب. لسوء الحظ ، فإن معظم المديرين لا يحبونهم على الإطلاق. لكن الجميع يحب المخططات ذات الألوان الزاهية.
من المؤكد أن منشئو Confluence كانوا على علم بهذا (بالتأكيد لديهم أيضًا رؤساء يحبون التقارير والرسوم البيانية ، وأين سيكونون بدونها). لذلك ، يمكنك استخدام الماكرو السحري . في هذا الماكرو ، تحتاج إلى وضع الجدول المحوري من الفقرة السابقة ، وفويلا - يتم تصور بياناتك الرمادية المملة بشكل جميل.
بطبيعة الحال ، يحتوي هذا الماكرو أيضًا على إعدادات. يمكن العثور على ارتباط إلى وثائق أي ماكرو في وضع التحرير لهذا الماكرو.
سهولة التجميع
ربما لم تكن المعلومات الواردة في الفقرات السابقة مصدر إلهام لك. لكنك الآن تعرف بالتأكيد كيفية استخدام وحدات الماكرو ، ويمكنني الانتقال إلى الجزء الأكثر إثارة للاهتمام من المقالة.
الكلمات
إنه أمر سيء عندما يقوم الأشخاص بتخزين المعلومات في مقال واحد غير منظم أو جدول ضخم. والأسوأ من ذلك هو عندما تكون أجزاء من هذه المعلومات ليست فقط غير قابلة للقراءة ، ولكنها أيضًا مبعثرة عبر مساحات التقاء. لحسن الحظ ، من الممكن جمع معلومات متفرقة في مكان واحد. لهذا تحتاج إلى استخدام (علامات مألوفة للجميع على الشبكات الاجتماعية).
يمكن إضافة أي عدد من العلامات إلى أي صفحة. سيؤدي النقر فوق علامة إلى نقلك إلى صفحة تجميع بها روابط إلى كل المحتوى الذي يحتوي على هذه العلامة ، بالإضافة إلى مجموعة من العلامات ذات الصلة. العلامات ذات الصلة هي تلك التي تظهر بشكل متكرر على نفس الصفحة.
خصائص الصفحة
يمكنك إضافة ماكرو آخر مثير للاهتمام إلى الصفحة لهيكلة المعلومات - . داخلها ، تحتاج إلى إرسال جدول من عمودين ، الأول سيكون المفتاح ، والثاني سيكون قيمة الخاصية. علاوة على ذلك ، يمكن إخفاء الماكرو من الصفحة بحيث لا يتداخل مع قراءة المحتوى ، ولكن سيظل يتم تمييز الصفحة بالمفاتيح اللازمة.
انتبه إلى المعرف - من الملائم تعيينه لتعليق مجموعات مختلفة من الخصائص على صفحات مختلفة (أو حتى مجموعات مختلفة من الخصائص في صفحة واحدة).
تقارير
عن طريق العلامات ، يمكنك جمع التقارير. على سبيل المثال ، الماكرو يجمع كل الصفحات بمجموعة معينة من العلامات.
لكن التقرير الأكثر إثارة للاهتمام هو تقرير ماكرو . يقوم أيضًا بتجميع جميع الصفحات التي تحتوي على مجموعة معينة من العلامات ، ولكنه لا يسردها فقط ، ولكنه يقوم بتجميع جدول (هل تمسك الاتصال ببداية المقالة؟) ، حيث تكون الأعمدة هي مفاتيح خصائص الصفحة.
اتضح جدول ملخص للمعلومات من مصادر مختلفة. من الجيد أن تحتوي على ميزات مريحة: التخطيط التكيفي ، والفرز حسب أي عمود. أيضًا ، يمكن تكوين جدول التقارير هذا داخل الماكرو.
عند التكوين ، يمكنك إزالة بعض الأعمدة من التقرير أو تعيين الحالة الافتراضية أو عدد السجلات المعروضة. يمكنك أيضًا تعيين معرّف خاصية الصفحة لمشاهدة المعلومات التي تحتاجها فقط.
على سبيل المثال ، لديك الكثير من صفحات الموظفين ، تحتوي هذه الصفحات على مجموعة من الخصائص حول الشخص: ما هو مستواه ، وأين هو ، وعندما انضم إلى الفريق ، وما إلى ذلك. تم وضع علامة على هذه الخصائص معرف = Employ_inf. وهناك مجموعة ثانية من الخصائص في نفس الصفحة ، والتي تحتوي على معلومات حول شخص كجزء من فريق: ما هو الدور الذي يؤديه الشخص ، وما هو الفريق الذي يعمل فيه ، وما إلى ذلك. تم وضع علامة على هذه الخصائص المعرف = team_inf. بعد ذلك ، عند تجميع تقرير ، يمكنك عرض معلومات فقط لمعرف واحد أو معرفين في وقت واحد - أيهما أكثر ملاءمة.
يكمن جمال هذا الأسلوب في أنه يمكن للجميع جمع جدول المعلومات الذي يحتاجون إليه ، والذي لن يكرر أي شيء وسيتم تحديثه عند تحديث الصفحة الرئيسية. على سبيل المثال: لا يهتم قائد الفريق عندما يحصل مطوروه على وظيفة ، ولكن من المهم تحديد الدور الذي يلعبه كل منهم في الفريق. سيجمع قائد الفريق تقريرًا عن الفريق. ولا يهتم المحاسب بمن يقوم بأي دور ، ولكن الوظائف مهمة - سيجمع تقريرًا عن الوظائف. في هذه الحالة ، لن يتم تكرار مصدر المعلومات أو نقله.
العملية النهائية
تعليمات
لذلك ، يمكننا هيكلة المعلومات بشكل جميل وتجميعها بشكل فعال في Confluence باستخدام وحدات الماكرو كمثال. ولكن من الناحية المثالية ، تحتاج إلى التأكد من تنظيم المعلومات الجديدة على الفور وإدخالها في جميع آليات التجميع المستخدمة بالفعل.
هنا ستأتي مجموعة من وحدات الماكرو والقوالب للإنقاذ. لجعل الأشخاص يقومون بإنشاء صفحات جديدة بالتنسيق الصحيح ، يمكنك استخدام الماكرو إنشاء من قالب. يضيف زرًا إلى الصفحة ، بالنقر فوق أي صفحة جديدة يتم إنشاؤها من القالب الذي تحتاجه. بهذه الطريقة تجعل الناس يعملون على الفور بالتنسيق الذي تحتاجه.
في القالب الذي تسمح بإنشاء صفحة منه ، تحتاج إلى إضافة تسميات وماكرو "خصائص الصفحة" وجدول الخصائص التي تحتاجها مسبقًا. أوصي أيضًا بإضافة إرشادات حول القيم التي تملأ الصفحة بها وقيم الخاصية.
ثم ستبدو العملية النهائية كما يلي:
- أنت تقوم بإنشاء قالب لنوع معين من المعلومات.
- في هذا القالب ، أضف تسميات وخصائص الصفحة في ماكرو.
- في أي مكان مناسب ، قم بإنشاء صفحة جذر بزر ، بالنقر فوق الصفحة الفرعية التي تم إنشاؤها من القالب.
- ابدأ في الصفحة الرئيسية للمستخدمين الذين من المحتمل أن يولدوا المعلومات الضرورية (وفقًا للقالب المطلوب ، من خلال النقر على الزر).
- اجمع لنفسك تقريرًا عن خصائص الصفحة من خلال العلامات التي حددتها في القالب.
- افرحوا: لديك كل المعلومات التي تحتاجها بتنسيق مناسب.
المزالق
كمهندس جودة ، يمكنني القول بأمان أنه لا يوجد شيء مثالي في العالم. حتى الطاولات الإلهية غير كاملة. وهناك عيوب في العملية المذكورة أعلاه.
- إذا قررت تغيير الأسماء أو تكوين خصائص الصفحة ، فسيتعين عليك تحديث جميع الكائنات التي تم إنشاؤها بالفعل حتى يتم سحب بياناتها بشكل صحيح في تقرير الملخص. هذا أمر محزن ، لكنه من ناحية أخرى ، يجبرك على التفكير بالتفصيل في "بنية" مجموعة المعلومات الخاصة بك ، وهي مهمة مثيرة جدًا للاهتمام.
- سيتعين عليك كتابة قدر مناسب من التعليمات حول كيفية ملء جداول المعلومات واستخدام العلامات. ولكن ، من ناحية أخرى ، يمكنك إلقاء هذه المقالة على الأشخاص المناسبين.
مثال على تخزين الوثائق غير المتعلقة بالمنتج
من خلال العملية الموضحة أعلاه ، يمكنك تنظيم تخزين أي معلومات تقريبًا. يكمن جمال هذا النهج في أنه عالمي: بمجرد أن يعتاد المستخدمون عليه ، يتوقفون عن إحداث فوضى. ميزة إضافية كبيرة (ولكن ليست مجانية) هي القدرة على جمع إحصائيات متنوعة أثناء الطيران ورسم مخططات جميلة عليها.
سأقدم مثالاً على عمليتنا في الحفاظ على المعلومات حول الفريق.
لكل شخص في الفريق ، قررنا إنشاء بطاقة موظف. وفقًا لذلك ، لدينا نموذجًا يقوم بموجبه كل شخص جديد بإنشاء هذه البطاقة لنفسه والاحتفاظ بجميع معلوماته الشخصية فيها.
كما ترى ، لدينا جدول مفصل للخصائص ولدينا تعليمات فورية حول كيفية صيانة هذه الصفحة. يتم وضع بعض العلامات من قبل الموظفين أنفسهم وفقًا للإرشادات ، في النموذج فقط العلامات الرئيسية: علامة البطاقة بطاقة الموظف، علامة الاتجاه اتجاه المشاركة وعلامة الأمر فريق- qa.
نتيجة لذلك ، بعد أن يقوم الجميع بإنشاء بطاقة لأنفسهم ، يتم الحصول على جدول كامل يحتوي على معلومات عن الموظفين. يمكن استخدام هذه المعلومات في نقاط مختلفة. يمكن لمديري الموارد تجميع جداول عامة لأنفسهم ، ويمكن للعملاء المتوقعين للفريق تجميع جداول الأوامر عن طريق إضافة علامة فريق إلى التحديد.
من خلال العلامات ، يمكنك رؤية ملخصات مختلفة ، على سبيل المثال ، بواسطة qa- خطة الترقية سيتم عرض جميع المهام لتطوير ضمان الجودة. في الوقت نفسه ، يحتفظ كل شخص في بطاقة موظفه بقصة مهمة وخطة تطوير خاصة به - يقوم بإنشاء صفحة متداخلة من قالب خطط التطوير.
اختتام
احتفظ بأي وثائق بطريقة لا تخجل منها ، ولا يتعرض المستخدمون لأذى مؤلم!
آمل حقًا أن تكون المقالة مفيدة وأن يأتي الترتيب في جميع وثائق العالم.
المصدر: www.habr.com