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