تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من Google.
ملخص المشروع
- المؤسسة المفتوحة المصدر:
- GenPipes
- الكاتب التقني:
- شالو
- اسم المشروع:
- إعداد مستندات GenPipes في قسم "قراءة المستندات"
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
أنا أقترح خطة من 3 خطوات لتحقيق الهدف المتمثل في إعداد مستندات GenPipes حول "قراءة المستندات".
الخطوة 1: جهة التواصل (POC)
مراجعة المستندات الحالية الخاصة بأداة GenPipes كمستخدم أو باحث جديد
- تحديد المعلومات الناقصة وغير الدقيقة
- اقتراح مواضيع جديدة في المستندات (إذا لزم الأمر)
- صياغة خريطة بنية المعلومات لمخاطبة الجمهور المستهدف، مع التركيز على المستخدمين الجدد.
(ملاحظة: خلال هذه الخطوة، قد نحتاج أيضًا إلى ملاحظات من موجِّهي GenPipes بشأن إعداد مستودع GitHub جديد يمكن فيه استضافة مستندات genpics لـ RTD. يمكن استخدام مستودع GitHub هذا لاستيراد جميع المستندات في مسارات إنشاء الرسائل النصية القصيرة (RTD). وقد يتطلّب ذلك الاطّلاع على إحصاءات حول قواعد مخزن GenPipes وإرشادات إدارة مصادر المستندات في حال الحاجة إلى الالتزام بها. ويمكن استخدام الأدوات العادية، وهي afaik. بالنسبة إلى جهة التواصل أيضًا، يمكنني تقديم عرض توضيحي لإعداد مستودع "المراسلة النصية في الوقت الفعلي" باستخدام حسابي على GitHub، على سبيل المثال، https://gpdocs.readthedocs.io/en/latest/، هذا نموذج أنشأتُه لهذا العرض.)
بناءً على المراجعة والتحليل في الخطوة السابقة، قم بإنشاء هيكل عظمي لبنية أو فهرس وثائق GenPipes المقترح ووضعه على موقع RTD
- يتضمن ذلك إنشاء مستودع GitHub (باستخدام أدوات Sphinx مثلاً) وملفات الوثائق الأساسية
- ويشمل ذلك أيضًا إنشاء جدول زمني جديد يراعي المستخدمين الجدد والاستخدامات المتمرسة لأقسام / تدفقات معلومات مختلفة.
مراجعة الجدول الزمني للهيكل العظمي للهيكل العظمي والحصول على موافقة عليه
أثناء مرحلة تقييم GenPipes GSoD، حاولت إنشاء قيمة لـ GenPipes من خلال هذا النموذج الذي تمت استضافته في RTD. يُرجى العِلم أنّ هذا الإجراء مخصّص لأغراض تجريبية فقط، وهو رابط محمي، ولم يتم إدراجه بشكل علني في الوقت الفعلي بعد. بصرف النظر عمّا إذا تم إدراجي في القائمة المختصرة، يمكن استخدام هذا العرض التوضيحي لتعزيز جهود GenPipes RTD. لقد تحقّقتُ من المصادر في مستودع c3g/GenPipes GitHub. أبدى المرشدون، رولا وهيكتور، إعجابًا بهذا أثناء مناقشة "مشاركة الشاشة" عبر سكايب في وقت سابق، ولذلك اعتقدت أن آلهة فريق GSoD قد ترغب في رؤيتها أيضًا. هيكلها العظمي فقط في الوقت الحالي، لكنني أخطط لتحديثها عندما يسمح الوقت حتى 30 يوليو.
https://genpipes.readthedocs.io/en/latest/
الخطوة 2: إنشاء مجموعة مستندات GenPipes Doc الإصدار 0.9
تحديد مستندات GenPipes الحالية أو الحالية التي يمكن استيرادها أو ربطها أو تحويلها إلى مستندات Sphinx/rst المستندة إلى Sphinx أو rst، لاستضافتها على RTD، مع مراعاة المخططات الزمنية لـ GSoD
حوِّل المستندات المحدَّدة إلى تنسيق rst، وإذا لزم الأمر، أنشئ مستندات جديدة إن أمكن، وأعِد استخدام أي تنسيق ممكن أو ذي صلة.
- عليك استيراد هذا المستند الأولي الذي تم ضبطه إلى ReadTheDocuments كدليل على المفاهيم، ويمكنك استضافته هناك كمستودع محمي. ضَع ملاحظة في البداية تشير إلى أنّ المستخدمين الجدد سينتقلون إلى مستندات GenPipes الأصلية إلى أن تتم المراجعة أو التبديل الرسمي.
مراجعة/دورة تدريبية صحيحة/تعديل
الخطوة 3: تحسين المسودة الأولى ومراجعتها ونشرها في الوقت الفعلي
املأ تفاصيل بنية مستند GenPipes الجديدة المقترَحة في جدول المحتويات الخاص بجيل GenPipes - أضِف مستندات إضافية إلى جانب المستندات القليلة الأولى (GenPipes Readme)، والمفاهيم، والدروس التعليمية، وما إلى ذلك.
يجب وضع حدود واضحة في جدول المحتويات للتعامل مع المستخدمين الجدد ومستخدمي GenPipes المتمرسين ومطوّري GenPipes وما إلى ذلك.
يمكنك اقتراح ومناقشة عملية عمل باستخدام نظام التشغيل الآلي الجزئي عبر RTD (إصدارات أبو الهول) حول كيفية صيانة مجموعة مستندات GenPipes وتعديلها من قِبل المستخدمين وما إذا كانت C3G ستتيح للمساهمين الخارجيين في المستندات. قد يتطلب هذا إنشاء بعض الإرشادات لتعديلات المستند المشابهة لإرشادات الترميز. قد يتطلب المزيد من الخطوات الفرعية. على سبيل المثال، يمكنك أتمتة التدقيق الإملائي قبل موافقة العلاقات العامة في مستندات GenPipes.
التقرير
وأخيرًا، قم بإنشاء تقرير عن GSoD بناءً على الخبرات والسجلات والملاحظات من الموجهين.
أفكار أخرى
في المستقبل (بعد 3 أشهر)، يمكنني المساعدة في إبقاء هذه الميزة في GenPipes لفترة أطول، إذا كان ذلك منطبقًا. أو تدريب الآخرين على ذلك إذا لزم الأمر. يمكننا تحديد ذلك بناءً على نتيجة الأشهر الثلاثة الأولى.
بالإضافة إلى ذلك، أقترح عليك إنشاء موجز من 3 صفحات حول GenPipes للمساعدة في عملية الإعداد. في الوقت الحالي، على المستخدم الجديد تخطّي الكثير من العقبات ليتمكّن من بدء استخدام GenPipes لأنّ المستندات جيدة ولكنّها متفرقة ولا تساعد المستخدمين الجدد. لا أعلم ما إذا كان من الممكن تنفيذ ذلك في غضون 3 أشهر، لكنني أود أن أجرّب ذلك.
يمكنك أيضًا الاطّلاع على هذا الاقتراح نفسه وطريقة إنشائه (السجلّ) على الرابط https://drive.google.com/file/d/1oKVp_7ZeYGMxhynfc97qUUcGNh2CNbX0/view?usp=sharing.