يهدف هذا الدليل إلى مساعدة المؤسسات في فهم أنواع المشكلات التي يمكن حلها من خلال التوثيق الأفضل، وكيفية اختيار المقاييس المناسبة لمشروعات التوثيق.
المرحلة الحالية:
انتهى برنامج Season of Docs لعام 2021 في 14 كانون الأول (ديسمبر) 2021. اطّلِع على
المخطط الزمني.
اذكر مشكلتك.
قبل البدء في اختيار مقياس، تأكد من أن لديك فهمًا جيدًا للمشكلة التي تحاول حلها. يرجى توفير أكبر قدر ممكن من التفاصيل.
- "يستغرق دمج طلبات السحب الخاصة بمستندات الإعداد وقتًا طويلاً. يستسلم المساهمون ويغادرون الصفحة".
- "لاحظنا أنّ هناك عددًا كبيرًا جدًا من المشاكل التي تم فتحها للمساعدة في فهم رموز الأخطاء".
- "هناك حركة في مسار CI/CD غير مستقرة. يتعذّر على عدد كبير جدًا من الاختبارات لأسباب غير مفهومة".
- "يبدو الأشخاص غاضبين في اجتماعاتنا الأسبوعية".
وضع فرضية
ابحث عن السبب والنتيجة. ما الذي يمكن أن يتسبب في المشكلة التي حددتها؟ ضع في اعتبارك أن المشكلات يمكن أن يكون لها أسباب متعددة أو متداخلة.
- "يستغرق دمج طلبات السحب لمستندات الإعداد وقتًا طويلاً لأنّنا لا تتوفّر لدينا إرشادات واضحة حول الأسلوب. أمّا المراجعون، فإما يتراجعون عن مراجعة "PR" لأنّهم لا يعرفون ما يجب فعله، أو أنّهم ينتقلون مع المساهمين بشأن التنسيق."
- "على المستخدمين فتح المشاكل لأنّه لا يمكنهم العثور على معلومات حول رموز الخطأ في المستندات".
- "لا تنجح اختبارات CI/CD التي نستخدمها لأنّنا قد فرضنا قيودًا على الخطة وانتهت المهلات المرتبطة بها من قِبل مقدّم الخدمة لدينا".
- "يشعر الأشخاص بالغضب في اجتماعاتنا الأسبوعية لأنّ الاجتماعات تكون الساعة 5:30 صباحًا بتوقيت منطقتهم الزمنية".
اقتراح حل
هل هذه مشكلة يمكن حلّها باستخدام مستندات جديدة أو أفضل؟
- "إذا كان لدينا دليل حول الأسلوب، يمكن للمنظّمين الاطّلاع عليه قبل تقديم تقارير العلاقات العامة. سيعرف المراجعون ما الذي يجب التحقق منه. ولن يحتاج المراجعون والمساهمون إلى الجدال حول التنسيق والنبرة والأسلوب".
- "إذا كانت لدينا مستندات حول رموز الخطأ، يمكن للمستخدمين العثور على إجاباتهم فيها بدلاً من فتح المشاكل".
- "لا يبدو أن التوثيق الأفضل سيحل مشكلة CI/CD".
- "يمكننا أن نبدأ كل اجتماع بنكتة خاصة! إنّ إنشاء مجموعة من النكات المضحكة سيساعدنا في بدء اجتماعاتنا بابتسامة".
الحصول على نتائج محددة
هل يمكنك تحديد المشكلة؟
- "ما معنى "يستغرق دمج تقارير العلاقات العامة وقتًا طويلاً جدًا"؟ أو خلال شهرين؟ أسبوعين؟ كم من الوقت سينتظر المساهمون المراجعة قبل التوقف عن التعليق؟"
- "كم عدد المشاكل المتعلقة برمز الخطأ التي تشكّل "عددًا كبيرًا جدًا من المشاكل"؟"
- "اممم ... ما مدى استياءك الشديد؟"
التحقّق من قابلية القياس
كيف يمكنك التحقق من المقياس المقترح؟ هل يمكن قياسه بسهولة ودقة؟ هل يعتمد القياس على الشخص الذي يُجري القياس؟
- "يمكننا بسهولة قياس طول المدة التي انفتح فيها طلب السحب والمدة التي تم فيها طلب المراجعة. لا يمكننا بدقة قياس وقت تراجع المساهم".
- "يمكننا حساب عدد المشاكل التي تم وضع علامة "رمز خطأ" عليها أو البحث ضمن مشاكل نص رمز الخطأ".
- "لا يمكننا حقًا قياس غضب الأشخاص بطريقة لبقة أو دقيقة".
إضافة مقياس ثانوي
هل هناك مقاييس أخرى من شأنها أن تساعدك على فهم ما إذا كانت وثائقك تحل مشكلتك؟ هل المقياس المستهدف هو نفسه في كل الحالات؟
- "تستغرق المراجعات ذات الطابع الزمني الأطول وقتًا أطول في المراجعة، لذا يجب أن تكون لدينا حدود مختلفة للأحجام المختلفة للعلاقات العامة. نحن نريد قياس الوقت اللازم لدمج العلاقات العامة الصغيرة والمتوسطة والكبيرة والضخمة".
- "يمكننا التحقق من عدد الزيارات التي تتلقاها وثائق رمز الخطأ ومعرفة ما إذا كان هذا الرقم مرتبطًا بعدد أقل من المشكلات المفتوحة".
اختيار فترة زمنية
- "نحن نعتقد أنّ أسبوعَين هو الوقت المناسب لدمج العلاقات العامة الصغيرة إلى المتوسطة، ويجب دمج جميع العلاقات العامة في غضون شهر. لذلك سنقوم بقياس كل أسبوعين".
- "ليس من المنطقي تعديل عدد المشاكل المرتبطة برمز الخطأ يوميًا، لأنّ الوقت المعتاد لإغلاق المشكلة هو أسبوع واحد. سنقيّمه أسبوعيًا".
تحديد الأهداف
ما مقدار التغيير الذي تحتاج إلى رؤيته في المقياس المحدد لتقول إن المشروع كان ناجحًا؟ ننصحك بتحديد أهداف كمية للمقاييس التي اخترتها.
- "إذا حققنا هدفنا المتمثل في إغلاق كل العلاقات العامة الجديدة في أقل من شهر، فسيكون ذلك ناجحًا. إذا انخفض متوسط الوقت الذي نستغرقه لإغلاق تقارير العلاقات العامة الكبيرة بمقدار أسبوعين، فإن ذلك سيحقق نجاحًا كبيرًا".
- "لم نلاحظ عادةً أي مشاكل جديدة متعلّقة بالأخطاء. لكننا سنعتبر مشروعنا ناجحًا إذا لاحظنا انخفاضًا بنسبة 50٪ في المشكلات المتعلقة بالأخطاء التي تم فتحها".
معلومات ذات صلة
- اقرأ دليل مشرف المؤسسة للحصول على مساعدة بشأن المهام المتعلقة بالتقارير.