ماراثون التوثيق: ثلاثة أسباب لتنظيم دوكاثون في مشروعك

مقدمة:

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

لكن ماذا تفعل حين تكون لديك وثائق كثيرة تحتاج إلى صيانة، ولا تملك موارد كافية لإبقائها محدثة؟ الإجابة بسيطة: نظّم ماراثونًا للتوثيق، أو «دوكاثون»!

ما الدوكاثون؟

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

يمكن أن يسد فجوات المحتوى، أو يعيد تنظيم مجموعات كبيرة من الوثائق، أو يصلح الروابط المعطلة، أو يقتصر على تصحيح الأخطاء الطباعية. والغاية تحسين قدر كبير من التوثيق في مدة قصيرة نسبيًا.

ومن أمثلة وثائق المنتج: أدلة التدريب، وأدلة المستخدم، وأدلة التثبيت، وأدلة معالجة الأعطال، وأدلة البدء السريع، وتوثيق الواجهات البرمجية، والدروس التعليمية.

في مؤسستي، نظم فريق التوثيق دوكاثونًا نجح في تجديد دليل تثبيت من 102 صفحة. وأتاح التركيز على نطاق المشروع: إعادة التنظيم للتبسيط، وإزالة التكرار، واتباع رحلة العميل. وترك الحدث أثرًا مستمرًا في الفريق وحسّن نجاح العملاء.

ثلاث نتائج يمكن تحقيقها

أولًا: التخلص من العمل المتراكم

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

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

ثانيًا: تجديد الأدلة الكبيرة

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

نصيحة للدوكاثون: شكّل فريق قيادة للفعالية، وقدم حوافز لمشاركة الفرق والأقسام على مستوى المؤسسة. وبحسب نطاق العمل والوقت المتاح، قد ينجح الفريق في إعادة تنظيم دليل كامل في مدة أقصر مما تتوقع.

ثالثًا: التعاون بين الفرق متعددة الاختصاصات

كثيرًا ما تعمل مجموعات المؤسسة في عزلة، فلا تتعاون فرق الهندسة والمنتج ودعم العملاء والتسويق والتوثيق بالقدر المطلوب.

تخيل فعالية يستخدم فيها كل عضو خبرته لتحسين توثيق المنتج. يتيح الدوكاثون تنوع خبراء الموضوع، والتعاون والتواصل الآنيين. كما يوفر بيئة شاملة يشارك فيها المقيمون في مناطق جغرافية مختلفة حضوريًا أو عن بُعد. وتستفيد الوثائق من اهتمام مركز لخبراء ذوي وجهات نظر وتخصصات متنوعة، مما يقلل الجزر المنعزلة والتحيز غير الواعي والإنهاك.

نصيحة للدوكاثون: أتح للفرق متعددة الوظائف الاجتماع حول هدف مشترك.

ماراثون التوثيق

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

عن الكاتبة

ليدي موديه-ماليفير كاتبة تقنية أولى في Red Hat ، ولها أكثر من اثني عشر عامًا من خبرة الاتصال التقني في القطاعين العام والخاص. وتستمتع في وقت فراغها بالخبز وتعلم التقنيات الجديدة.

المراجع:

https://www.redhat.com/en/topics/api/what-are-application-programming-interfaces?intcmp=7013a000002qLH8AAM

https://developers.redhat.com/cheat-sheets/advanced-linux-commands/?intcmp=7016000000127cYAAQ

https://www.redhat.com/en/services/training/rh024-red-hat-linux-technical-overview?intcmp=7016000000127cYAAQ

https://console.redhat.com?intcmp=7016000000127cYAAQ

https://www.redhat.com/en/resources/build-a-resilient-it-culture-ebook?intcmp=7013a000002qLH8AAM