تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من Google.
ملخص المشروع
- المؤسسة المفتوحة المصدر:
- كوليبري
- الكاتب التقني:
- StephDix
- اسم المشروع:
- اصطلاحات سير العمل ونمط توثيق منظومة Koibri المتكاملة
- مدة المشروع:
- الجري الطويل (5 أشهر)
وصف المشروع
تجريدي
يوضح هذا المستند بالتفصيل كيفية تنفيذ إرشادات النمط وإدارة سير العمل مع المعلومات الموثقة لـ Learning Equality لمشروع Kolibri Ecosystem.
نظرة عامة
يتألف اقتراحي من أربع مراحل. في المرحلة الأولى، سأكمل "دليل أسلوب توثيق LE Documentation" الذي يشمل إرشادات حول تسهيل الاستخدام واقتراحات حول الكتابة والتنسيق وفقًا لمفاهيم LE وإرشادات الأسلوب في تطوير البرامج. في المرحلة الثانية، سأقوم بإجراء تدقيق للجودة على مستندات ReadTheDocuments وGoogle Docs. تدمج خطة التدقيق استخدام قوائم التحقق لتقييم الالتزام بإرشادات النمط. ستساعد قوائم التحقق هذه في تسجيل النتائج وتطبيق التغييرات على الوثائق. في المرحلة الثالثة، سأعمل على بنية وشكل وأسلوب النماذج المتوفرة في مستندات ReadTheDocuments وGoogle Docs. سأُنشئ نموذجًا ومستودع صور في Google Drive لتحديد كل فئة نموذج لأنواع المستندات الرئيسية لإعادة استخدامها في عمليات التنفيذ القادمة. سأكمل هذه المهمة بإنشاء النماذج لإرسال مشاكل المستندات لتسهيل تحديدها في مراجعات طلب السحب. أخيرًا، سأُنشئ "دليل المساهمين" الذي يجمع الموارد المفيدة لكل مجموعة من المتعاونين لتحسين تجربتهم في الوصول إلى المعلومات.
الغرض والنطاق
تهدف خطة التنفيذ هذه إلى تحسين تجربة المستخدمين النهائيين الذين يستخدمون مستندات Kolibri ومساعدة أعضاء الفريق والمساهمين على إنتاج مستندات أفضل والتعاون النشِط في المجتمع. وينطبق هذا التنفيذ على ReadThe Docs والمجموعات الفرعية لمستندات "مستندات Google" في منظومة Kolibri المتكاملة.
الجمهور
يمثل الجمهور الأساسي من المنفّذين والمشرفين والمستخدمين النهائيين أهم المستهلكين لوثائق Kolibri. تمثّل هذه السمة جمهورًا ثانويًا من أعضاء الفريق والمتعاونين في إنتاج مستندات Kolibri واستخدامها.
الأهداف
من خلال دليل الأسلوب ونظام سير العمل لوثائق المنظومة المتكاملة في Kolibri، يجب على المستخدمين: إنشاء مستندات سهلة الفهم بلغة يمكن الوصول إليها وتصميم متّسق. الحفاظ على ممارسات الجودة عند التوثيق. حافظ على سهولة الوصول إلى المعلومات بين قنوات التوثيق. تعزيز المبادرات التعاونية في منتدى Kolibri المفتوح المصدر
مصادر المعلومات
وكانت مصادر معلوماتي هي Kolibri وKollibri Studio ومستندات Kolibri Development RTD ومجموعات أدوات Kolibri من Google Drive.
ساعدت منصة Radina Matic الرائعة في توفير أنشطة إحماء وأنشطة خاصة بالمشروع. وقد ساعدتني مساهمتك لما تقدمه المؤسسة في تصور "إرشادات" و"إرشادات" بشأن وجود "دليل" للمساهمين في تنظيم أفكاري ومسودة الاستنتاجات التي توصلت إليها.
البرامج
سأطور مسودة دليل النمط في مستندات Google. تعتبر منصة المستندات هذه مثالية للتكرار التحسيني عندما تكون جاهزة للنشر. بالنسبة إلى تدقيق ضمان الجودة، سأستخدم نماذج Google لإجراء المستندات وتقييمها. سيخزن جدول البيانات ردود النموذج للتحكم في المستند. سأعيد هيكلة مستندات RTD باستخدام GitHub. لقد عملت مع Git وGitkraken وGitHub وGitlab. لديّ معرفة عملية باستخدام Markdown وعدد قليل من ReهيكلةText. أخطط للمساهمة في إصلاحات الوثائق لمواصلة تعلم بناء الجملة. سأستخدم Sharex للصور وملفات GIF. تعجبني هذه الأداة لأنها تعرض تنسيقات إخراج مختلفة. سأستخدم إصدار "المخطّطات" (المخطّطات) للرسومات التخطيطية وإصدار الصور. تتكامل برامج الرسوم البيانية بشكل رائع مع مستندات Google وGoogle Drive وLibreOffice. حالة التوثيق في مرحلة الاستكشاف، راجعتُ معظم وثائق Kolibri. وجدت أخطاء نحوية وأخطاء إملائية وتناقضات في التخطيط وأسلوب الخط واستخدام الصور وكذلك مسارات توثيق مربكة من معظم وثائق المشروع. على سبيل المثال، في دليل مستخدم Kolibri، يُعدّ قسم تحديد المشاكل وحلّها موضوعًا فرعيًا وليس موضوعًا. ويصادف أن تكون هذه المعلومات بالغة الأهمية لوصول المستخدمين النهائيين إليها من جدول المحتويات. وكبديل ثانٍ، يمكنه استخدام شريط البحث وشجرة المحتوى لتوسيع المواضيع الأخرى وتحديد مكان المقالات التي تتناول تحديد المشاكل وحلّها.
للوصول إلى قسم "تحديد المشاكل وحلّها"، عليك إما البحث عنه أو توسيع "إدارة Kolibri" لإدراك أنّ تحديد المشاكل وحلّها ضِمن المستندات. الدليل مقابل الإرشادات بالنسبة إلى اقتراح المشروع هذا، قمت بتحليل مستندين: دليل أسلوب توثيق وثائق المستخدم LE Kolibri وإرشادات ترجمة LE للترجمة. في دليل LE Kolibri، قدّمتُ اقتراحات وتعليقات من مخطّط المواضيع المقترَح وخطة المستندات، بالإضافة إلى بعض الأمور الأخرى التي تحتاج إلى تحسين في "الدليل". بالنسبة إلى إرشادات LE Translation، غيّرتُ التنسيق والأسلوب بناءً على الاقتراحات والاصطلاحات الحالية الواردة في "دليل الأسلوب". أكثر ما لفت انتباهي أثناء التحليل هو المفاهيم الخاطئة الموجودة بين الوثائق المصنفة على أنها "دليل" و"إرشادات".
النتائج
لقد تحقّقت من الجودة في "دليل LE Translation" بالإضافة إلى الاقتراحات والتعليقات التي تم تضمينها في نموذج أولي أشرحه بالتفصيل في مَهمّة التدقيق في ضمان الجودة. في ما يلي بعض التعليقات النهائية التي تم الحصول عليها من التقييم: روابط معطّلة لموقع ويب ICU Syntax .js التنسيق المستخدم لإنشاء هذه الإرشادات غير صحيح. المستند هو "دليل" وليس "إرشادات". أسلوب الخط غير متسق. استخدام العناوين والعناوين بطريقة غير صحيحة، واستخدام غير لائق للّغة وإساءة استخدام الاختصارات. استخدام غير ملائم للنصوص البديلة: العبارات أو التعليمات المتكررة
تعد نتائج كلا الوثيقتين جزءًا من المُخرَجات النهائية لهذا الاقتراح.
المهام الخاصة بالمشروع
- اقتراحات بشأن الدليل الأسلوبي لمستندات المستخدمين في LE (التعليقات)
- إرشادات LE Translation باستخدام أساليب وتنسيقات جديدة
- مخطط الموضوع
- الجدول الزمني للمشروع
- مهام التوثيق